NestJS gRPC 请求参数验证

Question

我正在尝试对发送到使用 NestJS 构建的 gRPC 服务的请求进行参数验证，这就是我的示例方法的样子：

@GrpcMethod('Service', 'Method')
methodName(request: Request, _metadata: Metadata, call: ServerWritableStreamImpl<Request, Observable<Response>>) {
    ...
}

我们使用 proto 文件来定义请求和响应接口。

如何验证请求参数并返回/抛出异常，例如BAD_REQUEST 代码？

到目前为止我已经尝试过：

• 根据请求使用 @Body / @Payload 装饰器和类验证器包来添加像 @IsNotEmpty() 或 @IsEnum() 这样的装饰器 - 不起作用，我们失去了对调用对象的控制（它是未定义的），因为我想，现在这个请求被视为普通的 HTTP 请求，而不是像 gRPC 调用
• 使用 class-validator 包中的 ValidationSchema (https://github.com/typestack/class-validator#defining-validation-schema-without-decorators)，但它已经损坏了一段时间 (https://github.com /typestack/类验证器/问题/595）

Answer 1

您可以创建自定义装饰器来使用

class-validator

和 DTO 验证输入参数。尝试一下：

import * as grpc from '@grpc/grpc-js';
import { RpcException } from '@nestjs/microservices';
import { plainToInstance } from 'class-transformer';
import { validate } from 'class-validator';

export function ValidateGrpcInput(dtoClass: any) {
  return function (
    target: any,
    methodName: string,
    descriptor: PropertyDescriptor,
  ) {
    const originalMethod = descriptor.value;

    descriptor.value = async function (...args: any[]) {
      const [data] = args;
      const object = plainToInstance(dtoClass, data);
      const errors = await validate(object);

      if (errors.length > 0) {
        throw new RpcException({
          code: grpc.status.INVALID_ARGUMENT,
          message: 'Input data validation failed',
        });
      }

      return originalMethod.apply(this, args);
    };
  };
}

然后在你的 grpc 控制器中使用这个装饰器，如下所示：

@GrpcMethod('UserService', 'getUser')
@ValidateGrpcInput(GetUserRequestDto)
async getUser(data: GetUserRequestDto): Promise<UserEntity> {
  /* Your controller logic here */
}