中间件

中间件在处理程序（Handler）之前/之后工作。我们可以在请求分发之前获取 Request 对象，或在分发之后操作 Response 对象。

中间件的定义

• 处理程序 - 必须返回 Response 对象。每次请求只会调用一个处理程序。
• 中间件 - 不需要返回任何值，通过 await next() 传递给下一个中间件

用户可以使用 app.use 或像处理程序一样使用 app.HTTP_METHOD 来注册中间件。这个特性使得指定路径和方法变得简单。

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

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

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

如果处理程序返回 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() 中编写自己的中间件：

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

// 添加自定义响应头
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 之后修改响应

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

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

在中间件参数中访问上下文

要在中间件参数中访问上下文，直接使用 app.use 提供的上下文参数。请看下面的示例：

import { cors } from 'hono/cors'

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

在中间件中扩展上下文

要在中间件中扩展上下文，使用 c.set。你可以通过向 createMiddleware 函数传递 { Variables: { yourVariable: YourVariableType } } 泛型参数来实现类型安全。

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 服务器中间件、Sentry 中间件、Firebase Auth 中间件等。