Node.js

Node.js は、オープンソースのクロスプラットフォーム JavaScript ランタイム環境です。

Hono は当初、Node.js 用に設計されたものではありませんでした。しかし、Node.js Adapter を使用することで、Node.js でも実行できるようになりました。

情報

Node.js バージョン 18.x 以降で動作します。必要な Node.js の具体的なバージョンは以下のとおりです。

• 18.x => 18.14.1+
• 19.x => 19.7.0+
• 20.x => 20.0.0+

基本的に、各メジャーリリースの最新バージョンを使用することができます。

1. セットアップ

Node.js のスターターが利用可能です。「create-hono」コマンドでプロジェクトを開始してください。この例では、nodejs テンプレートを選択してください。

npm

npm create hono@latest my-app

yarn

yarn create hono my-app

pnpm

pnpm create hono my-app

bun

bunx create-hono my-app

deno

deno run -A npm:create-hono my-app

my-app に移動し、依存関係をインストールします。

npm

cd my-app
npm i

yarn

cd my-app
yarn

pnpm

cd my-app
pnpm i

bun

cd my-app
bun i

2. Hello World

src/index.ts を編集します。

import { serve } from '@hono/node-server'
import { Hono } from 'hono'

const app = new Hono()
app.get('/', (c) => c.text('Hello Node.js!'))

serve(app)

3. 実行

開発サーバーをローカルで実行します。その後、Webブラウザで http://localhost:3000 にアクセスしてください。

npm

npm run dev

yarn

yarn dev

pnpm

pnpm dev

ポート番号の変更

port オプションでポート番号を指定できます。

serve({
  fetch: app.fetch,
  port: 8787,
})

Node.js APIへの直接アクセス

c.env.incoming と c.env.outgoing から Node.js API にアクセスできます。

import { Hono } from 'hono'
import { serve, type HttpBindings } from '@hono/node-server'
// or `Http2Bindings` if you use HTTP2

type Bindings = HttpBindings & {
  /* ... */
}

const app = new Hono<{ Bindings: Bindings }>()

app.get('/', (c) => {
  return c.json({
    remoteAddress: c.env.incoming.socket.remoteAddress,
  })
})

serve(app)

静的ファイルの提供

ローカルファイルシステムから静的ファイルを提供するには、serveStatic を使用できます。

import { serveStatic } from '@hono/node-server/serve-static'

app.use('/static/*', serveStatic({ root: './' }))

rewriteRequestPath

http://localhost:3000/static/* を ./statics にマッピングしたい場合は、rewriteRequestPath オプションを使用できます。

app.get(
  '/static/*',
  serveStatic({
    root: './',
    rewriteRequestPath: (path) =>
      path.replace(/^\/static/, '/statics'),
  })
)

http2

Node.js http2 Server で Hono を実行できます。

暗号化されていないhttp2

import { createServer } from 'node:http2'

const server = serve({
  fetch: app.fetch,
  createServer,
})

暗号化されたhttp2

import { createSecureServer } from 'node:http2'
import { readFileSync } from 'node:fs'

const server = serve({
  fetch: app.fetch,
  createServer: createSecureServer,
  serverOptions: {
    key: readFileSync('localhost-privkey.pem'),
    cert: readFileSync('localhost-cert.pem'),
  },
})

Dockerfile

以下は Dockerfile の例です。

FROM node:20-alpine AS base

FROM base AS builder

RUN apk add --no-cache gcompat
WORKDIR /app

COPY package*json tsconfig.json src ./

RUN npm ci && \
    npm run build && \
    npm prune --production

FROM base AS runner
WORKDIR /app

RUN addgroup --system --gid 1001 nodejs
RUN adduser --system --uid 1001 hono

COPY --from=builder --chown=hono:nodejs /app/node_modules /app/node_modules
COPY --from=builder --chown=hono:nodejs /app/dist /app/dist
COPY --from=builder --chown=hono:nodejs /app/package.json /app/package.json

USER hono
EXPOSE 3000

CMD ["node", "/app/dist/index.js"]

次の手順を事前に行う必要があります。

1. tsconfig.json の compilerOptions セクションに "outDir": "./dist" を追加します。
2. tsconfig.json に "exclude": ["node_modules"] を追加します。
3. package.json の script セクションに "build": "tsc" を追加します。
4. npm install typescript --save-dev を実行します。
5. package.json に "type": "module" を追加します。