Nest 守卫

守卫 (Guards) 用于对 Nest 应用中的路由进行验证的。守卫根据运行时出现的某些条件 (例如权限，角色，访问控制列表等) 来确定给定的请求是否由路由处理程序处理。

创建守卫

使用如下命令可以快速创建一个守卫。

nest generate guard <GUARD_NAME>

<GUARD_NAME> 可以是文件路径，例如 guards/auth。

这里我们创建一个 AuthGuard 守卫。

nest generate guard guards/auth

此时会在 src/guards/auth 下创建一个 auth.guard.ts 文件和一个 auth.guard.spec.ts 文件。

auth.guard.ts 文件内容如下。

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

@Injectable()
export class AuthGuard implements CanActivate {
    canActivate(
        context: ExecutionContext
    ): boolean | Promise<boolean> | Observable<boolean> {
        return true
    }
}

从上面的代码可以看出，AuthGuard 类使用了 @Injectable() 装饰器，该类实现了 CanActivate 接口，并实现了 canActivate() 方法，该方法接收一个 context:ExecutionContext 参数。

canActivate() 方法可以是同步的，也可以是异步的，返回值可以是布尔值，也可以是 Promise<boolean>，也可以是 Observable<boolean>，如果要验证通过，则必须返回 true。

使用守卫

修改 auth.guard.ts 文件，以异步的方式返回 false。

import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common'
import { delay, Observable, of } from 'rxjs'

@Injectable()
export class AuthGuard implements CanActivate {
    canActivate(
        context: ExecutionContext
    ): boolean | Promise<boolean> | Observable<boolean> {
        return of(false).pipe(delay(2000))
    }
}

创建 TodoModule 和 TodoController。

nest generate module features/todo
nest generate controller features/todo

可以使用 @UseGuards() 装饰器来使用守卫。它可以装饰在控制器类上，也可以装饰在控制器方法上。这里以 todo.controller.ts 为例。

import { Controller, Get, UseGuards } from '@nestjs/common'
import { AuthGuard } from 'src/guards/auth/auth.guard'

@Controller('todos')
@UseGuards(AuthGuard)
export class TodoController {
    @Get()
    getAll() {
        return []
    }
}

当我们访问 http://localhost:3000/todos 时，发现返回了 403 Forbidden 状态码，表示没有权限访问该资源。

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

全局守卫

在 main.ts 中，我们可以通过 app.useGlobalGuards() 方法来全局使用守卫。

import { NestFactory } from '@nestjs/core'
import { AppModule } from './app.module'
import { AuthGuard } from './guards/auth/auth.guard'

async function bootstrap() {
    const app = await NestFactory.create(AppModule)
    app.useGlobalGuards(new AuthGuard())
    await app.listen(process.env.PORT ?? 3000)
}
bootstrap()

也可以通过依赖注入的方式在 AppModule 中全局使用守卫。

import { Module } from '@nestjs/common'
import { APP_GUARD } from '@nestjs/core'
import { AppController } from './app.controller'
import { AppService } from './app.service'
import { TodoModule } from './features/todo/todo.module'
import { AuthGuard } from './guards/auth/auth.guard'

@Module({
    imports: [TodoModule],
    controllers: [AppController],
    providers: [
        AppService,
        {
            provide: APP_GUARD,
            useClass: AuthGuard
        }
    ]
})
export class AppModule {}