验证

Hono 只提供一个非常薄的验证器。但是，它与第三方验证器结合使用时可以很强大。此外，RPC 功能允许您通过类型与您的客户端共享 API 规范。

手动验证器

首先，介绍一种在不使用第三方验证器的情况下验证传入值的方法。

从 hono/validator 中导入 validator。

import { validator } from 'hono/validator'

要验证表单数据，请将 form 指定为第一个参数，将回调指定为第二个参数。在回调中，验证值并在最后返回验证后的值。validator 可以用作中间件。

app.post(
  '/posts',
  validator('form', (value, c) => {
    const body = value['body']
    if (!body || typeof body !== 'string') {
      return c.text('Invalid!', 400)
    }
    return {
      body: body,
    }
  }),
  //...

在处理程序中，您可以使用 c.req.valid('form') 获取验证后的值。

, (c) => {
  const { body } = c.req.valid('form')
  // ... do something
  return c.json(
    {
      message: 'Created!',
    },
    201
  )
}

除了 form 之外，验证目标还包括 json、query、header、param 和 cookie。

警告

验证 header 时，需要使用小写名称作为键。

如果您想验证 Idempotency-Key 标头，则需要使用 idempotency-key 作为键。

// ❌ this will not work
app.post(
  '/api',
  validator('header', (value, c) => {
    // idempotencyKey is always undefined
    // so this middleware always return 400 as not expected
    const idempotencyKey = value['Idempotency-Key']

    if (idempotencyKey == undefined || idempotencyKey === '') {
      throw HTTPException(400, {
        message: 'Idempotency-Key is required',
      })
    }
    return { idempotencyKey }
  }),
  (c) => {
    const { idempotencyKey } = c.req.valid('header')
    // ...
  }
)

// ✅ this will work
app.post(
  '/api',
  validator('header', (value, c) => {
    // can retrieve the value of the header as expected
    const idempotencyKey = value['idempotency-key']

    if (idempotencyKey == undefined || idempotencyKey === '') {
      throw HTTPException(400, {
        message: 'Idempotency-Key is required',
      })
    }
    return { idempotencyKey }
  }),
  (c) => {
    const { idempotencyKey } = c.req.valid('header')
    // ...
  }
)

多个验证器

您还可以包含多个验证器来验证请求的不同部分

app.post(
  '/posts/:id',
  validator('param', ...),
  validator('query', ...),
  validator('json', ...),
  (c) => {
    //...
  }

使用 Zod

您可以使用 Zod，它是一种第三方验证器。我们建议使用第三方验证器。

从 Npm 注册表安装。

npm

npm i zod

yarn

yarn add zod

pnpm

pnpm add zod

bun

bun add zod

从 zod 中导入 z。

import { z } from 'zod'

编写您的模式。

const schema = z.object({
  body: z.string(),
})

您可以在回调函数中使用模式进行验证，并返回验证后的值。

const route = app.post(
  '/posts',
  validator('form', (value, c) => {
    const parsed = schema.safeParse(value)
    if (!parsed.success) {
      return c.text('Invalid!', 401)
    }
    return parsed.data
  }),
  (c) => {
    const { body } = c.req.valid('form')
    // ... do something
    return c.json(
      {
        message: 'Created!',
      },
      201
    )
  }
)

Zod 验证器中间件

您可以使用 Zod 验证器中间件 来使其更简单。

npm

npm i @hono/zod-validator

yarn

yarn add @hono/zod-validator

pnpm

pnpm add @hono/zod-validator

bun

bun add @hono/zod-validator

并导入 zValidator。

import { zValidator } from '@hono/zod-validator'

并按如下方式编写。

const route = app.post(
  '/posts',
  zValidator(
    'form',
    z.object({
      body: z.string(),
    })
  ),
  (c) => {
    const validated = c.req.valid('form')
    // ... use your validated data
  }
)