在前端开发过程中，往往需要对接口返回数据进行校验。而 npm 包 schema-validation 可以用来轻松地在 Node.js 中进行数据校验。本文将详细介绍如何使用 schema-validation 包进行数据校验。
什么是 schema-validation
schema-validation 是一款 npm 包，可以用来校验数据对象。该包使用 JSON schema 语法来进行数据校验。它的特点如下：
- 支持任意 JSON 数据对象
- 必填项、类型、长度、格式、取值范围等多种校验方式
- 可自定义校验规则
- 可设置默认值
- 代码简洁，使用简单
安装
在使用 schema-validation 前，需要先安装该包。在命令行输入以下命令即可安装：
npm install schema-validation
使用方法
1. 导入
首先需要在你的文件中引入 schema-validation 包：
const { schemaValidation } = require('schema-validation');2. 定义校验规则
定义校验规则需要使用 JSON 格式，并通过 schemaValidation 方法进行解析。示例代码如下：
-- -------------------- ---- -------
----- ---------- - -
----- ---------
----------- -
----- -
----- ---------
---------- --
---------- --
--
---- -
----- ---------
-------- --
--
------ -
----- ---------
------- -------
--
------- -
----- ---------
-------- ------------
-
--
--------- -------- --------
-以上代码定义了一个用户信息的校验规则，其中：
type定义了校验数据类型为对象；properties定义了校验规则，包含了名字、年龄、邮箱和头像等四个字段；required定义了必需传入的字段，如果不传入就会直接导致校验不通过。
3. 校验数据
有了验证规则后，就可以校验数据了。使用 schemaValidation 方法，传入待校验的数据和校验规则对象即可。
const user = {
name: '张三',
age: 19,
email: 'zhangsan@example.com',
avatar: 'https://www.example.com/avatar.jpg'
}
const validationResult = schemaValidation(user, userSchema)以上代码定义了一个用户数据对象，并使用上一步定义的用户校验规则进行校验。返回结果如下：
{
isValid: true,
errors: []
}其中包含了两个字段：
isValid表示校验结果是否通过；errors表示错误信息，如果存在错误会将错误信息存储在数组中返回。
如果校验通过，那么 errors 数组的长度为 0。
4. 自定义校验规则
schema-validation 支持自定义校验规则，例如对日期的判断等。
-- -------------------- ---- -------
----- ----------- - -
----- ---------
----------- -
-------- -
----- --------
--
------ -
----- ---------
-------- -
--
----- -
----- ---------
------- ------
-
--
--------- ----------- -------- -------
-
----- --------------------- - -
----- -
---------- ------- -- -
----- ---- - --- -----------
------ ------------------------------------ --- -------- ------ -- -----------------------
--
-------- ---------
-
-
----- ----- - -
-------- ------
------ ----
----- ------------
-
----- ---------------- - ----------------------- ------------ ----------------------以上代码自定义了一个日期校验规则，并传入给自己的数据进行校验。如果 date 字段无法转为日期格式，那么校验不通过。
总结
这里介绍了 npm 包 schema-validation 的使用方法，可以在 Node.js 中方便进行数据对象的校验。通过校验规则的定义、数据的传入以及使用自定义校验规则，可以完成各种形式的数据校验。建议开发者在开发过程中经常使用 schema-validation 进行数据校验，可以提高开发效率和代码的稳定性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bcf967216659e244e65