NestJS JWT 常见问题解决方案

NestJS JWT 常见问题解决方案

jwt JWT utilities module based on the jsonwebtoken package 🔓 项目地址: https://gitcode.com/gh_mirrors/jwt5/jwt

1. 项目基础介绍和主要编程语言

NestJS JWT 是一个基于 JSON Web Tokens (JWT) 的 NestJS 实用工具模块，它基于 jsonwebtoken 包开发。该模块主要用于在 NestJS 应用中处理 JWT 的生成和验证，是构建高效且可扩展的服务器端应用程序的重要工具。主要编程语言为 TypeScript。

2. 新手使用时需要注意的三个问题及解决步骤

问题一：如何安装和引入 JWT 模块

问题描述： 新手在开始使用 NestJS JWT 时，可能会不知道如何安装和引入 JWT 模块。

解决步骤：

1. 使用 npm 或 yarn 安装 JWT 模块：

   npm i --save @nestjs/jwt
   # 或者
   yarn add @nestjs/jwt
   

2. 在你的模块文件中引入 JwtModule：

   import { JwtModule } from '@nestjs/jwt';
   
   @Module({
     imports: [
       JwtModule.register({
         secret: 'your-secret-key', // 替换为你的密钥
         signOptions: { expiresIn: '60s' }, // 设置 Token 过期时间
       }),
     ],
     providers: [],
   })
   export class AppModule {}
   

问题二：如何注入 JwtService

问题描述： 新手可能会不清楚如何在服务中注入 JwtService 以生成和验证 JWT。

**。

解决步骤：

1. 在你的服务中引入 JwtService：

   import { JwtService } from '@nestjs/jwt';
   
   @Injectable()
   export class AuthService {
     constructor(private readonly jwtService: JwtService) {}
   
     // 使用 jwtService 生成 JWT
     generateToken(user: User) {
       return this.jwtService.sign(user);
     }
   
     // 使用 jwtService 验证 JWT
     validateToken(token: string) {
       return this.jwtService.verify(token);
     }
   }
   

问题三：如何处理 Token 过期

问题描述： 新手可能会遇到 Token 过期的问题，不知道如何处理。

解决步骤：

1. 设置合适的 Token 过期时间，在生成 Token 时使用 signOptions：

   JwtModule.register({
     secret: 'your-secret-key',
     signOptions: { expiresIn: '60s' }, // 例如设置 Token 有效期为 60 秒
   }),
   

2. 当验证 Token 时，捕获可能的 TokenExpiredError 错误，并根据业务需求处理过期情况：

   import { JwtService } from '@nestjs/jwt';
   import { HttpException, Injectable } from '@nestjs/common';
   import { TokenExpiredError } from 'jsonwebtoken';
   
   @Injectable()
   export class AuthService {
     constructor(private readonly jwtService: JwtService) {}
   
     validateToken(token: string) {
       try {
         const decoded = this.jwtService.verify(token);
         return decoded;
       } catch (error) {
         if (error instanceof TokenExpiredError) {
           // 处理 Token 过期
           throw new HttpException('Token 已过期，请重新登录。', 401);
         } else {
           // 处理其他类型的错误
           throw new HttpException('无效的 Token。', 401);
         }
       }
     }
   }
   

jwt JWT utilities module based on the jsonwebtoken package 🔓 项目地址: https://gitcode.com/gh_mirrors/jwt5/jwt