栈记
Nest

守卫 guard

CanActivate 守卫与执行时机

说明

守卫是一个可以被注入的类,该类实现了 CanActive 的接口;

守卫会在所有的中间件之后,任何拦截器和管道之前执行,守卫抛出的异常会被 Exception Filter 接管

最常用的场景包括授权、权限、角色等操作;它的返回值应该是一个 boolean 可以是 Promise,Observable 的类型。

定义守卫

import { Injectable, CanActive, ExecutionContext } from '@nestjs/common';
import { Request } from 'express';

@Injectable()
export class AuthGuard implements CanActive {
  canActive(context: ExecutionContext): boolean {
    // 获取 request 
    // context 还有一些其他的方法 比如:与异常中的 ArgumentHost 差不多
    // getType
    // swithToRpc
    const req = context.switchToHttp().getRequest<Request>();

    return req.headers.authorization !== undefined;
  }
}

使用守卫

使用守卫的方式有三种,在类 Controller、在全局、在 AppModule 中。

// main.ts 全局的守卫不会为网关和微服务设置守卫
const app = await NestFactory.create(AppModule);
app.useGlobalGuards(new RolesGuard());

// app.module.ts 如果既想要全局又不想影响微服务可以放在 AppModule 中
import { APP_GUARD } from '@nestjs/core';

@Module({
  imports: [UsersModule],
  // 使用此种方案 useClass 并不是唯一的选择,也可以考虑通过 factory 去再次注入一些依赖的内容
  providers: [{ provide: APP_GUARD, useClass: AuthGuard }],
})
export class AppModule {}

// users.controller.ts
import { Controller, Get, UseGuards } from '@nestjs/common';

@Controller()
// 在 controller 则控制整个 controller
@UseGuards(AuthGuard)
export class UsersController {

  @Get()
  // 控制具体的方法
  @UseGruards(AuthGuard)
  findAll() {}
}

具有权限的守卫 demo

开始之前在了解一个元数据获取的方案,Reflector 该内容来自 @nestjs/core 中,实际上可以理解为 reflect-metadata 包的二次封装即可。

import { Reflector } from '@nestjs/core';

// 创建一个容器装饰器
const Roles = Reflector.createDecorator<string[]>();

// 从 controller 中获取对应的 roles
const roles = this.reflector.get(Roles, context.getClass());
// 从 controller 和对应的方法中获取信息,只获取一个 getHandler || getClass  对,就是这个表达式的逻辑
const roles = this.reflector.getAllAndOverride(Roles, [context.getHandler(), context.getClass()]);
// 从 controller 和对应的方法中获取信息,会被合并
const roles = this.reflector.getAllAndMerge(Roles, [context.getHandler(), context.getClass()]);

在 roles.decorator.ts 创建一个存储角色的地方 在 controller 中使用这个装饰器并且传入角色 在 roles.guard.ts 拿到上下文中的权限信息并且校验

// roles.decorator.ts
import { Reflector } from '@nestjs/core';

const Roles = Reflector.createDecorator<string[]>();

// users.controller.ts
import { Controller, Get } from '@nestjs/common';
import { Roles } from './roles.decorator.ts'

@Controller('users')
@Roles(['user'])
export class UsersController {
  @Get()
  @Roles(['admin'])
  findAll() {}
}

// roles.guard.ts
import { Injectable, CanActive, ExecutionContext } from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { Roles } from './roles.decorator.ts'

@Injectable()
export class RolesGuard implements CanActive {
  constructor(private reflector: Reflector) {}

  canActive(context: ExecutionContext) {
    const roles = this.reflector.get(Roles, context.getHandler());

    // roles 不存在说明不需要鉴权
    if (!roles) {
      return true;
    }

    // TODO 解析 token 获取到用户然后再解析用户的解决,判定是否通过校验
    const req = context.switchToHttp().getRequest<Request>();
    const token = req.headers.authorization;
    return token !== undefined;
  }
}

On this page