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验证等等(小白的想法,如有高效的验证方法请大家留言,我会不定时回来记录和学习各位的指导)。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,542评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,596评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,021评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,682评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,792评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,985评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,107评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,845评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,299评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,441评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,072评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2 350

推荐阅读更多精彩内容

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