应用 - Hono

Hono 是主要的对象。它将首先被导入，并一直使用到最后。

import { Hono
 } from 'hono'

const app
 = new Hono
()
//...

export default app
 // 用于 Cloudflare Workers 或 Bun

方法

Hono 的实例具有以下方法。

app.HTTP_METHOD([路径,]处理程序|中间件...)
app.all([路径,]处理程序|中间件...)
app.on(方法|方法[], 路径|路径[], 处理程序|中间件...)
app.use([路径,]中间件)
app.route(路径, [应用])
app.basePath(路径)
app.notFound(处理程序)
app.onError(错误, 处理程序)
app.mount(路径, 另一个应用)
app.fire()
app.fetch(请求, 环境, 事件)
app.request(路径, 选项)

它们的第一部分用于路由，请参阅路由部分。

未找到

app.notFound 允许您自定义“未找到”响应。

app
.notFound
((c
) => {
  return c
.text
('自定义 404 消息', 404)
})

WARNING

notFound 方法仅从顶级应用调用。有关更多信息，请参阅此问题。

错误处理

app.onError 允许您处理未捕获的错误并返回自定义响应。

app
.onError
((err
, c
) => {
  console
.error
(`${err
}`)
  return c
.text
('自定义错误消息', 500)
})

INFO

如果父应用及其路由都有 onError 处理程序，则路由级处理程序优先。

fire()

WARNING

app.fire() 已被弃用。请改用 hono/service-worker 中的 fire()。有关详细信息，请参阅服务工作线程文档。

app.fire() 会自动添加一个全局 fetch 事件侦听器。

这对于遵守服务工作线程 API 的环境非常有用，例如非 ES 模块 Cloudflare Workers。

app.fire() 会为您执行以下操作：

addEventListener('fetch', (event: FetchEventLike): void => {
  event.respondWith(this.dispatch(...))
})

fetch()

app.fetch 将是您应用程序的入口点。

对于 Cloudflare Workers，您可以使用以下代码：

export default {
  fetch
(request
: Request, env
: Env
, ctx
: ExecutionContext
) {
    return app
.fetch
(request
, env
, ctx
)
  },
}

或者直接：

export default app

Bun:

export default app 
export default {  
  port: 3000, 
  fetch: app.fetch, 
}

request()

request 是一个用于测试的有用方法。

您可以传递一个 URL 或路径名来发送 GET 请求。 app 将返回一个 Response 对象。

test
('GET /hello is ok', async () => {
  const res
 = await app
.request
('/hello')
  expect
(res
.status
).toBe(200)
})

您还可以传递一个 Request 对象：

test
('POST /message is ok', async () => {
  const req
 = new Request
('你好！', {
    method
: 'POST',
  })
  const res
 = await app
.request
(req
)
  expect
(res
.status
).toBe(201)
})

mount()

mount() 允许您将使用其他框架构建的应用程序挂载到您的 Hono 应用程序中。

import { Router as IttyRouter } from 'itty-router'
import { Hono } from 'hono'

// 创建 itty-router 应用程序
const ittyRouter = IttyRouter()

// 处理 `GET /itty-router/hello`
ittyRouter.get('/hello', () => new Response('来自 itty-router 的你好'))

// Hono 应用程序
const app = new Hono()

// 挂载！
app.mount('/itty-router', ittyRouter.handle)

严格模式

严格模式默认为 true，并区分以下路由。

/hello
/hello/

app.get('/hello') 将不匹配 GET /hello/。

通过将严格模式设置为 false，两个路径将被同等对待。

const app
 = new Hono
({ strict
: false })

路由器选项

router 选项指定要使用的路由器。默认路由器是 SmartRouter。如果要使用 RegExpRouter，请将其传递给新的 Hono 实例：

import { RegExpRouter
 } from 'hono/router/reg-exp-router'

const app
 = new Hono
({ router
: new RegExpRouter
() })

泛型

您可以传递泛型来指定 Cloudflare Workers 绑定和 c.set/c.get 中使用的变量的类型。

type Bindings
 = {
  TOKEN
: string
}

type Variables
 = {
  user
: User

}

const app
 = new Hono
<{
  Bindings
: Bindings

  Variables
: Variables

}>()

app
.use
('/auth/*', async (c
, next
) => {
  const token
 = c
.env
.TOKEN
 // token 是 `string`
  // ...
  c
.set
('user', user
) // user 应该是 `User`
  await next
()
})

应用 - Hono ​

方法 ​

未找到 ​

错误处理 ​

fire() ​

fetch() ​

request() ​

mount() ​

严格模式 ​

路由器选项 ​

泛型 ​