egg-jwt 使用指南

egg-jwt 使用指南

egg-jwtJWT authentication plugin for egg项目地址:https://gitcode.com/gh_mirrors/eg/egg-jwt

项目介绍

egg-jwt 是为 Egg.js 平台设计的 JSON Web Token（JWT）认证插件。它提供了简单而强大的方法来实现基于 JWT 的身份验证机制，使得在构建安全的 Node.js 应用程序时，可以轻松地管理用户的会话状态，无需依赖服务器的 session 存储。通过这一插件，开发者能够方便地签发、验证和刷新JWT，确保应用程序的访问控制更加灵活且高效。

项目快速启动

安装

首先，你需要安装 egg-jwt 到你的 Egg.js 项目中。可以通过以下命令完成：

npm install egg-jwt --save

或者如果你更喜欢 Yarn：

yarn add egg-jwt

配置

接着，在你的 Egg.js 应用的配置文件中启用并配置该插件。在 config/plugin.js 添加如下行以启用插件：

exports.jwt = {
  enable: true,
  package: 'egg-jwt',
};

然后，在 config/config.default.js 或相应的环境配置文件中设置密钥：

exports.jwt = {
  secret: 'your-secret-key', // 自定义签名秘钥
};

使用示例

在需要生成JWT的地方，例如登录成功后：

const token = ctx.app.jwt.sign({ userId: user.id }, ctx.app.config.jwt.secret);

而在需要验证JWT的控制器或中间件中：

try {
  const decoded = ctx.app.jwt.verify(ctx.header.authorization.split(' ')[1], ctx.app.config.jwt.secret);
} catch (err) {
  // 错误处理逻辑
}

应用案例和最佳实践

• 中间件封装: 将JWT验证逻辑封装成一个中间件，统一应用于需要权限验证的路由。

  module.exports = () => {
    return async function jwtMiddleware(ctx, next) {
      const token = ctx.request.header['authorization'].split(' ')[1];
      try {
        await ctx.app.jwt.verify(token, ctx.app.config.jwt.secret);
        await next();
      } catch (error) {
        ctx.status = 401;
        ctx.body = { error: 'Unauthorized' };
      }
    };
  };
  

• 刷新Token: 实现刷新JWT机制，保持用户长时间在线而不必频繁登录。

典型生态项目

虽然该指引专注于 egg-jwt 的基本使用，但在实际开发中，你可能会结合其他 Egg.js 生态中的工具和库，比如使用 egg-session 进行非敏感数据的本地缓存，或者结合 egg-cors 保证跨域请求的安全性。此外，对于前端与JWT的交互，常用的是在Ajax请求头中携带JWT令牌，确保API安全通信。

记住，整合JWT到你的应用只是安全性的一部分，最佳的安全策略还包括数据加密、输入验证、防止CSRF攻击等多方面措施。

---

以上是关于如何使用 egg-jwt 的简要指南，希望能够帮助你在Egg.js项目中顺利实施JWT认证。实践中，请根据具体需求调整和扩展这些基础配置和实践。

egg-jwtJWT authentication plugin for egg项目地址:https://gitcode.com/gh_mirrors/eg/egg-jwt