NestJS gRPC微服务返回空数组字段丢失问题求助

问题原因 #

Protobuf 默认会省略所有等于默认值的字段，空数组（[]）属于 repeated 类型字段的默认值，因此序列化时会被自动忽略，导致客户端接收不到该字段。你之前添加的 loader: { arrays: true } 仅作用于确保有值的数组始终以数组形式返回（而非单个元素或 null），但不会强制序列化空数组这类默认值。

可行解决方案 #

1. 完善gRPC加载器配置，强制序列化默认值 #

在服务端的gRPC配置中，添加 defaults: true 选项，让protobufjs序列化所有默认值字段（包括空数组）：

const app = await NestFactory.createMicroservice<MicroserviceOptions>(
  SubscriptionsModule,
  {
    transport: Transport.GRPC,
    options: {
      url: '0.0.0.0:50052',
      package: protobufPackage,
      protoPath: join(process.cwd(), 'libs/proto/src/subscriptions.proto'),
      loader: {
        arrays: true,
        defaults: true, // 关键：强制序列化默认值
        objects: true,
      },
    },
  },
);

注意：如果你的客户端也是用NestJS调用gRPC，客户端的gRPC配置也需要添加同样的 loader 选项，确保客户端能正确解析包含默认值的字段。

2. 检查并确认Protobuf定义文件 #

确保你的 .proto 文件中，features 字段是 repeated 类型（这是数组字段的正确定义方式）：

syntax = "proto3";

package subscriptions;

message Plan {
  string id = 1;
  string name = 2;
  string key = 3;
  int32 price = 4;
  float yearly_discount_rate = 5 [json_name = "yearlyDiscountRate"];
  int32 trial_days = 6 [json_name = "trialDays"];
  bool is_recommended = 7 [json_name = "isRecommended"];
  bool is_legacy = 8 [json_name = "isLegacy"];
  repeated string features = 9; // 必须是repeated类型
}

如果你用了下划线命名转驼峰，要确保 json_name 映射正确，避免字段名不匹配。

3. 手动兜底处理返回结果（备选方案） #

如果上述配置仍未生效，可以在返回结果前手动检查并补上空数组字段，确保字段始终存在：

async findAll(@Query() request: PaginationQuery) {
  try {
    const res$ = this.svc.getAll(request);
    const { error, ...rest } = await firstValueFrom(res$);
    if (error) {
      throw new BadRequestException(error);
    }
    // 手动补全features字段，确保空数组也会被返回
    return {
      ...rest,
      features: rest.features ?? [],
    };
  } catch (e) {
    this.logger.error(e);
    return new InternalServerErrorException(e);
  }
}

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