如果你对照了官方文档,安装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可用作用域。
第一种:作用于方法
第二种:作用于controller
第三种:作用于全局
目前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下)
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()即可