Nestjs 新手 之JWT验证之 单模块及多模块复用验证的个人使用记录

勇于尝试新事物是好事,但盲目尝试是真的难顶
没学过ts,开始直接硬刚中文文档,以下是我个人的一些理解

nestjs 的个人理解:

module(@Module()装饰器)在nestjs里是作为一个功能模块的核心,主要是为了更清晰依赖管理而存在:
而一个功能模块有imports, controllers,providers以及exports:
1、imports同样是为了加载当前模块的依赖模块,同时数据库的entity也是在这里引入;entity作为实体类,也就是数据库表结构,常用于表示数据库表的字段或者表示数据载体的详细结构,可以没有,我们可以看作是指定以何种数据结构去跟数据库发生映射关系的class,当模块不需要操作数据库时可不创建此类或者仅用于构建数据结构。

2、controllers则可以加载当前模块相关的控制器(@Controller()装饰器),例如负责路由访问资源的初步处理

3、providers则可以加载当前模块相应的Service服务类(@Injectable()装饰器),Service作为服务提供者,通常作为controller与数据库操作的桥梁,负责提供复杂的业务逻辑

4、exports则可以导出当前模块的依赖,来给另一模块提供访问支持。例如有logService和userService,需要记录追踪用户的一些操作,则需要在用户模块中调用logService来记录用户在当前函数做了何种操作,此时需要通过log的Module来exports导出logService,从user的Module的providers导入logService。

小结:我们可以分别在controllers注册了控制器Controller 和 在providers注册了服务提供者Service作为该模块的业务类,同时在imports指定映射实体类的数据库配置(在将其他模块集成到此模块中时,其他模块是作为此module中import的一员)

JWT 单模块验证

假设一User模块需要
1.引入相关模块(npm或者yarn操作)
2.重写验证策略方法(validate),PS:网上一般给这个类起名为JwtStrategy.ts,名字个人喜欢,对应的上就行
3.于需要验证的User模块的module(UserModel)的import处引入JwtModule模块并进行相关配置(register或者registerAsync),providers处引入重写验证策略方法(validate)的JwtStrategy

@Module({
  imports: [JwtModule.register({
    secret: 'adsfghjkl', // 生成token的key,请自行选择合适的密钥
    signOptions: {
      expiresIn: '1h', // token有效时长
    }
  })],
  providers: [UserService,JwtStrategy],
  controllers: [UserController]
})

4.使用jwt验证,于UserController需要验证的方法使用装饰器启用jwt验证

//使用jwt验证token的端口
  @Post('tokenIn')
  @UseGuards(AuthGuard('jwt'))
  aPost(@Req() req) {
    req.user.sig = 'hahah'
    return req.user;
  }

5.创建token ,于service(UserService)的构造器中添加(vscode自动引入 import { JwtService } from '@nestjs/jwt';),这步相当于给当前类创建私有属性jwtService去引用JwtService

import { JwtService } from '@nestjs/jwt';
import { Injectable } from '@nestjs/common';
@Injectable()
export class UserService {
  constructor(
    private readonly jwtService: JwtService
  ) { }
  async createToken(user) {
    const payload = { username: user.name, password: user.password };
    // 数据库验证查看用户用户名密码是否正确
    // const data = await this.userRepository.findOne({username:user.username, password: user.password})
    // if(!data) {
    // return false // 将返回 401
    // }
    delete user.password;
    return {
      msg: '登录成功',
      data: {
        user: user,
        //得到token
        token: this.jwtService.sign(payload)
      },
    };
  }
}

6.完成,至于怎么在控制器调用服务提供者生成token,请自行编写

多模块复用jwt验证

1.创建公共验证模块Auth(包含controller,service,module)

module

import { AuthController } from './auth.controller';
import { AuthService } from './auth.service';
import { JwtStrategy } from 'src/middlewares/jwt.strategy';
import { JwtModule } from '@nestjs/jwt';
import { PassportModule } from '@nestjs/passport';
import { jwtConstants } from 'src/config/constants';


@Module({
  providers: [AuthService, JwtStrategy],
  controllers: [AuthController],
  imports: [
    PassportModule.register({ defaultStrategy: 'jwt' }),
    JwtModule.register({
    secret: jwtConstants.secret, // 生成token的key
    signOptions: {
      expiresIn: jwtConstants.JWT_EXPIRATION, // 有效时长
    }
  })],
  exports: [AuthService] // 注意这里不可少,应该是表示对外暴露service引用
})

service

import { Injectable } from "@nestjs/common";
import { JwtService } from "@nestjs/jwt";


@Injectable()
export class AuthService {
  constructor(private readonly jwtService: JwtService) {}
  rs;
 public async getToken(payload) {
   return await this.jwtService.sign(payload)
 }
}

controller

import { Controller } from '@nestjs/common';
import { AuthService } from './auth.service';

@Controller('auth')
export class AuthController {
  constructor(private readonly authService: AuthService) {}
}

2、于每个需要jwt验证的模块进行导入

import { Module } from '@nestjs/common';
import { User} from './entities/user.entity';
import { UserController } from './user.controller';
import { UserService } from './user.service';
import { TypeOrmModule } from '@nestjs/typeorm';
import { AuthModule } from '../auth/auth.module';

@Module({
    imports: [TypeOrmModule.forFeature([User]), AuthModule],
    providers: [UserService],
    controllers: [UserController],
    exports: [UserService],
  })
export class UserModule {}
  1. UserService处创建公共验证模块的引用,如果不进行之前的export会报错
@Injectable()
export class UserService {
  constructor(
    @InjectRepository(User)
    private readonly userRepository: Repository<User>,  // 创建数据库引用,非jwt验证内容
    private readonly authService: AuthService, // 创建引用
  ) { }
// 生成token,直接使用公共验证模块里的生成方法
  public async createToken(signedUser: User) {
    const user = new User(signedUser); 
    const userPOJO = JSON.parse(JSON.stringify(user));
    const accessToken = await this.authService.getToken(userPOJO) // 根据用户信息生成token
    return accessToken;
  }

4.完成,JwtStrategy 可直接用单模块的,复用验证仅抽取了公共Jwt配置而已,其它请结合文档补充

注意

1.此文档仅介绍了同一种key下的公用配置,如果需要针对多个模式下不兼容(你的模块分发的token仅能在你的模块下使用,但在我的模块下就不允许通过验证)需要配置模块独有token,如动态注入,创建多个单模块jwt验证等等(小白的想法,如有高效的验证方法请大家留言,我会不定时回来记录和学习各位的指导)。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 背景 在本文中,我将使用Nest.js构建一个CNode。 为什么这篇文章?我喜欢NodeJs,虽然我的NodeJ...
    jiayisheji阅读 11,648评论 3 20
  • 什么是NestJS Nest 是一个渐进的 Node.js 框架,可以在 TypeScript 和 JavaScr...
    强某某阅读 28,119评论 7 17
  • 功能说明:client端使用用户名和用户密码登录,登录成功后server端发送JWT;client在header中...
    louieSun阅读 7,161评论 0 7
  • Providers是Nest中的一个基本概念。许多Nest类可以是Provider,Service、Reposit...
    alfalfaw阅读 1,456评论 0 0
  • 推荐指数: 6.0 书籍主旨关键词:特权、焦点、注意力、语言联想、情景联想 观点: 1.统计学现在叫数据分析,社会...
    Jenaral阅读 5,753评论 0 5