npm 包 json-bouncer 使用教程

随着前端应用的不断发展，越来越多的数据以 JSON 格式传输，并且需要进行校验和过滤。为了方便开发者建立这种校验和过滤的规则，本文介绍一个 npm 包——json-bouncer，可以帮助你快速完成 JSON 校验和过滤的工作。

简介

json-bouncer 是一个简单易用的 JSON 格式校验和过滤库。借助 json-bouncer，您可以：

• 按照您的需求对 JSON 数据进行校验和过滤；
• 链式调用过滤器；
• 使用自定义函数过滤数据中的每个字段。

安装

安装 json-bouncer 很简单，只需要在控制台输入以下命令：

npm install json-bouncer --save

基本语法

首先，我们需要导入 JsonBouncer：

import JsonBouncer from 'json-bouncer';

然后，我们可以创建一个规则：

const rules = {
  name: JsonBouncer.string().notEmpty(),
  age: JsonBouncer.number().min(18),
  gender: JsonBouncer.string().onlyIn(['male', 'female']),
};

最后，我们可以使用这个规则来校验一个 JSON 对象：

const data = {
  name: '张三',
  age: 20,
  gender: 'male',
};

const result = JsonBouncer.validate(data, rules);

校验结果将会是一个数组。如果校验失败，则数组包含失败的原因；如果校验成功，则数组为空。

使用自定义过滤函数

如果您需要对某个字段进行更复杂的校验，可以使用自定义函数：

-- -------------------- ---- -------
----- ----- - -
  ----- -------------------------------------- -- -
    ----- - ------ --- - - ------
    ------ --- - ----- - --
  --
--

----- ---- - -
  ----- -
    ------ ---------
    ---- ---------
  --
--

----- ------ - -------------------------- -------

在上面的例子中，我们实现了一个过滤函数，它要求 data.end 必须大于 data.start。我们通过 addFilter 方法将这个过滤函数添加到校验规则中。

链式调用

不仅可以为一个字段添加一个或多个过滤器，还可以为一个字段添加一个或多个规则：

const rules = {
  name: JsonBouncer.string().notEmpty().maxLength(20),
  age: JsonBouncer.number().min(18).max(99),
  gender: JsonBouncer.string().onlyIn(['male', 'female']),
};

在上述代码中，我们为 name 添加了 notEmpty 和 maxLength 两个规则，并且为 age 添加了 min 和 max 两个规则。每个过滤器和规则的返回值都是 JsonBouncer 对象，因此可以用链式调用的方式进行方法调用。

可用的过滤器和规则

在 json-bouncer 中，有许多可用的过滤器和规则，如下表所示：

结论

到这里，我们已经学会了如何使用 json-bouncer 进行 JSON 校验和过滤的基本操作，以及如何使用自定义过滤函数和链式调用。感谢你的阅读，希望这篇文章对你有所帮助！

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600562d581e8991b448e02c0