在编写前端应用或使用 Node.js 构建 Web 应用时，我们通常需要使用数据校验机制以确保数据的正确性和完整性。Joi 就是一种十分流行的 Node.js 数据校验库，在 Fastify 中使用 Joi ，能轻松实现数据校验的功能。本文将介绍如何在 Fastify 中使用 Joi 进行数据校验。
安装和配置
在使用 Joi 前，我们需要在项目中安装相应的依赖。在命令行运行以下命令：
npm install @hapi/joi fastify-joi
在安装 Joi 后，我们需要在 Fastify app 中进行配置，以便使用 Joi 进行数据校验。以下是基本配置示例：
// javascriptcn.com 代码示例
const fastify = require('fastify')({ logger: true })
const fastifyJoi = require('fastify-joi')
fastify.register(fastifyJoi)
fastify.listen(3000, err => {
if (err) {
fastify.log.error(err)
process.exit(1)
}
fastify.log.info(`server listening on ${fastify.server.address().port}`)
})注：以上示例使用了 Fastify 的
require方式加载依赖，若使用 ES6 模块化，应当使用import引入。
基本用法
在配置完毕后，我们就可以使用 Joi 对数据进行校验了。首先，我们需要定义一个 Joi schema ，用来描述数据的校验规则。例如，我们要定义一个校验用户名的 Joi schema ，如下所示：
// javascriptcn.com 代码示例
const Joi = require('@hapi/joi')
const usernameSchema = Joi.object({
name: Joi.string().alphanum().min(3).max(30)
.required()
.messages({
'string.base': 'The username must be a string',
'string.alphanum': 'The username must only contain alphanumeric characters',
'string.min': 'The username must be at least {{#limit}} characters',
'string.max': 'The username cannot be longer than {{#limit}} characters',
'any.required': 'The username is required'
})
})以上代码定义了一个对象，包含一个 name 属性，该属性必须为字符串且仅包含字母数字字符，长度不少于 3 且不超过 30 个字符。同时，我们为校验失败时的错误信息自定义了消息内容。
接下来，我们可以在路由处理函数中使用该 Joi schema 对请求数据进行校验。假设我们有一个 /signup 路由，用户填写了用户名和密码等信息，如下所示：
// javascriptcn.com 代码示例
fastify.post('/signup', async (req, res) => {
const { body } = req
const { username, password } = body
const { error, value } = await usernameSchema.validate({ name: username })
if (error) {
res.status(400).send({ error: error.message })
return
}
// do something with validated data
})我们在处理函数中获取请求体的 body，其中包含了用户填写的数据。然后，我们使用 usernameSchema.validate() 方法对用户名（即 username）进行校验。如果验证通过，value 包含了被校验项目本身的值，其内部结构会和校验规则 usernameSchema 中声明的属性一致。如果校验失败，error 则包含了关于失败原因的详细信息。我们可以根据 error 属性提供适当的错误响应消息和状态码。
到此为止，我们已经可以在 Fastify 应用中使用 Joi 进行数据校验了。但是，该示例仅使用了一个 Joi schema ，而在实际工程中，我们可能会使用多个 schema 。下一节将会介绍如何使用 Joi 分组、结合其它插件等高级用法。
高级用法
使用 Joi 分组
在实际工程中，我们可能需要验证一个对象，对象中包含了多个属性。Joi 提供了一种分组校验的方式，可以分组声明对象的属性，为属性设置不同的校验规则。例如，我们要校验一个包含用户名和密码的对象，可以使用 Joi 分组机制，如下所示：
// javascriptcn.com 代码示例
const Joi = require('@hapi/joi')
const userSchema = Joi.object().keys({
name: Joi.string()
.alphanum()
.min(3)
.max(30)
.required()
.messages({
'string.base': 'The username must be a string',
'string.alphanum': 'The username must only contain alphanumeric characters',
'string.min': 'The username must be at least {{#limit}} characters',
'string.max': 'The username cannot be longer than {{#limit}} characters',
'any.required': 'The username is required'
}),
password: Joi.string()
.pattern(new RegExp('^[a-zA-Z0-9]{3,30}$'))
.required()
.messages({
'string.base': 'The password must be a string',
'string.pattern.base': 'The password must contain only alphanumeric characters and be between 3 and 30 characters long',
'any.required': 'The password is required'
})
})以上代码定义了一个对象，包含了两个属性 name 和 password。其中，name 必须为字符串类型，必填，长度为 3-30 个字符，仅包含字母数字字符。password 仅包含字母数字字符，长度为 3-30 个字符，必填。
我们可以在路由处理函数中使用该 Joi schema 对请求体进行校验。如下所示：
// javascriptcn.com 代码示例
fastify.post('/signup', async (req, res) => {
const { body } = req
const { error, value } = await userSchema.validate(body)
if (error) {
res.status(400).send({ error: error.message })
return
}
// do something with validated data
})在处理函数中，我们将 body 作为参数传入 userSchema.validate() 方法中，直接对整个对象进行校验即可。如果成功，value 包含了完整的被校验的对象，其内部结构会和校验规则 userSchema 中声明的属性一致。如果校验失败，error 则包含了关于失败原因的详细信息。我们可以根据 error 属性提供适当的错误响应消息和状态码。
结合 Joi 其它插件
Joi 的插件机制能为开发者提供更加强大的工具，例如，一个插件能够验证邮箱格式，另一个插件能够验证手机号码格式等。 Fastify 支持许多 Joi 插件，从而能够扩展其校验功能。例如，我们要安装并使用 Fastify 常用的一些 Joi 插件，请输入以下命令：
npm install fastify-sensible fastify-rate-limit fastify-cors
以上命令将安装 Fastify 常用的三个插件。 fastify-sensible 插件为 Fastify 提供了一些较为普遍的组件，例如响应处理函数、错误响应处理函数、HTTP 异常捕捉等等。 fastify-rate-limit 插件支持带有可配置选项的非常灵活的速率限制，适用于防止 DDoS和 Brute force 攻击。 fastify-cors 插件提供了一个中间件，使得您可以设置跨域资源共享 (CORS) 的选项。
// javascriptcn.com 代码示例
const fastify = require('fastify')
const fastifyJoi = require('fastify-joi')
const fastifyRateLimit = require('fastify-rate-limit')
const fastifyCors = require('fastify-cors')
const fastifySensible = require('fastify-sensible')
const fastify = require('fastify')({ logger: true })
const apiRouter = require('./api')
fastify.register(fastifySensible)
fastify.register(fastifyJoi)
fastify.register(fastifyCors)
fastify.register(fastifyRateLimit, {
max: 100,
timeWindow: '1 minute'
})
fastify.register(apiRouter, { prefix: '/api' })
fastify.listen(3000, err => {
if (err) {
fastify.log.error(err)
process.exit(1)
}
})注意：以上代码仅用于演示 Fastify 和 Joi 类库的集成和结合其它常用插件， 在实际项目中应更具需要进行自定义配置传入。
总结
本文介绍了如何在 Fastify 中利用 Joi 进行数据校验。我们首先阐述了基本用法，并讲解了如何利用 Joi 的分组机制管理多个校验规则。此外，我们还示范了如何整合 Fastify 常用的插件，使得校验逻辑更为强大灵活。期望本文的内容对你掌握 Fastify 库的使用以及数据校验技巧有所帮助。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/65471bc97d4982a6eb17b5ca