Factory Helper

Factory Helper 提供了用于创建 Hono 组件（如中间件）的实用函数。有时设置合适的 TypeScript 类型很困难，但此 helper 可以简化这一过程。

导入

import { Hono } from 'hono'
import { createFactory, createMiddleware } from 'hono/factory'

createFactory()

createFactory() 将创建一个 Factory 类的实例。

import { createFactory } from 'hono/factory'

const factory = createFactory()

你可以将你的 Env 类型作为泛型传入：

type Env = {
  Variables: {
    foo: string
  }
}

const factory = createFactory<Env>()

选项

optional defaultAppOptions: HonoOptions

传递给由 createApp() 创建的 Hono 应用程序的默认选项。

const factory = createFactory({
  defaultAppOptions: { strict: false },
})

const app = factory.createApp() // 应用了 `strict: false`

createMiddleware()

createMiddleware() 是 factory.createMiddleware() 的快捷方式。 此函数将创建你的自定义中间件。

const messageMiddleware = createMiddleware(async (c, next) => {
  await next()
  c.res.headers.set('X-Message', 'Good morning!')
})

提示: 如果你想获取像 message 这样的参数，你可以像下面这样创建一个函数。

const messageMiddleware = (message: string) => {
  return createMiddleware(async (c, next) => {
    await next()
    c.res.headers.set('X-Message', message)
  })
}

app.use(messageMiddleware('Good evening!'))

factory.createHandlers()

createHandlers() 帮助在与 app.get('/') 不同的地方定义处理器。

import { createFactory } from 'hono/factory'
import { logger } from 'hono/logger'

// ...

const factory = createFactory()

const middleware = factory.createMiddleware(async (c, next) => {
  c.set('foo', 'bar')
  await next()
})

const handlers = factory.createHandlers(logger(), middleware, (c) => {
  return c.json(c.var.foo)
})

app.get('/api', ...handlers)

factory.createApp()

createApp() 帮助创建具有正确类型的 Hono 实例。 如果你将此方法与 createFactory() 一起使用，则可以避免在 Env 类型的定义中出现冗余。

如果你的应用程序像这样，你必须在两个地方设置 Env：

import { createMiddleware } from 'hono/factory'

type Env = {
  Variables: {
    myVar: string
  }
}

// 1. 将 `Env` 设置到 `new Hono()`
const app = new Hono<Env>()

// 2. 将 `Env` 设置到 `createMiddleware()`
const mw = createMiddleware<Env>(async (c, next) => {
  await next()
})

app.use(mw)

通过使用 createFactory() 和 createApp()，你只需在一个地方设置 Env。

import { createFactory } from 'hono/factory'

// ...

// 将 `Env` 设置到 `createFactory()`
const factory = createFactory<Env>()

const app = factory.createApp()

// factory 也具有 `createMiddleware()`
const mw = factory.createMiddleware(async (c, next) => {
  await next()
})

createFactory() 可以接收 initApp 选项来初始化由 createApp() 创建的 app。 以下是使用该选项的示例。

// factory-with-db.ts
type Env = {
  Bindings: {
    MY_DB: D1Database
  }
  Variables: {
    db: DrizzleD1Database
  }
}

export default createFactory<Env>({
  initApp: (app) => {
    app.use(async (c, next) => {
      const db = drizzle(c.env.MY_DB)
      c.set('db', db)
      await next()
    })
  },
})

// crud.ts
import factoryWithDB from './factory-with-db'

const app = factoryWithDB.createApp()

app.post('/posts', (c) => {
  c.var.db.insert()
  // ...
})