Raw body (body thô)

Một trong những use case phổ biến nhất khi cần truy cập raw request body là thực hiện xác thực chữ ký webhook (webhook signature verification). Thông thường, để xác thực chữ ký webhook, bạn cần request body chưa qua serialize (unserialized) để tính toán hash HMAC.

Dùng với Express

Trước tiên, bật tùy chọn này khi tạo Nest Express application:

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

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

Để truy cập raw request body trong controller, Nest cung cấp sẵn interface tiện lợi RawBodyRequest để expose field rawBody trên request: dùng type 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; // trả về một `Buffer`.
  }
}

Đăng ký một parser khác

Mặc định, chỉ có parser json và urlencoded được đăng ký. Nếu muốn đăng ký một parser khác, bạn cần làm điều đó tường minh.

Ví dụ, để đăng ký parser text, bạn có thể dùng đoạn code sau:

app.useBodyParser('text');

Giới hạn kích thước body parser

Nếu application của bạn cần parse body lớn hơn mức mặc định 100kb của Express, dùng cách sau:

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

Phương thức .useBodyParser sẽ tôn trọng tùy chọn rawBody được truyền trong application options.

Dùng với Fastify

Trước tiên, bật tùy chọn này khi tạo Nest Fastify application:

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

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

Để truy cập raw request body trong controller, Nest cung cấp sẵn interface tiện lợi RawBodyRequest để expose field rawBody trên request: dùng type 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; // trả về một `Buffer`.
  }
}

Đăng ký một parser khác

Mặc định, chỉ có parser application/json và application/x-www-form-urlencoded được đăng ký. Nếu muốn đăng ký một parser khác, bạn cần làm điều đó tường minh.

Ví dụ, để đăng ký parser text/plain, bạn có thể dùng đoạn code sau:

app.useBodyParser('text/plain');

Giới hạn kích thước body parser

Nếu application của bạn cần parse body lớn hơn mức mặc định 1MiB của Fastify, dùng cách sau:

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

Phương thức .useBodyParser sẽ tôn trọng tùy chọn rawBody được truyền trong application options.