npm 包 object-schemata 使用教程

object-schemata 是一个基于 JSON Schema 的 Node.js/npm 包，它提供了一种结构化、灵活的方式来验证和处理 JavaScript 对象。

为什么要用 object-schemata

在前端开发中，经常需要对前端传输的数据进行验证，确保数据的正确性和安全性。而 JSON Schema 是一种通用的描述 JSON 数据结构的语言，它可以用于验证数据、生成代码、服务端/客户端数据的交互等。

object-schemata 将 JSON Schema 转换成了代码，提供了方便的 API 来在 JavaScript 中使用 JSON Schema。

安装

可以通过 npm 来安装 object-schemata：

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

使用

object-schemata 使用起来很简单。

首先，需要创建一个 JSON Schema，例如一个简单的用户对象：

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

然后，使用 object-schemata 来创建一个 Schema 对象：

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

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

这个 Schema 对象就可以用来验证任意的 JavaScript 对象了。例如，以下代码将会验证一个用户对象是否合法：

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

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

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

如果用户对象不符合 JSON Schema 中规定的结构，validate 方法就会返回错误信息。

更多高级用法

支持自定义关键字

在 JSON Schema 中，我们可以使用 $ 开头的关键字来定义一些自定义的规则。例如，以下 JSON Schema 定义了一个 range 关键字：

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

如果要使用 range 关键字，需要先注册它：

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

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

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

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

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

然后在 JSON Schema 中使用 range 关键字：

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

支持自定义类型

object-schemata 内置了一些基本类型（如 string、number、boolean、array、object），但如果需要自定义类型，也很容易。例如，以下代码定义了一个自定义类型 address：

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

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

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

然后在 JSON Schema 中使用 address 类型：

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

支持异步验证

有时候我们需要进行一些异步的验证，例如用户名是否已经存在等等。可以使用 addAsyncValidator 方法来添加异步验证函数。

例如，以下代码定义了一个异步验证函数 usernameExists，它通过查询数据库来检查用户名是否已经存在：

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

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

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

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

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

然后在 JSON Schema 中使用 usernameExists 关键字：

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

支持自定义错误信息

有时候需要自定义错误信息，可以在 JSON Schema 中使用 errorMessage 关键字：

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

支持自定义消息翻译

有时候需要将错误信息翻译成不同的语言。object-schemata 支持定义消息翻译器。

例如，以下代码定义了一个简单的消息翻译函数：

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

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

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

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

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

然后，使用 setTranslate 方法来设置当前语言：

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

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

示例

最后，可以通过以下示例来更好地理解如何使用 object-schemata：

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

结束

通过这篇文章，我们学习了如何使用 object-schemata 来验证和处理 JavaScript 对象。除了上述的基本用法，object-schemata 还提供了许多高级用法，如自定义关键字、类型、异步验证、错误信息和消息翻译等等。希望这篇文章对你有所帮助。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5ef1c5be8c4ce90ee4ca3b2e

阅读全文

猜你喜欢

  • HTML的标签

    HTML标签详解 HTML（Hypertext Markup Language）是一种用于创建网页的标记语言。在HTML中，有许多不同类型的标签可以用来定义网页的结构和内容。

    4 年前
  • npm包 exif-parser 使用教程

    简介 在前端开发中，我们经常遇到需要读取照片中的一些信息，比如拍照时间、曝光时间、ISO等等。而这些信息通常都被嵌入在照片中的 exif 数据中。exif-parser 就是一个可以帮助我们解析 ex...

    4 年前
  • npm 包 @types/terser 使用教程

    前言 前端开发中，我们经常需要压缩 JavaScript 代码以提高页面的加载速度，而 Terser 是一个高效的 JavaScript 压缩工具，可以帮助我们完成这个任务。

    4 年前
  • npm 包 @percy/agent 使用教程

    简介 @percy/agent 是一个用于测试和集成的 JavaScript 应用程序的开源软件包，可轻松捕获页面渲染，并在屏幕截图中进行比较。@percy/agent 依靠 Percy 服务，为用户...

    4 年前
  • npm 包 freelist 使用教程

    介绍 npm 包 freelist 是一个用于高性能内存管理的开源库，它可以优化内存的使用，从而提高应用的性能。使用 freelist 可以有效地减少应用的内存峰值和内存碎片。

    4 年前
  • npm 包 eslint-config-kswedberg 使用教程

    在前端开发中，我们经常需要使用静态代码检查工具来规范我们的代码，并保证代码的质量和一致性。而其中较为流行的一种工具就是 eslint，它可以在编辑器中实时检查代码，并给出相应的错误和警告信息。

    4 年前
  • npm 包 abstract-chunk-store 使用教程

    在前端开发中，处理大量数据是一件很常见的事情。abstract-chunk-store 是一个 npm 包，它允许我们将大数据切片，并以一种统一的方式进行存储和处理。

    4 年前
  • npm 包 cln 使用教程

    什么是 cln？ cln 是一个使用 JavaScript 编写的高精度计算库，可以进行任意精度的整数和有理数计算。它是一个 npm 包，可以被前端和后端项目使用。

    4 年前
  • npm 包 escaper 使用教程

    介绍 escaper 是一款用于处理 HTML、CSS 和 JavaScript 转义的 npm 包。在前端开发中，经常需要将一些特殊字符进行转义，防止出现安全问题或者显示错乱等情况。

    4 年前
  • npm 包 piece-length 使用教程

    在前端开发中，我们经常需要进行数据分片处理。npm 包 piece-length 就是一个很好的选择。它可以用来将一个大数据分成指定大小的小数据块，并且可以对每个块进行加密、签名等处理。

    4 年前
  • npm包filestream使用教程

    在前端开发中，处理文件是很常见的任务。filestream是一个npm包，可以帮助我们简洁、高效地处理文件。本文将详细介绍如何使用filestream这个npm包，希望可以为前端工程师提供帮助。

    4 年前
  • npm 包 tiny-json-http 使用教程

    在前端开发中，经常会需要向后端请求数据接口，而此时使用的工具就是 http 请求。但是，由于 http 请求的使用较为繁琐，因此出现了许多 http 请求的封装库，其中，tiny-json-http ...

    4 年前
  • npm 包 cache-chunk-store 使用教程

    概述 在前端项目开发过程中，经常需要从服务器上获取分块数据。这些数据可能非常大，因此传输和存储的效率对应用性能非常关键。cache-chunk-store 是一个 npm 包，它通过使用一个类似缓存的...

    4 年前
  • npm 包 @esfx/disposable 使用教程

    随着前端开发的发展，我们越来越需要使用像 node.js 这样的工具来处理我们的项目。Node.js 包管理器（npm）是一个伟大的工具，它提供了一个庞大的生态系统，让我们能够使用各种模块来实现我们的...

    4 年前
  • 使用 @esfx/cancelable 包

    @esfx/cancelable 是一个被广泛使用的npm包，用于在JavaScript中实现cancellation 和 abortability 的功能。它可用于取消promise, setTim...

    4 年前
  • npm 包 grunt-gulp 使用教程

    什么是 grunt 和 gulp？ 在介绍如何使用 npm 包 grunt-gulp 前，让我们先了解一下 grunt 和 gulp。 grunt 和 gulp 都是前端自动化构建工具，它们可以帮助我...

    4 年前
  • npm 包 @types/tinycolor2 使用教程

    今天我们将会学习如何使用 npm 包 @types/tinycolor2 来管理我们前端项目中的颜色值。这个 npm 包提供了一个强大的颜色处理类，可以用于处理混合色、颜色值计算、格式化等等操作。

    4 年前
  • 前端开发指南：npm 包 @pixi/canvas-renderer 使用教程

    介绍 在前端开发过程中，我们会经常使用到各种第三方库或者 npm 包来提高自己的开发效率。其中一个非常实用的 npm 包就是 @pixi/canvas-renderer。

    4 年前
  • npm 包 jqlite 使用教程

    jqlite 是一个精简版的 jQuery，它实现了 jQuery 的一部分功能，代码量更为精简，适用于在项目中，只需要使用 jQuery 的部分功能的情况。本文将介绍 jqlite 的使用方法，希望...

    4 年前
  • npm 包 rc-field-form 使用教程

    引言 在前端开发中，我们经常需要处理表单的输入输出，表单的校验以及表单数据的提交等一系列操作。而在 React 中，我们可以通过使用 npm 包 rc-field-form 来方便地进行表单处理。

    4 年前

相关推荐

    暂无文章