Node.js

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

Hono は Node.js 向けに設計されたわけではありませんが、 Node.js Adapter を使うと Node.js でも実行できます。

INFO

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" コマンドで開発を開始しましょう。 Select nodejs template for this example.

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. Run

開発サーバーをローカルで起動し、ブラウザで http://localhost:3000 にアクセスします。

npm

npm run dev

yarn

yarn dev

pnpm

pnpm dev

ポートを変える

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

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

生の Node.js API にアクセスする

Node.js API は c.env.incoming と c.env.outgoing で使用できます。

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)

静的ファイルの提供

You can use serveStatic to serve static files from the local file system. For example, suppose the directory structure is as follows:

./
├── favicon.ico
├── index.ts
└── static
    ├── hello.txt
    └── image.png

If access to the path /static/* comes in and returns a file under ./static, you can write the following:

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

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

Use the path option to serve favicon.ico in the directory root:

app.use('/favicon.ico', serveStatic({ path: './favicon.ico' }))

If access comes to the path /hello.txt or /image.png and returns a file named ./static/hello.txt or ./static/image.png, you can use the following:

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

rewriteRequestPath

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

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

http2

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

unencrypted http2

import { createServer } from 'node:http2'

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

encrypted 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. "outDir": "./dist" を tsconfig.json の compilerOptions に追加する。
2. tsconfig.json に "exclude": ["node_modules"] を追加する。
3. package.json の script に "build": "tsc" を追加する。
4. npm install typescript --save-dev を実行する。
5. "type": "module" を package.json に追加する。