前端开发中，我们时常需要使用一些开源的 npm 包来辅助我们的工作。 hapi-session-auth 便是一款非常实用的 Node.js 包，它可以帮助我们在 hapi 框架中快速添加用户身份认证功能。
在本文中，我们将详细介绍如何安装和使用 hapi-session-auth，以及一些需要注意的事项和示例代码。
安装
使用 hapi-session-auth 首先需要安装 Node.js 和 hapi 框架。
安装 hapi-session-auth 只需要使用 npm 即可:
npm install hapi-session-auth --save
初始化
在你的 hapi 项目中，你需要在启动服务器之前初始化 hapi-session-auth。
-- -------------------- ---- -------
----- ------ - --- -------------
----- -----
----- ------------
---
----- -----------------
------- -----------------------------
-------- -
----------- -------------
-
---在这段代码中，我们初始化了一个名为 server 的 hapi 服务器实例，并且在注册插件时指定了 hapi-session-auth。
cookieName是一个可选配置，它用来指定保存认证信息的 cookie 名称，默认情况下，cookie 名称为 SID。在此我们将其设置为 AUTH_COOKIE。
保护路由
一旦我们成功初始化了 hapi-session-auth，便可以开始保护需要登录才能访问的路由。
-- -------------------- ---- -------
--------------
------- ------
----- ----
-------- -
----- ----------
-------- -------- --------- -- -
------ -------- ----- -----------
-
-
---在这段代码中，我们定义了一个 GET 请求，当用户访问 / 时只有在用户已经登录的情况下才会返回欢迎页面。
需要注意的是，我们通过为 options 中的 auth 增加值 'session’ 来指定此路由需要用户进行身份认证。
登录
我们来看看如何在 hapi-session-auth 中实现用户登录的逻辑。
-- -------------------- ---- -------
--------------
------- -------
----- ---------
-------- -
-------- ----- -------- --------- -- -
--- ---- - ----- ----------------------------------
-- ------- -
----- -------------------------- --------------
-
--- ------- - ----------------------------------------------------
----- ---------------------- ------
------ -------- - - --------- - ----
-
-
---在这段代码中，我们定义了一个 POST 请求，用户可以通过在请求体中提交用户名和密码来进行登录操作。
首先，我们使用 getUser() 函数来获取用户数据。如果该用户不存在，我们使用 Boom 抛出 401 错误。
然后，我们通过访问 hapi-session-auth 插件实例的 session 对象，调用 login() 函数来设置用户身份认证信息。
登出
当用户想要退出登录时，我们需要清除他的身份认证信息。
-- -------------------- ---- -------
--------------
------- -------
----- ----------
-------- -
-------- ----- -------- --------- -- -
--- ------- - ----------------------------------------------------
----- ------------------------
------ -----------
-
-
---在这段代码中，我们定义了一个 POST 请求，用户可以调用它来退出登录并清除身份认证信息。
通过访问 hapi-session-auth 插件实例的 session 对象，调用 logout() 函数，我们可以轻松完成该操作。
总结
hapi-session-auth 是一个非常实用的 npm 包。通过它，我们可以在 hapi 框架中非常方便地添加用户身份认证功能。
在本文中，我们详细介绍了如何安装和使用 hapi-session-auth，在路由中添加身份认证，以及如何实现用户登录和登出。
希望这篇文章能对你有所帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600567fd81e8991b448e4231