简介
在前端开发中，我们常常需要对数据进行校验。joi-data-model 是一个 npm 包，它可以帮助我们快速地定义数据模型，并对数据进行校验。这个包基于 Joi 这个强大的库。
安装
你可以使用 npm，在你的项目中安装 joi-data-model:
npm install joi-data-model
基本使用
下面我们来看一个简单的例子。我们需要定义一个 user 的数据模型，包括姓名和年龄两个属性。我们希望姓名是必填的，年龄是一个正整数。首先，我们需要引入 joi-data-model 和 joi 两个库：
const Joi = require('joi');
const { Model } = require('joi-data-model');然后，我们定义一个 User 模型：
const User = Model({
name: Joi.string().required(),
age: Joi.number().integer().min(0),
})以上代码中，我们使用 Joi 定义了 name 和 age 两个属性，并将其传给了 Model 函数。Model 函数会返回一个具有校验功能的对象。
现在，我们可以使用 User 进行数据校验：
const user = { name: 'jimmy', age: 18 };
const { error } = User.validate(user);
if (error) {
console.log(error.details);
} else {
console.log('数据校验成功');
}以上代码中，我们使用 validate 方法对 user 进行了校验。如果校验失败，我们会打印出错误信息。如果校验成功，我们会打印出成功信息。
进阶使用
校验嵌套对象
我们可以使用 Joi 的对象 schema 来定义一个嵌套对象。例如，我们需要定义一个包含 user 和 address 两个属性的 employee 对象，其中 address 是一个嵌套对象：
-- -------------------- ---- -------
----- -------- - -------
----- -------
----- ------------------------
---- ------------------------------
---
-------- -------
------- -------------
----- -------------
------ -------------
---
--这样，我们就可以定义一个 employee 对象：
const employee = {
user: { name: 'jimmy', age: 18 },
address: { street: '123 Main St', city: 'San Francisco', state: 'CA' },
};并对其进行校验：
const { error } = Employee.validate(employee);
if (error) {
console.log(error.details);
} else {
console.log('数据校验成功');
}校验数组
我们可以使用 Joi 的数组 schema 来定义一个数组。例如，我们需要定义一个包含多个 object 的数组：
-- -------------------- ---- -------
----- ------- - -------
---------- ------------------
-------
----- -------
----- ------------------------
---- ------------------------------
---
-------- -------
------- -------------
----- -------------
------ -------------
---
--
--
--这样，我们就可以定义一个 company 对象：
const company = {
employees: [
{ user: { name: 'jimmy', age: 18 }, address: { street: '123 Main St', city: 'San Francisco', state: 'CA' } },
{ user: { name: 'tommy', age: 20 }, address: { street: '456 Main St', city: 'Mountain View', state: 'CA' } },
],
};并对其进行校验：
const { error } = Company.validate(company);
if (error) {
console.log(error.details);
} else {
console.log('数据校验成功');
}总结
joi-data-model 是一个强大而且易用的数据校验工具。它基于 Joi 这个库，可以帮助我们快速地定义数据模型，并对数据进行校验。在实际开发中，我们可以结合 joi-data-model 和 Joi，快速地构建出复杂的校验规则。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600566b581e8991b448e3035