NestJS中实现支持依赖注入的Or Guard问题求助

核心思路是利用Nest的反射元数据传递守卫组合规则，再通过ModuleRef从DI容器中获取带依赖的守卫实例，避免手动实例化导致的依赖注入失败。

步骤1：定义自定义装饰器传递守卫组合条件 #

创建装饰器用来标记路由需要满足的“或”条件组，每个条件组内的守卫需要全部验证通过。

import { SetMetadata } from '@nestjs/common';

// 元数据key，用于后续反射获取
const OR_GUARD_CONDITIONS = 'or_guard_conditions';

// 接收二维数组：子数组代表一组需同时满足的守卫，外层数组代表“或”关系
export const OrGuardConditions = (conditions: Function[][]) => 
  SetMetadata(OR_GUARD_CONDITIONS, conditions);

步骤2：实现支持DI的OrGuard #

通过ModuleRef获取守卫实例（由Nest DI容器负责注入依赖），遍历条件组验证逻辑：

import { CanActivate, ExecutionContext, Injectable, ModuleRef, Reflector } from '@nestjs/common';
import { OR_GUARD_CONDITIONS } from './or-guard.decorator';

@Injectable()
export class OrGuard implements CanActivate {
  constructor(
    private readonly reflector: Reflector,
    private readonly moduleRef: ModuleRef,
  ) {}

  async canActivate(context: ExecutionContext): Promise<boolean> {
    // 从路由/控制器上获取守卫组合条件
    const conditions = this.reflector.get<Function[][]>(
      OR_GUARD_CONDITIONS,
      context.getHandler(),
    );

    if (!conditions?.length) {
      return false;
    }

    // 遍历每个条件组，只要有一组全部通过就返回true
    for (const guardGroup of conditions) {
      let groupPassed = true;
      for (const GuardClass of guardGroup) {
        // 从DI容器获取守卫实例，自动处理依赖注入
        const guardInstance = await this.moduleRef.resolve(GuardClass);
        const passed = await guardInstance.canActivate(context);
        
        if (!passed) {
          groupPassed = false;
          break;
        }
      }
      if (groupPassed) {
        return true;
      }
    }

    // 所有条件组均不满足
    return false;
  }
}

步骤3：在路由上使用组合守卫 #

将OrGuard通过@UseGuards绑定到路由，再用@OrGuardConditions定义验证规则：

import { Controller, Get, UseGuards } from '@nestjs/common';
import { OrGuard } from './or.guard';
import { OrGuardConditions } from './or-guard.decorator';
import { IsAuthentifiedGuard } from './is-authentified.guard';
import { HasRoleGuard } from './has-role.guard';
import { IsSafeGuard } from './is-safe.guard';

@Controller('protected')
export class ProtectedController {
  @Get()
  @UseGuards(OrGuard)
  // 定义两个或条件：1. 同时通过IsAuthentified+HasRole；2. 通过IsSafe
  @OrGuardConditions([
    [IsAuthentifiedGuard, HasRoleGuard],
    [IsSafeGuard],
  ])
  getProtectedData() {
    return { message: '访问已授权' };
  }
}

关键注意事项 #

• 注册守卫为提供者：所有用到的守卫（包括OrGuard）必须在所属模块的providers数组中注册，确保DI容器能识别并创建实例：

  @Module({
    controllers: [ProtectedController],
    providers: [
      OrGuard,
      IsAuthentifiedGuard,
      HasRoleGuard,
      IsSafeGuard,
      // 若HasRoleGuard依赖ConfigService，需确保该服务已在模块/全局注册
    ],
  })
  export class AppModule {}
  

• 守卫自身的元数据处理：如果HasRoleGuard需要额外配置（比如指定角色），可继续使用@SetMetadata，OrGuard会自动调用守卫的canActivate方法，不影响原逻辑：

  @Get()
  @UseGuards(OrGuard)
  @SetMetadata('roles', ['admin']) // 给HasRoleGuard传递角色参数
  @OrGuardConditions([
    [IsAuthentifiedGuard, HasRoleGuard],
    [IsSafeGuard],
  ])
  getAdminData() { /* ... */ }
  

内容的提问来源于stack exchange，提问作者user1073555