Nest.js 中如何使用 @Body 装饰器？-JavaScript中文网-JavaScript教程资源分享门户

推荐答案

在 Nest.js 中，@Body 装饰器用于从 HTTP 请求的 body 中提取数据。它通常用于 POST、PUT 或 PATCH 请求中，以获取客户端发送的 JSON 数据。

// www.javascriptcn.com code example
import { Controller, Post, Body } from '@nestjs/common';

@Controller('users')
export class UsersController {
  @Post()
  createUser(@Body() userData: any) {
    // userData 包含了客户端发送的 JSON 数据
    return `User created with data: ${JSON.stringify(userData)}`;
  }
}

在这个例子中，@Body() 装饰器将请求体中的数据提取并赋值给 userData 参数。userData 的类型可以是 any，但通常我们会定义一个 DTO（Data Transfer Object）类来明确数据的结构。

本题详细解读

1. `@Body` 装饰器的作用

@Body 装饰器用于从 HTTP 请求的 body 中提取数据。它通常用于处理 POST、PUT 或 PATCH 请求，因为这些请求通常会携带 JSON 或其他格式的数据。

2. 使用 `@Body` 装饰器的场景

POST 请求：创建新资源时，客户端通常会发送 JSON 数据到服务器。
PUT 请求：更新现有资源时，客户端会发送包含更新信息的 JSON 数据。
PATCH 请求：部分更新资源时，客户端会发送包含部分更新信息的 JSON 数据。

3. 使用 DTO 类

为了确保类型安全和代码的可维护性，通常会定义一个 DTO 类来描述请求体的数据结构。

// www.javascriptcn.com code example
import { IsString, IsEmail } from 'class-validator';

export class CreateUserDto {
  @IsString()
  name: string;

  @IsEmail()
  email: string;
}

然后在控制器中使用这个 DTO 类：

// www.javascriptcn.com code example
import { Controller, Post, Body } from '@nestjs/common';
import { CreateUserDto } from './dto/create-user.dto';

@Controller('users')
export class UsersController {
  @Post()
  createUser(@Body() userData: CreateUserDto) {
    // userData 现在是一个 CreateUserDto 实例
    return `User created with data: ${JSON.stringify(userData)}`;
  }
}

4. 验证请求体数据

Nest.js 支持使用 class-validator 和 class-transformer 对请求体数据进行验证。通过在 DTO 类中使用装饰器，可以确保传入的数据符合预期。

// www.javascriptcn.com code example
import { Controller, Post, Body, BadRequestException } from '@nestjs/common';
import { CreateUserDto } from './dto/create-user.dto';
import { validate } from 'class-validator';

@Controller('users')
export class UsersController {
  @Post()
  async createUser(@Body() userData: CreateUserDto) {
    const errors = await validate(userData);
    if (errors.length > 0) {
      throw new BadRequestException('Validation failed');
    }
    return `User created with data: ${JSON.stringify(userData)}`;
  }
}

5. 总结

@Body 装饰器是 Nest.js 中处理请求体数据的核心工具之一。通过结合 DTO 类和验证库，可以确保请求数据的类型安全和有效性。

Nest.js 中如何使用 @Body 装饰器？