nestJs 高阶用法

news2024/11/28 0:53:23

真正的服务器需要做全局的数据核查、敏感操作落库和数据转化。

拥有这些能力才能让后台能力更加丰富，本篇将主要使用 NestJs 的高级能力，来实现这些功能。

使用 guards 和 decorators 实现数据校验核查
通过 interceptors 和 decorators 实现敏感操作录入
自定义 pipes 实现数据转化

守卫 Guards

在 请求到达业务逻辑前 会经过 guard，这样在接口前可以做统一处理。

例如：检查登陆态、检查权限 ...

需要在业务逻辑前 统一检查 的信息，都可以抽象成守卫。

在真实场景中，大多数的后台管理端会用 JWT 实现接口鉴权。NestJs 也提供了对应的解决方案。

由于较长且原理相通，本篇暂时用校验 user 字段做演示。

新建守卫

新建 user.guard.ts 文件

// src/common/guards/user.guard.ts
import { Injectable, CanActivate, ExecutionContext, UnauthorizedException } from '@nestjs/common';
import { Observable } from 'rxjs';

@Injectable()
export class UserGuard implements CanActivate {
  canActivate(
    context: ExecutionContext,
  ): boolean | Promise<boolean> | Observable<boolean> {
    const request = context.switchToHttp().getRequest();
    const user = request.body.user;

    if (user) {
        return true;
    }

    throw new UnauthorizedException('need user field');
  }
}

单个接口使用守卫

单个接口使用需要用 @UseGuards 作为引用。再将定义的 UserGuard 作为入参。

在 student.controller.ts 中使用

全局使用

全局使用仅需在 app.module.ts 的 providers 中引入。这样就对全局生效了

自定义装饰器过滤

总有些接口我们不需要有 user 字段，这时自定义 decorator 就出马了。

基本原理是：在接口前设置 MetaData, 在服务启动时把 MetaData 写入内存，这样在请求过来时判断有无 MetaData 标签。有则通过，无则校验。

顺便也将 get 请求类型过滤掉。

NoUser 使用

再调用时，就不会再校验了。

这样就实现了全局守卫，但是部分接口不需要守卫的情况。

特别适用于登录态的校验，只有登陆接口不需要登录态，其他接口都需要登陆态或鉴权。

拦截器 Interceptors

拦截器工作在 请求前 和 响应后。它的原理和 decorator 类似，不同的是能做全局级别。

它的应用场景也非常广，例如：接口请求参数和请求结果的数据保存、设计模式中的 adapter 模式等...

我们来用它实现敏感信息的数据保存。

它的原理和 guards 类似, 通过 decorator 加载到内存，知道哪些接口需要敏感操作记录，然后在调用接口时将入参和结果存入。

涉及到数据库操作，因此需要新增模块和数据库连接。

新建敏感权限模块

新建敏感权限模块，包括 controller、module 和 service

nest g controller sensitive
nest g module sensitive
nest g service sensitive

创建 entity 文件

新建 sensitive.entity.ts 。

这里会用到 transformer, 原因是 mysql 底层并没有 Object 类型。需要通过 JS 把它存成 string 格式，在读取时用 object 格式。这样代码就不需要感知是啥类型了。

引用数据库

和之前介绍数据库一样，在 sensitive.module.ts 中引入数据库

service 核心逻辑

敏感操作比较简单，service 仅需实现新增和查询。

先定义敏感操作类型

// src/sensitive/constants.ts
export enum SensitiveType {
    Modify = 'Modify',
    Set = 'Set',
    Create = 'Create',
    Delete = 'Delete',
}

在修改 service，引入db操作

controller 修改

controller 比较简单，只需要简单的查询即可。敏感信息写入则是通过 decorator + interceptor 来实现

新增装饰器

装饰器的用场来了，只需要告诉某个接口需要敏感操作记录，并指定类型即可。

通过传参的方式，定义敏感操作的类型。在数据库中可以分类，通过索引的方式查找修改入参和结果。

拦截器

重点来了！！

和守卫权限校验类似，通过 reflector 取出内存中的 sensitive-operation 类型。

新建 src/common/interceptors/sensitive.interceptor.ts

并在 app.module.ts 中引入全局。

其他模块引用

student 模块引入

仅需要在接口前引入 @SensitiveOperation(SensitiveType.Set) 即可！是不是非常优美。

在不影响原有业务逻辑的情况下，仅是在接口处做标识的简单调用。实现了 AOP 的调用方式。对老代码的改造和新业务的编写都十分有用。

管道 Pipes

NestJs Pipes 的概念和 linux shell 的概念非常相似，都是通过前者的输出再做一些事情。

它的应用场景也非常广，例如：数据转化，数据校验等...

对数据输入时的操作非常有用。对复杂数据校验，例如表单数据等十分有用。

我们没有复杂输入，我们来使用简单的数据转化，实现在名字前加上🇨🇳

新建 Pipes

新建 src/common/pipes/name.pipes.ts。

// src/common/pipes/name.pipes.ts
import { PipeTransform, Injectable, ArgumentMetadata } from '@nestjs/common';

@Injectable()
export class TransformNamePipe implements PipeTransform {
  transform(name: string, metadata: ArgumentMetadata) {
    return `🇨🇳 ${name.trim()}`;
  }
}

和其他 NestJs 一样，都需要重载一边内置对象。Pipes 也需要重载 PipeTransform。