Bonnes pratiques

Hono est très flexible. Vous pouvez écrire votre application comme vous le souhaitez. Certaines bonnes pratiques méritent toutefois d’être suivies.

Éviter les « contrôleurs » lorsque c’est possible

Dans la mesure du possible, évitez de créer des « contrôleurs à la Ruby on Rails ».

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

app.get('/books', booksList)

Le problème concerne les types. Par exemple, le paramètre de chemin ne peut pas être inféré dans le contrôleur sans écrire des types génériques complexes.

// 🙁
// 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}`)
}

Vous n’avez donc pas besoin de contrôleurs à la RoR : écrivez les gestionnaires directement après les définitions des chemins.

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

`factory.createHandlers()` dans `hono/factory`

Si vous souhaitez quand même créer un contrôleur à la RoR, utilisez factory.createHandlers() dans hono/factory. L’inférence de types fonctionnera alors correctement.

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)

Construire une application plus grande

Utilisez app.route() pour construire une application plus grande sans créer de « contrôleurs à la Ruby on Rails ».

Si votre application possède des points de terminaison /authors et /books et que vous souhaitez les séparer de index.ts, créez authors.ts et books.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

// 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

Importez-les ensuite et montez-les sur les chemins /authors et /books avec app.route().

// 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

Pour utiliser les fonctionnalités RPC

Le code ci-dessus fonctionne bien pour les usages habituels. Cependant, pour utiliser la fonctionnalité RPC, vous pouvez obtenir le type correct en chaînant les appels comme suit.

// 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
export type AppType = typeof app

Si vous transmettez le type de app à hc, il obtiendra le type correct.

import type { AppType } from './authors'
import { hc } from 'hono/client'

// 😃
const client = hc<AppType>('http://localhost') // Typed correctly

Pour plus de détails, consultez la page RPC.