原始请求体

    访问原始请求体最常见的用例之一是执行 Webhook 签名验证。通常，要执行 Webhook 签名验证，需要使用未反序列化的请求体来计算 HMAC 哈希。

    warning 警告 此功能仅在启用内置的全局请求体解析中间件时才能使用，即创建应用程序时不能传入 bodyParser: false。

    与 Express 一起使用

    首先，在创建 Nest Express 应用程序时启用该选项：

    import { NestFactory } from '@nestjs/core';
import type { NestExpressApplication } from '@nestjs/platform-express';
import { AppModule } from './app.module.js';

// in the "bootstrap" function
const app = await NestFactory.create<NestExpressApplication>(AppModule, {
  rawBody: true,
});
await app.listen(process.env.PORT ?? 3000);

    要在控制器中访问原始请求体，提供了一个便捷接口 RawBodyRequest，用于在请求上暴露 rawBody 字段：使用接口 RawBodyRequest 类型：

    import { Controller, Post, RawBodyRequest, Req } from '@nestjs/common';
import { Request } from 'express';

@Controller('cats')
class CatsController {
  @Post()
  create(@Req() req: RawBodyRequest<Request>) {
    const raw = req.rawBody; // returns a `Buffer`.
  }
}

    注册不同的解析器

    默认情况下，仅注册了 json 和 urlencoded 解析器。如果您想动态注册不同的解析器，则需要显式地进行注册。

    例如，要注册一个 text 解析器，可以使用以下代码：

    app.useBodyParser('text');

    warning 警告 确保您为 NestFactory.create 调用提供了正确的应用程序类型。对于 Express 应用程序，正确的类型是 NestExpressApplication。否则将找不到 .useBodyParser 方法。

    请求体解析器大小限制

    如果您的应用程序需要解析大于 Express 默认 100kb 的请求体，请使用以下配置：

    app.useBodyParser('json', { limit: '10mb' });

    .useBodyParser 方法将遵循在应用程序选项中传入的 rawBody 选项。

    与 Fastify 一起使用

    首先，在创建 Nest Fastify 应用程序时启用该选项：

    import { NestFactory } from '@nestjs/core';
import {
  FastifyAdapter,
  NestFastifyApplication,
} from '@nestjs/platform-fastify';
import { AppModule } from './app.module.js';

// in the "bootstrap" function
const app = await NestFactory.create<NestFastifyApplication>(
  AppModule,
  new FastifyAdapter(),
  {
    rawBody: true,
  },
);
await app.listen(process.env.PORT ?? 3000);

    要在控制器中访问原始请求体，提供了一个便捷接口 RawBodyRequest，用于在请求上暴露 rawBody 字段：使用接口 RawBodyRequest 类型：

    import { Controller, Post, RawBodyRequest, Req } from '@nestjs/common';
import { FastifyRequest } from 'fastify';

@Controller('cats')
class CatsController {
  @Post()
  create(@Req() req: RawBodyRequest<FastifyRequest>) {
    const raw = req.rawBody; // returns a `Buffer`.
  }
}

    注册不同的解析器

    默认情况下，仅注册了 application/json 和 application/x-www-form-urlencoded 解析器。如果您想动态注册不同的解析器，则需要显式地进行注册。

    例如，要注册一个 text/plain 解析器，可以使用以下代码：

    app.useBodyParser('text/plain');

    warning 警告 确保您为 NestFactory.create 调用提供了正确的应用程序类型。对于 Fastify 应用程序，正确的类型是 NestFastifyApplication。否则将找不到 .useBodyParser 方法。

    请求体解析器大小限制

    如果您的应用程序需要解析大于 Fastify 默认 1MiB 的请求体，请使用以下配置：

    const bodyLimit = 10_485_760; // 10MiB
app.useBodyParser('application/json', { bodyLimit });

    .useBodyParser 方法将遵循在应用程序选项中传入的 rawBody 选项。