在前端开发过程中，我们经常需要进行数据验证和效验。为了解决这个问题，开发者们开发出了很多验证库来帮助我们进行数据效验。其中一个非常好用的库就是npm包@davewm/ajv。
这个 npm包的使用方法非常简单，它提供了一种方便、快捷的方式来对前端所持有的各式各样的数据进行校验。在本篇文章中，我们将详细解释如何使用@davewm/ajv，以及如何在你的开发中应用它。
环境要求
在使用@davewm/ajv之前，需要满足以下环境要求：
- Node.js v10 或以上版本
安装
安装@davewm/ajv可以通过 npm 包管理器或 yarn 包管理器进行。
使用 npm
可以使用如下命令安装：
npm install @davewm/ajv --save
使用 yarn
可以使用如下命令安装：
yarn add @davewm/ajv
开始使用
@davewm/ajv的使用非常简单，仅仅只需要使用以下几行代码：
-- -------------------- ---- -------
-- -- ---
----- --- - ----------------------
-- --- ---
----- --- - --- -----
-- -- ------
----- ------ - -
----- ---------
----------- -
----- -
----- --------
--
---- -
----- --------
--
-------- -
----- --------
------ -
----- --------
-
-
--
--------- -------- ------ ----------
-
-- ------
----- ----- - -------------------- ------ ------- ---- --- -------- ----------- ------------
-- -------- -----------------------通过引入 @davewm/ajv，我们可以实例化一个ajv对象。接着，我们定义了一个 JSON 数据格式的 schema 对象，并对其进行校验。
对于schema，@davewm/ajv的提供灵活的语法来定义校验规则。以上 schema 对象中，我们定义了一个 object 类型，其中包含了三个属性：name，age，hobbies。
其中，name 为string类型，age为number类型，hobbies为Array类型，并且它包含了一个包含 item 装了 string 类型的子类型。required属性指定了所有键名，它们都是必须存在的，否则校验将无法通过。
在进行数据的校验过程中，我们传入schema和需要校验的JSON字符串。如果校验通过，则返回true，否则返回相应的错误信息。
在控制台上运行以上代码将得到如下输出结果：
$ node ajvExample.js
false
[ { keyword: 'required',
dataPath: '',
schemaPath: '#/required',
params: { missingProperty: 'hobbies' },
message: "should have required property 'hobbies'" } ]
$以上输出结果告诉我们，校验未通过，因为schema中必须包含属性hobbies。因此，在进行如下 test 中：
ajv.validate(schema, {name:'Lucy', age:23, hobbies:['reading', 'running']})我们得到的输出结果为 true，证明校验已经通过。
使用帮助
使用@davewm/ajv时可能会遇到一些问题，下面是一些常见的问题和解决方案。
如何进行自定义校验？
@davewm/ajv支持自定义校验规则，您可以通过添加一个新的 validation 对象来达到这个目的。举个例子，以下代码定义了一个 customMax validation function，在数据校验过程中，当存在值且大于限定的最大值，则返回一个错误信息。
-- -------------------- ---- -------
--------------------------- -
--------- -------- -------- ----- -
------ ------ ---- -- -------- -- ---- -- ------
--
------- -----
--
------------
------------------------ --- ---
------------------------ --- --
-在以上代码中，我们使用AJV的addKeyword方法来添加一个全局的校验规则。validation function接收schema和value两个参数，值为true表示验证正确，否则返回错误信息。
如何自定义错误信息？
@davewm/ajv 提供了一个入口可以自定义错误信息。使用 errorsText 方法，您可以在调用校验方法时自定义错误信息。
const schema = {type: 'string'}
const validate = ajv.compile(schema)
validate('test')
console.log(errorsText(validate.errors, {separator: '\n'}))在以上代码中，errorsText 方法接受两个参数，一个是错误数组，另一个是可选配置项。配置项中包含一个自定义 separator，以便将错误信息更清晰地输出。
总结
@davewm/ajv是一个非常好用的前端JSON数据校验包，它简便易用，且定义校验规则语法简单。在本篇文章中，我们详述了它的安装、使用和一些常见问题解决方案。希望这篇文章可以对你的前端开发工作有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005516381e8991b448ce8fe