中间件

中间件在 Handler 之后/之前工作。我们可以在分发 (dispatching) 前获取 Request，或在分发后操作 Response。

中间件的定义

• Handler - 应该返回 Response 对象。只会调用一个 handler。
• Middleware - 应该不返回任何内容，将会通过 await next() 继续执行下一个中间件。

用户可以使用 app.use 或 app.HTTP_METHOD 以及 handlers 来注册中间件。对于此功能，可以轻松指定路径和方法。

// 匹配任何方法，所有路由
app.use(logger())

// 指定路径
app.use('/posts/*', cors())

// 指定方法和路径
app.post('/posts/*', basicAuth())

如果 handler 返回 Response，它将被用于最终用户，并停止后续处理。

app.post('/posts', (c) => c.text('Created!', 201))

在这种情况下，在分发之前，将按如下顺序处理四个中间件：

logger() -> cors() -> basicAuth() -> *handler*

执行顺序

中间件的执行顺序由其注册顺序决定。 首先执行最先注册的中间件中 next 之前的部分， 最后执行 next 之后的部分。 请看下面的例子。

app.use(async (_, next) => {
  console.log('middleware 1 start')
  await next()
  console.log('middleware 1 end')
})
app.use(async (_, next) => {
  console.log('middleware 2 start')
  await next()
  console.log('middleware 2 end')
})
app.use(async (_, next) => {
  console.log('middleware 3 start')
  await next()
  console.log('middleware 3 end')
})

app.get('/', (c) => {
  console.log('handler')
  return c.text('Hello!')
})

结果如下。

middleware 1 start
  middleware 2 start
    middleware 3 start
      handler
    middleware 3 end
  middleware 2 end
middleware 1 end

内置中间件

Hono 具有内置中间件。

import { Hono } from 'hono'
import { poweredBy } from 'hono/powered-by'
import { logger } from 'hono/logger'
import { basicAuth } from 'hono/basic-auth'

const app = new Hono()

app.use(poweredBy())
app.use(logger())

app.use(
  '/auth/*',
  basicAuth({
    username: 'hono',
    password: 'acoolproject',
  })
)

WARNING

在 Deno 中，可以使用与 Hono 版本不同的中间件版本，但这可能导致错误。 例如，以下代码无法正常工作，因为版本不同。

import { Hono } from 'jsr:@hono/hono@4.4.0'
import { upgradeWebSocket } from 'jsr:@hono/hono@4.4.5/deno'

const app = new Hono()

app.get(
  '/ws',
  upgradeWebSocket(() => ({
    // ...
  }))
)

自定义中间件

您可以直接在 app.use() 中编写您自己的中间件：

// 自定义 logger
app.use(async (c, next) => {
  console.log(`[${c.req.method}] ${c.req.url}`)
  await next()
})

// 添加自定义 header
app.use('/message/*', async (c, next) => {
  await next()
  c.header('x-message', 'This is middleware!')
})

app.get('/message/hello', (c) => c.text('Hello Middleware!'))

然而，直接在 app.use() 中嵌入中间件可能会限制其可重用性。因此，我们可以将我们的 中间件分离到不同的文件中。

为了确保我们不会丢失 context 和 next 的类型定义，在分离中间件时，我们可以使用 Hono 工厂中的 createMiddleware()。

import { createMiddleware } from 'hono/factory'

const logger = createMiddleware(async (c, next) => {
  console.log(`[${c.req.method}] ${c.req.url}`)
  await next()
})

INFO

类型泛型可以与 createMiddleware 一起使用：

createMiddleware<{Bindings: Bindings}>(async (c, next) =>

在 Next 之后修改 Response

此外，中间件可以设计为在必要时修改 response：

const stripRes = createMiddleware(async (c, next) => {
  await next()
  c.res = undefined
  c.res = new Response('New Response')
})

中间件参数内部的 Context 访问

要在中间件参数内部访问 context，请直接使用 app.use 提供的 context 参数。请参阅下面的示例以获得更清晰的说明。

import { cors } from 'hono/cors'

app.use('*', async (c, next) => {
  const middleware = cors({
    origin: c.env.CORS_ORIGIN,
  })
  return middleware(c, next)
})

在中间件中扩展 Context

要在中间件中扩展 context，请使用 c.set。您可以通过将 { Variables: { yourVariable: YourVariableType } } 泛型参数传递给 createMiddleware 函数来使其类型安全。

import { createMiddleware } from 'hono/factory'

const echoMiddleware = createMiddleware<{
  Variables: {
    echo: (str: string) => string
  }
}>(async (c, next) => {
  c.set('echo', (str) => str)
  await next()
})

app.get('/echo', echoMiddleware, (c) => {
  return c.text(c.var.echo('Hello!'))
})

第三方中间件

内置中间件不依赖于外部模块，但第三方中间件可能依赖于第三方库。 因此，借助它们，我们可以构建更复杂的应用程序。

例如，我们有 GraphQL Server Middleware、Sentry Middleware、Firebase Auth Middleware 等。