App - Hono

Hono 是主要的 object（对象）。它会被首先 import（导入），并持续使用到最后。

import { Hono
 } from 'hono'

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

export default app
 // for Cloudflare Workers or Bun

Methods（方法）

Hono 的实例拥有以下 methods（方法）。

app.HTTP_METHOD([path,]handler|middleware...)
app.all([path,]handler|middleware...)
app.on(method|method[], path|path[], handler|middleware...)
app.use([path,]middleware)
app.route(path, [app])
app.basePath(path)
app.notFound(handler)
app.onError(err, handler)
app.mount(path, anotherApp)
app.fire()
app.fetch(request, env, event)
app.request(path, options)

它们的第一部分用于 routing（路由），请参考 routing section（路由章节）。

Not Found（未找到）

app.notFound 允许你自定义 Not Found Response（未找到响应）。

app
.notFound
((c
) => {
  return c
.text
('Custom 404 Message', 404)
})

Error Handling（错误处理）

app.onError 处理 error（错误）并返回一个自定义的 Response（响应）。

app
.onError
((err
, c
) => {
  console
.error
(`${err
}`)
  return c
.text
('Custom Error Message', 500)
})

fire()

app.fire() 会自动添加一个全局的 fetch event listener（事件监听器）。

这对于遵循 Service Worker API 的环境非常有用，例如 non-ES module Cloudflare Workers。

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

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

fetch()

app.fetch 将会是你应用的 entry point（入口点）。

对于 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 是一个用于 testing（测试）的有用 method（方法）。

你可以传递一个 URL 或 pathname 来发送一个 GET request（请求）。 app 将会返回一个 Response object（对象）。

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

你也可以传递一个 Request object（对象）：

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

mount()

mount() 允许你将使用其他 frameworks（框架）构建的应用 mount（挂载）到你的 Hono 应用中。

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

// Create itty-router application（创建 itty-router 应用）
const ittyRouter = IttyRouter()

// Handle `GET /itty-router/hello`（处理 `GET /itty-router/hello`）
ittyRouter.get('/hello', () => new Response('Hello from itty-router'))

// Hono application（Hono 应用）
const app = new Hono()

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

strict mode（严格模式）

Strict mode（严格模式）默认是 true，并区分以下 routes（路由）。

/hello
/hello/

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

通过将 strict mode（严格模式）设置为 false，这两个 paths（路径）将被同等对待。

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

router option（路由选项）

router option（路由选项）指定要使用的 router（路由）。默认的 router（路由）是 SmartRouter。如果你想使用 RegExpRouter，将其传递给一个新的 Hono 实例：

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

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

Generics（泛型）

你可以传递 Generics（泛型）来指定 Cloudflare Workers Bindings（绑定）和 c.set/c.get 中使用的 variables（变量）的 types（类型）。

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 is `string`（token 是 `string` 类型）
  // ...
  c
.set
('user', user
) // user should be `User`（user 应该是 `User` 类型）
  await next
()
})

App - Hono ​

Methods（方法） ​

Not Found（未找到） ​

Error Handling（错误处理） ​

fire() ​

fetch() ​

request() ​

mount() ​

strict mode（严格模式） ​

router option（路由选项） ​

Generics（泛型） ​