在前端开发中，我们时常需要进行用户认证，以保护敏感数据和操作，@i2/cake-auth-middleware 是一个提供用户认证功能的 npm 包，本文将详细介绍如何使用它。
安装
使用 npm 可以轻松安装 @i2/cake-auth-middleware:
--- ------- ------------------------ ------
使用
使用前需要先引入包并创建 middleware 实例。
----- -------------- - ------------------------------------ ----- ---------- - ---------------- ------- ---
options 是一个包含多种选项的对象，下面列出其中的重要选项：
- secretKey: 用于加密和解密 token 的秘钥。
- authPath: 认证路由的路径，默认为 '/auth'。
- excludePaths: 不需要进行认证的路由配置数组，默认为 []。
创建 middleware 实例后就可以在 express.js 中使用了，下面是一份示例代码：
----- ------- - ------------------- ----- -------------- - ------------------------------------ ----- --- - ---------- ----- ---------- - ---------------- ---------- ----------------- -- ---- --------- ------------- -- ------ ------------- --------------- -- ---------- --- -- ------- -------------------- -- ---------------- ---------------------- ----- ---- -- - ---------------- ------ --------- --- -- ---- ---------------------- ----- ---- -- - ----- - --------- -------- - - --------- -- ----------- ----- --- ----- ----- - -------------------------- --------- -------- --- ---------- ----- --- --- ---------------- -- -- - ------------------- ------- -- ------------------------ ---
在认证中间件被应用后，除了认证路由以外的路由都会被自动认证。当访问需要认证的路由时，middleware 会检查请求的 header 中是否包含一个名为 Authorization 的字段，该字段应包含一个 Bearer token（即以 Bearer 开头的字符串）。
如果请求 header 中未包含 Authorization 字段，服务器将返回一个 401 错误码，提示客户端登录。
如果请求 header 中包含了 Authorization 字段，则 middleware 会将其中的 token 进行解密，如果解密成功，则 middleware 会将解密后的 token 添加到 req 对象上，以便后续使用。
总结
@i2/cake-auth-middleware 是一个简单易用的用户认证中间件，它可以轻松地添加到 express.js 项目中，提供了很多选项来调整和定制其中的功能。
使用 @i2/cake-auth-middleware 可以大大简化用户认证的开发工作，提高生产力，提升用户体验。希望本文可以帮助您快速上手该包并在您的项目中使用。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6005675781e8991b448e3d30