在开发 Web 应用程序时，对于来自浏览器的请求参数，对其进行验证是一项非常重要的安全措施。Hapi.js 是一个流行的 Node.js Web 框架，它提供了众多的插件和工具来帮助开发人员快速构建和维护 Web 应用程序。
在 Hapi.js 中，使用 Joi 库可以轻松地定义和验证请求参数。Joi 是一个简单、可扩展和强大的验证库，它提供了多种验证规则和验证器，使得开发人员可以轻松地定义和验证请求参数。
在本文中，我们将介绍如何使用 Joi 库在 Hapi.js 中进行请求参数验证，并提供一些实用的技巧和示例代码。
Joi 的基本使用
首先，我们需要安装 Joi 库。在 Node.js 中，可以使用 npm 包管理器来完成安装：
npm install joi --save
然后，在 Hapi.js 中使用 Joi 进行请求参数验证非常简单。我们首先定义一个 Joi 对象，然后将其用于验证请求参数。以下是一个基本的示例：
-- -------------------- ---- -------
----- --- - ---------------
----- ------ - ------------
--------- ------------
-----------
-------
--------
------------
--------- ------------
------------ -------------------------------
---
--------------------- ----- --------- -- -- -
----- - --------- -------- - - ----------------
--- -
----- ---------------------- --------- -------- ---
- ----- ------- -
------ -----------------------------------------------
-
-- -- ------------
---在上面的代码中，我们首先定义了一个 Joi 对象，其中包含了两个请求参数：username 和 password。对于 username 参数，我们定义了其必须为字符串类型，并且长度必须在 3 到 30 之间。对于 password 参数，我们定义了其必须为字符串类型，并且只包含数字和字母，并且长度必须在 3 到 30 之间。
然后，在处理请求时，我们可以使用 schema.validateAsync() 方法对请求参数进行验证。如果验证失败，则该方法将抛出一个错误。在这种情况下，我们将错误信息返回给客户端，并设置 HTTP 响应码为 400。
高级使用示例
在实际开发中，我们经常需要使用更多的验证规则和验证器来验证请求参数。下面是一些实用的技巧和示例代码，可以帮助你更好地使用 Joi 库在 Hapi.js 中进行请求参数验证。
自定义错误消息
默认情况下，Joi 将返回一个带有错误消息的对象，其中包含有关验证失败的详细信息。但是，有时候我们需要对错误消息进行自定义，以便更好地与我们的应用程序集成。通过传递一个 options 对象，我们可以轻松地自定义错误消息。以下是一个示例：
-- -------------------- ---- -------
----- ------- - -
------- -
----- -
------ ---
--
------ ---
--
--
----- ------ - ------------
--------- ------------
-----------
-------
--------
-----------
-----------
-------------- --------- ---- -- - --------
--------------- --------- ------ -- -------
------------- --------- ---- -- -- ----- --------- ---------- ------
------------- --------- ---- -- ---- ---- -- ----- -- --------- ---------- ------
--------------- --------- -- ----------
---
--------- ------------
------------ ------------------------------
-----------
-----------
---------------------- --------- ---- ------- ---- ------- --- ---------
--------------- --------- -- ----------
--
-- ---------在上面的代码中，我们定义了一个 options 对象，其中包含了自定义的错误消息。然后，在我们的 Joi 对象中，我们使用 messages() 方法来自定义每个验证规则的错误消息。
进行深度验证
有时候，我们需要对深度嵌套的请求参数进行验证。例如，当我们使用 JSON 表示复杂对象时，可能需要验证一个对象中的某个特定属性。以下是一个示例：
-- -------------------- ---- -------
----- ------ - ------------
----- -------------------
--- -----------------------------------
----- ------------------------
------ --------------------------------
-------- -------------------
------- ------------------------
----- ------------------------
------ ------------------------
---- ------------------------
---
---
---
------------------------ ----- --------- -- -- -
----- - ---- - - ----------------
--- -
----- ---------------------- ---- ---
- ----- ------- -
------ -----------------------------------------------
-
-- -- ------------
---在上面的代码中，我们定义了一个对象验证规则，该规则包含了一个名为 user 的对象属性。在 user 对象属性中，我们继续定义了其他多个验证规则，其中包含了一个 address 对象属性。通过这种方式，我们可以对复杂的嵌套对象进行验证。
进行异步验证
在某些情况下，我们可能需要对请求参数进行异步验证。例如，当我们需要从数据库或外部 API 中检索验证规则时，可能需要进行异步验证。以下是一个示例：
-- -------------------- ---- -------
----- ------ - ------------
------ --------------------------------
--------- --------------------------------------------------
---
------------------------ ----- --------- -- -- -
----- - ------ -------- - - ----------------
----- ---------------- - ----- -----------------------------
----- ------------------- - ----- -----------------------------------
-- ------------------- -
------ ----------------- -- ------- -- ----------------
-
-- ---------------------- -
------ -------------------- -- ------- -- ----------------
-
--- -
----- ---------------------- ------ -------- ---
- ----- ------- -
------ -----------------------------------------------
-
-- -- ------------
---在上面的代码中，我们通过调用 checkIfEmailAvailable() 和 checkIfUsernameAvailable() 函数来异步检查 email 和用户名是否可用。如果这些检查未通过，则返回一个 400 错误响应。否则，我们将使用 schema.validateAsync() 方法对请求参数进行验证。
结论
在 Hapi.js 中使用 Joi 进行请求参数验证是一个非常简单和强大的方法。通过使用 Joi，我们可以轻松地定义和验证请求参数，并使用各种技巧和方法来实现高级验证需求。希望这篇文章能够帮助你更好地使用 Joi 和 Hapi.js，从而构建更安全、更可靠的 Web 应用程序。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67047b3bd91dce0dc84efe6a