Hapi.js 是一个构建 web 应用程序和服务的开源框架，它采用了插件化的架构，可以轻松地添加或删除一些功能模块，以便满足特定的需求。
在本文中，我们将介绍如何开发 Hapi.js 插件，并提供一些实践经验和指导意见。
Hapi.js 插件开发简介
在 Hapi.js 中，插件是一些独立的模块，可以被其他应用程序或插件调用。插件可以提供各种功能，例如路由、缓存、验证、日志等等。
Hapi.js 提供了一个简单的接口，使得开发者可以轻松地创建和注册他们自己的插件。下面是一个简单的例子：
-- -------------------- ---- -------
----- -------- - -
----- -----------
--------- ---------------- -------- -
--------------
------- ------
----- ---------
-------- ----------------- -- -
------ ------ --------
-
---
-
--
-------------- - ---------在上面的例子中，我们创建了一个简单的插件，它添加了一个路由 /hello，当用户访问该路由时，返回字符串 'Hello World!'。
要使用该插件，只需将其作为参数传递给 Hapi.js 服务器的 register() 方法即可：
-- -------------------- ---- ------- ----- ---- - ---------------------- ----- -------- - ---------------------- ----- ------ - ------------- ----- ----- ----- ----------- --- ----- ---- - ----- -- -- - ----- -------------------------- ----- --------------- ------------------- ------- --- --------------------- -- -------
在上述代码中，我们将 myPlugin 注册到 Hapi.js 服务器中，并启动该服务器。
Hapi.js 插件开发实践
将插件配置与选项分离
在你的插件中，你可能需要提供一些定制的配置选项，例如数据库 URL 或 API key 等等。为了使插件更加灵活和可配置，你应该将这些选项和默认值分开。
以下是一个示例代码，展示了如何使用默认选项和通过传递选项覆盖默认值：
-- -------------------- ---- -------
----- -------- - -
----- -----------
--------- ---------------- -------- -
----- -------- - ----------------- ---------------- ---------
-- -- --------- ---- -----------
-
--
----- --------------- - -
---- ------
---- --
--在上面的例子中，我们定义了一个名为 DEFAULT_OPTIONS 的常量，它包含了插件的默认选项。然后，在插件注册过程中，我们使用 Object.assign() 方法来将 options 和 DEFAULT_OPTIONS 合并起来，并将其存储在一个名为 settings 的常量中。
通过这种方式，使用者可以传递他们自己的选项，以覆盖默认值。
插件错误处理
当你的插件遇到错误时，应该使用 Hapi.js 的错误处理机制来处理这些错误。Hapi.js 提供了一个专门的错误类 Boom，它可以生成各种 HTTP 错误，例如 404、500 等。
以下是一个简单的例子，展示了如何使用 Boom 来处理插件中的错误：
-- -------------------- ---- -------
----- -------- - -
----- -----------
--------- ---------------- -------- -
--------------
------- ------
----- --------------
-------- ----------------- -- -
----- - -- - - ---------------
-- ------- -- --- --------- -
----- ------------------------ ---- -----
-
----- ---- - ----------------
-- ------- -
----- ------------------- --- --------
-
------ -----
-
---
-
--在上面的例子中，我们在路由处理函数中，检查 id 是否为数字。如果不是，我们使用 Boom.badRequest() 方法来抛出一个 400 错误。如果找不到用户，我们使用 Boom.notFound() 方法来抛出一个 404 错误。这样可以确保调用者得到有意义的错误响应。
插件测试
在开发 Hapi.js 插件时，测试是不可或缺的一部分，因为它可以确保你的代码能够按照预期工作。Hapi.js 提供了内置的测试工具，可以帮助你编写和运行测试用例。
以下是一个简单的例子，展示了如何使用 Hapi.js 的测试工具来测试插件：
-- -------------------- ---- -------
----- ---- - ----------------------
----- --- - ---------------------
----- ---- - ----------------------
----- -------- - ----------------------
----- - --------- -- - - ------------ - --------------
----- - ------ - - -----
-------------------- -- -- -
----------- ------ --------- ----- -- -- -
----- ------ - --------------
----- --------------------------
----- --- - ----- ------------------------
-------------------------------------
---------------------------------- ---------
---
---在上述代码中，我们使用了 @hapi/lab 和 @hapi/code 这两个库来编写测试用例。我们创建了一个名为 myPlugin 的测试套件，它包含了一个名为 returns "Hello World!" 的测试用例。
该用例使用 Hapi.server() 创建一个临时的 Hapi.js 服务器，然后将 myPlugin 注册到该服务器中。然后，我们使用 server.inject() 方法来模拟客户端请求，获取返回值，最后使用 expect() 断言库来验证预期结果。
通过相应的测试用例，您可以确保自己的插件能够按照预期工作。
结论
在本文中，我们介绍了如何开发 Hapi.js 插件，并提供了一些最佳实践和指导意见，包括：将插件配置与选项分离、插件错误处理以及插件测试等。
我们希望本文能够帮助你快速入门 Hapi.js 插件开发，并且在实践中获得更好的体验。如果您有其他建议或补充，欢迎在评论区留言。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67179f95ad1e889fe222a26e