跳至内容

最佳实践

Hono 非常灵活。您可以按照自己的意愿编写应用程序。但是,有一些最佳实践建议您遵循。

尽可能不要创建“控制器”

尽可能地,您不应该创建“类似 Ruby on Rails 的控制器”。

ts
// 🙁
// A RoR-like Controller
const booksList = (c: Context) => {
  return c.json('list books')
}

app.get('/books', booksList)

问题与类型有关。例如,在控制器中,路径参数无法在不编写复杂泛型的情况下推断出来。

ts
// 🙁
// A RoR-like Controller
const bookPermalink = (c: Context) => {
  const id = c.req.param('id') // Can't infer the path param
  return c.json(`get ${id}`)
}

因此,您不需要创建类似 RoR 的控制器,而应该在路径定义之后直接编写处理程序。

ts
// 😃
app.get('/books/:id', (c) => {
  const id = c.req.param('id') // Can infer the path param
  return c.json(`get ${id}`)
})

factory.createHandlers()hono/factory

如果您仍然想创建类似 RoR 的控制器,请使用 hono/factory 中的 factory.createHandlers()。如果您使用它,类型推断将正常工作。

ts
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)

构建大型应用程序

使用 app.route() 来构建更大的应用程序,而无需创建“类似 Ruby on Rails 的控制器”。

如果您的应用程序有 /authors/books 端点,并且您希望将文件从 index.ts 中分离出来,请创建 authors.tsbooks.ts

ts
// authors.ts
import { Hono } from 'hono'

const app = new Hono()

app.get('/', (c) => c.json('list authors'))
app.post('/', (c) => c.json('create an author', 201))
app.get('/:id', (c) => c.json(`get ${c.req.param('id')}`))

export default app
ts
// books.ts
import { Hono } from 'hono'

const app = new Hono()

app.get('/', (c) => c.json('list books'))
app.post('/', (c) => c.json('create a book', 201))
app.get('/:id', (c) => c.json(`get ${c.req.param('id')}`))

export default app

然后,导入它们并使用 app.route() 将它们挂载到 /authors/books 路径上。

ts
// index.ts
import { Hono } from 'hono'
import authors from './authors'
import books from './books'

const app = new Hono()

app.route('/authors', authors)
app.route('/books', books)

export default app

上面的代码可以正常工作。但是,这样做会导致丢失类型安全。如果您想使用 RPC 功能,更好的解决方案是按照以下描述将方法链接起来。

ts
// authors.ts
import { Hono } from "hono";

const app = new Hono()
  .get("/", (c) => c.json("list authors"))
  .post("/", (c) => c.json("create an author", 201))
  .get("/:id", (c) => c.json(`get ${c.req.param("id")}`));

export default app;

这样,当您使用此路由时,类型可以被正确推断出来。

根据 MIT 许可证发布。