在前端开发中，API 是不可或缺的。然而，如何保证 API 的数据合法性以及安全性，是每位开发者都面临的问题。本文将介绍如何使用 Hapi.js 实现 API 数据校验，为大家带来一些使用技巧。
Hapi.js 概述
Hapi.js 是一个基于 Node.js 的 Web 框架，它可以用于构建 RESTful API 服务。它提供了非常丰富的插件和工具，支持插件化开发，可以快速构建出高可用性和可扩展性的 API 服务。
使用 Hapi.js 实现 API 数据校验
在构建 API 服务时，我们经常需要对请求数据进行验证，以保证 API 的数据合法性。在 Hapi.js 中，可以使用 joi 插件来实现请求数据校验。
安装 joi 插件
要使用 joi 插件，需要先将其安装到项目中：
npm install joi
在路由中验证请求数据
在 Hapi.js 中，路由是处理请求的核心机制。要验证请求数据，可以在路由中使用 joi 插件，具体步骤如下：
- 导入 joi 插件
const Joi = require("joi");- 在路由中定义参数校验规则
// javascriptcn.com 代码示例
const routes = [
{
method: "POST",
path: "/api/user/register",
options: {
validate: {
payload: Joi.object({
username: Joi.string().required(),
password: Joi.string().min(6).max(20).required(),
email: Joi.string().email().required(),
}),
},
},
handler: async (request, h) => {
// 处理请求
},
},
];在上面的示例中，我们使用了 Joi.object 方法定义了参数校验规则，并将其包含在路由的 options.validate.payload 中，表示要验证的是请求的 payload（即请求正文）部分。
在参数校验规则中，我们定义了三个字段：username、password 和 email，分别用于校验请求中的用户名、密码和邮箱。这里，我们使用了 Joi.string() 方法验证字符串类型，以及一些其他方法定义了字符串的一些规则，例如必填、最小长度、最大长度、邮箱格式等等。
- 处理请求
在定义好参数校验规则后，请求将会自动被 Hapi.js 拦截并进行校验，若请求数据不符合校验规则，Hapi.js 会自动返回 400 Bad Request 响应。在处理请求时，我们可以通过 request.payload 获取请求的参数，并进行后续处理。
handler: async (request, h) => {
const { username, password, email } = request.payload;
// 处理请求
}高级使用
除了基本的数据类型和规则校验，joi 还支持许多高级特性。例如，可以使用 joi.object().keys() 方法同时验证多个字段，使用 joi.array().items() 方法验证数组类型，使用 joi.alternatives() 方法验证多种规则中的一个，或者使用 joi.custom() 方法自定义校验规则等等。
例如，我们可以定义一个如下所示的参数校验规则：
// javascriptcn.com 代码示例
Joi.object({
username: Joi.string().required(),
password: Joi.string().min(6).max(20).required().strict(),
email: Joi.alternatives()
.try(Joi.string().email().required(), Joi.string().allow(null))
.required(),
status: Joi.string().valid("pending", "active", "inactive"),
hobbies: Joi.array().items(Joi.string().min(3).max(30)).optional(),
metaData: Joi.custom((value, helpers) => {
if (value && value.customData) {
return value;
} else {
return helpers.message("Invalid metaData");
}
}),
});这样，就可以通过自定义规则和条件和顺序来更加灵活和可控地校验请求参数。
总结
本文介绍了在 Hapi.js 中使用 joi 插件实现 API 数据校验的相关技巧，包括安装 joi 插件、在路由中验证请求数据、以及高级使用方法。通过学习本文，相信大家可以更加方便地构建出真正可靠和安全的 API 服务。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/653081367d4982a6eb20144f