如何在Nest.js中使用自定义Guard及兼容jwt情况下无需专门每个文件配置Guard

如果你对照了官方文档,安装JWT认证的话,你的controller可能类似于这样

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

//  获取token(使用local策略)
  @UseGuards(LocalAuthGuard)
  @Post('access-token')
  async login(@Request() req) {
    return this.authService.login(req.user);
  }
//  解析token获取user信息(使用Jwt策略)
  @UseGuards(JwtAuthGuard)
  @Get('user')
  getProfile(@Request() req) {
    return this.helper.getUser();   //  文档上是 return this.request.user 我做了个封装
  }
}

看上去很美好,带上用户信息请求access-token就可以获取到access_token,不带上token请求user接口就会401,但是有一个问题,要是这个项目有很多接口/方法,都要进行jwt验证,难道要一个一个的@UseGuards(JwtStrategy)去写吗,那多麻烦啊,还让代码变得丑陋,我们为什么不配置一个默认的Guard,再需要不认证的时候单独指定呢?
先来看看nest.js官方提供的Guard可用作用域。

第一种:作用于方法

如何在Nest.js中使用自定义Guard及兼容jwt情况下无需专门每个文件配置Guard

第二种:作用于controller
如何在Nest.js中使用自定义Guard及兼容jwt情况下无需专门每个文件配置Guard

第三种:作用于全局
如何在Nest.js中使用自定义Guard及兼容jwt情况下无需专门每个文件配置Guard

目前Nest只提供以上三种作用于,如果你项目较大,接口较多,使用第一种和第二种岂不是要写非常多的@UseGuards(xxxxx),如果使用全局的话,那我的获取Token的access-token接口也会凉掉。
我目前在进行的项目有十五个模块,一个一个写我可不愿意。于是我准备自己实现一个上层Guard,来对不同的请求进行不同的策略分配

第一步:创建一个自定义的上层Guard
auth.guard.ts

import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';
import { Observable } from 'rxjs';
import { Reflector } from '@nestjs/core';

@Injectable()
//  自定义Guard必须实现canActivate方法
export class AuthGuard implements CanActivate {
  constructor(private readonly reflector: Reflector) {}
  canActivate(context: ExecutionContext): boolean | Promise<boolean> | Observable<boolean> {
  }

}

第二步:创建一个不需要认证(NoAuth)的标识位,让部分接口不需要进行jwt的验证
我在这里选择创建一个装饰器,使用SetMetadata()方法设置一个bool值,用于告诉这个RoleAuthGuard,他不需要进行jwt的策略认证(我将它放在common下)

如何在Nest.js中使用自定义Guard及兼容jwt情况下无需专门每个文件配置Guard
import { SetMetadata } from '@nestjs/common'

export const NoAuth = () => SetMetadata('no-auth', true);

第三步:返回完善RoleAuthGuard

import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';
import { Observable } from 'rxjs';
import { Reflector } from '@nestjs/core';
import { AuthGuard, IAuthGuard } from '@nestjs/passport';

@Injectable()
export class RoleAuthGuard implements CanActivate {
  constructor(private readonly reflector: Reflector) {}
  canActivate(context: ExecutionContext): boolean | Promise<boolean> | Observable<boolean> {
  //    在这里取metadata中的no-auth,得到的会是一个bool
    const noAuth = this.reflector.get<boolean>('no-auth', context.getHandler());
    const guard = RoleAuthGuard.getAuthGuard(noAuth);
    return guard.canActivate(context);  //  执行所选策略Guard的canActivate方法
  }

//  根据NoAuth的t/f选择合适的策略Guard
  private static getAuthGuard(noAuth: boolean): IAuthGuard {
    if (noAuth) {
      return new (AuthGuard('local'))();
    } else {
      return new (AuthGuard('jwt'))();
    }
  }
}

第四步:设置这个Guard为全局使用

import { APP_FILTER, APP_GUARD } from '@nestjs/core';
import { AllExceptionsFilter } from '@/all-exception.filter';
import { RoleAuthGuard } from '@/auth/guards/role-auth.guard';
@Module({
  imports: [...],
  providers: [
  //    此为过滤全局异常,可以忽略
    {
      provide: APP_FILTER,
      useClass: AllExceptionsFilter,
    },
    //  设置全局守卫,useClass为自定义的Guard
    {
      provide: APP_GUARD,
      useClass: RoleAuthGuard,
    },
    ...
  ],
})
export class AppModule {}

最后,使用Postman进行测试,默认会使用Jwt策略,在不需要认证的位置加上@NoAuth()即可

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