对于前端开发者来说，使用 NPM 包是非常常见的事情。NPM 包可以提供很多方便的工具和库，帮助我们更好地完成项目。在这篇文章中，我们将会介绍一个名为 hapiverse 的 NPM 包，并提供详细的使用教程和示例代码，希望能够帮助读者更好地掌握这个工具，为开发项目提供帮助。
什么是 hapiverse
hapiverse 是一个用于构建 Node.js 服务的工具包，它基于 Hapi 框架，提供了一些常见的 plugin 和 utility，帮助我们更高效地构建服务。hapiverse 中包含的 plugin 包括：
- hapi-mongodb：用于连接和查询 MongoDB 数据库。
- hapi-redis：用于连接和操作 Redis 数据库。
- hapi-auth-jwt2：用于 JWT token 的验证和生成。
- good：用于记录服务器日志的插件。
- ……
同时，hapiverse 还提供了一些建议的目录结构和一些通用的 helper 方法，将 Hapi 应用中需要用到的文件组织起来，并为我们提供了更简单的方式来完成一些常见的操作，例如，统一的异常处理、记录请求响应信息等。
安装 hapiverse
安装 hapiverse 是非常简单的，只需要运行命令：
npm install hapiverse --save
使用 hapiverse
在应用中使用 hapiverse 非常容易，只需要在应用启动时，调用 hapiverse 的 compose 方法即可。
-- -------------------- ---- -------
----- ---- - ----------------
----- --------- - ---------------------
----- -------- ------- -
----- ------ - --- -------------
----- -----
----- -----------
---
----- -----------------------------------
-- ------------
----- ---------------
------------------- ------- -- ---------------------
-
--------在上面的代码中，我们首先创建了一个 Hapi 服务器实例，然后传递给 hapiverse 的 server 方法，接着调用 compose 方法即可。在调用 compose 方法之后，hapiverse 会自动帮我们加载各种插件和初始化操作。
插件
hapiverse 中的插件可以为我们提供很多功能，包括数据库连接、认证、记录日志等。下面我们将简单介绍几个常用的插件的使用。
MongoDB
hapiverse 中的 hapi-mongodb 插件可以帮我们连接和操作 MongoDB 数据库。使用时，我们需要先在应用中配置 MongoDB 的连接信息。
-- -------------------- ---- -------
----- ------ - -
----- ------------
----- ------
--- ------
--
----- -----------------
------- ------------------------
-------- -
---- ------------------------------------------------------
--
------- -------- -------
---上面的代码中，我们将 hapi-mongodb 插件注册到了服务器实例中，并传递了 MongoDB 的连接信息。同样的，我们也可以传递其他的选项，例如连接池大小等。
完成配置之后，我们就可以在路由处理函数中使用 request.mongo.db 来获取数据库连接了。
server.route({
method: 'GET',
path: '/users',
handler: async (request, h) => {
const users = await request.mongo.db.collection('users').find().toArray();
return users;
}
});在上述代码中，我们使用了 request.mongo.db 来获取数据库连接，并使用 collection 方法来访问对应的集合。这样就可以很方便地操作 MongoDB 数据库了。
Redis
hapi-redis 插件可以帮助我们连接和操作 Redis 数据库。和 MongoDB 插件一样，我们首先需要在应用中配置 Redis 的连接信息。
-- -------------------- ---- ------- ----- ------ - - ----- ------------ ----- ---- -- ----- ----------------- ------- ---------------------- -------- ------- ------- -------- ------- ---
完成配置之后，我们就可以在路由处理函数中使用 request.redis 来获取 Redis 连接了。
server.route({
method: 'GET',
path: '/count',
handler: async (request, h) => {
const count = await request.redis.get('count');
return {count};
}
});在上述代码中，我们使用了 request.redis 来获取 Redis 连接，并使用 get 方法来访问对应的数据。这样就可以很方便地操作 Redis 数据库了。
JWT 认证
hapi-auth-jwt2 插件可以帮助我们验证和生成 JWT token。使用时，我们首先需要设置 JWT 的加密密钥和有效期。
const jwtSecretKey = 'secret key';
const jwtExpireIn = '7d';
server.auth.strategy('jwt', 'jwt', {
key: jwtSecretKey,
validate: validateToken,
verifyOptions: { algorithms: ['HS256'] }
});在上述代码中，我们首先通过 server.auth.strategy 方法注册了一个 JWT 验证策略，然后配置了 JWT 的加密密钥、验证方法和加密算法。同时我们还需要设置对应的验证方法。
async function validateToken(decoded, request, h) {
// 在这里进行 token 的验证操作
if (/* token 验证失败 */) {
throw h.unauthenticated();
}
return { isValid: true };
}在上述代码中，我们定义了一个 validateToken 方法来处理 token 的验证操作。在此方法中，我们可以自定义验证 token 的方式，并在 token 验证失败时抛出 hapi 的 unauthenticated 错误，以便于 hapi-auth-jwt2 插件正确处理 JWT 认证错误。
当我们需要验证需要认证的路由时，我们只需要在路由配置中加入 auth 参数即可。
-- -------------------- ---- -------
--------------
------- ------
----- ---------
-------- -
----- -----
--
-------- ----- --------- -- -- -
-- ------------
-
---在上述代码中，我们定义了一个需要 JWT 认证的路由，启动时 hapiverse 会自动为路由添加对应的认证策略。这样就可以很方便地进行 JWT 认证了。
结语
在这篇文章中，我们介绍了 hapiverse 这个 NPM 包的使用方法，并提供了详细的示例代码和文档，希望能够帮助读者更好地掌握 hapiverse，为开发项目提供帮助。若有不妥之处，欢迎指正。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/116775