Hapi 是一个基于 Node.js 的后端 Web 框架，它的目标是构建可扩展、高效、可靠的服务器，适合于构建企业级 Web 服务端。本文将介绍如何使用 Hapi 框架构建企业级 Web 服务端，包含深度、实用的学习和指导意义。
安装和配置 Hapi
首先，我们需要安装 Hapi。可以使用 npm 包管理器进行安装：
$ npm install hapi
安装完成后，我们可以通过以下代码来启动一个简单的 Hapi 服务器：
-- -------------------- ---- -------
----- ---- - ----------------
----- ------ - -------------
----- -----
----- -----------
---
--------------
------- ------
--------------
-------- --------- -- -- -
------ ------ --------
-
---
----- ----- - ----- -- -- -
----- ---------------
------------------- ------- --- ---------------------
--
--------在上面的例子中，我们定义了一个简单的路由来处理 HTTP GET 请求。这个路由会返回 Hello World! 字符串。启动服务器的方法使用了 async/await 语法，这是因为 server.start() 方法是异步的。
当我们运行这个程序时，服务器将启动并监听 3000 端口。访问 http://localhost:3000/hello 将会返回字符串 Hello World!。
基本路由
Hapi 的核心部分是路由系统。路由是用来匹配客户端发来的请求的。在 Hapi 中，路由是由以下信息组成：
- HTTP 方法（GET、POST、PUT、DELETE 等）
- URL 路径，可以包含参数
- 处理函数，用于处理请求和返回响应
让我们看一个简单的例子，使用 GET 方法和 /users 路径来返回用户列表：
-- -------------------- ---- -------
--------------
------- ------
----- ---------
-------- --------- -- -- -
----- ----- - -
- ----- ------- --
- ----- ----- --
- ----- --------- -
--
------ ------
-
---在这个例子中，我们定义了一个路由，它匹配 GET 方法和 /users 路径。当客户端访问 /users 时，处理函数将会被调用，返回一个包含三个用户的数组。
参数和查询字符串
路由不仅可以匹配 URL 路径，还可以匹配参数和查询字符串。下面的例子演示了如何使用路由参数：
server.route({
method: 'GET',
path: '/users/{id}',
handler: (request, h) => {
const id = request.params.id;
return `User ID: ${id}`;
}
});在这个例子中，我们定义了一个路由，它匹配 GET 方法和 /users/{id} 路径。{id} 是路由参数，可以匹配任何非空字符串。当客户端访问 /users/123 时，处理函数将会被调用，request.params.id 将会返回字符串 '123'。
接下来，我们来演示如何使用 Hapi 获得请求中的查询字符串。例如，如果客户端访问 /search?q=hapi，我们可以使用以下代码来获取查询字符串：
server.route({
method: 'GET',
path: '/search',
handler: (request, h) => {
const query = request.query.q;
return `Search Query: ${query}`;
}
});在这个例子中，我们定义了一个路由，它匹配 GET 方法和 /search 路径。当客户端访问 /search?q=hapi 时，处理函数将会被调用，request.query.q 将会返回字符串 'hapi'。
静态文件和目录
Hapi 还可以用来服务静态文件和目录。如果你的应用程序需要提供静态文件，可以使用 inert 插件来处理这个任务。
首先，需要安装 inert 插件：
$ npm install inert
然后，在启动服务器之前，我们需要注册 inert 插件：
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ----- - ----------------- ----- ------ - ------------- ----- ----- ----- ----------- --- ----- ----- - ----- -- -- - ----- ----------------------- ----- --------------- ------------------- ------- --- --------------------- -- --------
现在我们已经启用了 inert 插件，可以使用 reply.file 方法来服务静态文件和目录：
-- -------------------- ---- -------
--------------
------- ------
----- ------------------
-------- -
---------- -
----- --------
-
-
---在这个例子中，我们定义了一个路由，它匹配 GET 方法和 /public/{file*} 路径。这个路径包括一个 file 参数，可以匹配任何字符串。
当客户端访问 /public/index.html 时，reply.file 方法将会返回 public/index.html 文件的内容。
数据库集成
在构建企业级 Web 服务端时，数据库集成是必不可少的组成部分。Hapi 支持与多种数据库进行集成。在本文中，我们将使用 MongoDB 作为示例数据库。
首先，需要安装 mongodb 驱动程序：
$ npm install mongodb
然后，我们可以使用以下代码来连接 MongoDB 数据库：
-- -------------------- ---- ------- ----- ----------- - ------------------------------- ----- --- - ---------------------------------- ----- ------ - --- ---------------- - ---------------- ---- --- ------------------ -- - ----- ---------- - --------------------------------------- -- -------------- --------------- ---
在这个例子中，我们使用 MongoClient 来连接 MongoDB 数据库。myapp 是数据库的名称。
如果连接数据库成功，我们可以通过以下代码获得一个集合对象：
const collection = client.db('myapp').collection('users');现在就可以对这个集合进行相关的数据库操作了。
使用插件
Hapi 的插件机制使得它非常灵活和可扩展。许多插件可以用来帮助开发者构建更好的 Web 服务端。这里我们介绍两个常用的插件：joi 和 hapi-swagger。
joi 插件
joi 插件用来进行数据验证和转换。我们可以使用 joi 插件来校验客户端传递来的参数是否正确，以及将数据转换成指定的格式。
首先，需要安装 joi 插件：
$ npm install joi
然后，我们可以使用 joi 插件来校验客户端传递来的参数：
-- -------------------- ---- -------
--------------
------- ------
----- --------------
-------- --------- -- -- -
----- -- - ------------------
-- --------
----- - ------ ----- - - ------------
--- -----------------------
------------- -- ---
-- ------- -
----- -------------------------------
-
-- ------
------ ----- --- -------
-
---在这个例子中，我们使用 Joi.object 方法来定义一个参数规则。该规则包含一个名为 id 的属性，其值必须是一个数字。然后我们使用 validate 方法来校验传入的参数是否匹配规则。
如果参数与规则不匹配，validate 方法将返回 error 对象，我们可以使用 Boom 插件来抛出一个 400 错误。
hapi-swagger 插件
hapi-swagger 插件可以为 Hapi 服务器生成 API 文档。
首先，需要安装 hapi-swagger 插件：
$ npm install hapi-swagger
然后，在启动服务器之前，我们需要注册 hapi-swagger 插件：
-- -------------------- ---- -------
----- ---- - ----------------
----- ----- - -----------------
----- ------ - ------------------
----- ----------- - ------------------------
----- ------ - -------------
----- -----
----- -----------
---
----- ----- - ----- -- -- -
----- -----------------
------
-------
-
------- ------------
-------- -
----- -
------ ---- ---------------
-------- -----
-
-
-
---
----- ---------------
------------------- ------- --- ---------------------
--
--------现在，访问 http://localhost:3000/documentation 将会展示我们定义的所有路由的详细信息。这也意味着，我们需要为每个路由定义路由配置和路由描述：
-- -------------------- ---- -------
--------------
------- ------
----- --------------
------- -
----- --------
------------ ---- ---- -- ----
--------- -
------- ------------
--- -----------------------
--
-
--
-------- --------- -- -- -
----- -- - ------------------
-- ------
------ ----- --- -------
-
---在上面的例子中，我们为路由定义了 config 对象。在 config 对象中，我们可以定义路由相关信息，如标签、描述、验证等。
总结
本文介绍了如何使用 Hapi 框架来构建企业级 Web 服务端。我们学习了路由、参数、查询字符串、静态文件和目录、数据库集成和插件等内容。
使用 Hapi 框架可以让开发者更加高效、快速地构建出具有良好体验和可靠性的 Web 服务端。当然，本文仅仅是一个介绍，Hapi 框架的功能远远不止于此。通过学习文档和实际项目开发，我们可以发现 Hapi 框架拥有更多强大的功能和特性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/646202f3968c7c53b0358442