解密Nest.js中的装饰器：优雅处理复杂逻辑

引言

Nest.js是一个基于TypeScript的Node.js框架，广泛使用装饰器来简化和增强代码的可读性和可维护性。装饰器是Nest.js核心功能之一，通过它可以优雅地处理复杂逻辑。本篇博客将带你深入了解Nest.js中的装饰器及其实际应用。

什么是装饰器

装饰器是一种特殊的声明，可以附加到类、方法、访问器、属性或参数上，用来修改它们的行为。简单来说，装饰器就像给代码贴上标签，使其具有特定的功能。

举个例子

当单独拿出一瓶黑色的液体给别人喝，一般人都会犹豫。但如果在瓶子外面贴上一张纸，写上"可口可乐"，那么别人就会放心地喝了。装饰器在代码中起到的就是这种标识作用。

代码中的例子

typescript 复制代码

  @Post()
  @ApiOperation({ summary: '添加用户' })
  create(@Body() createUserDto: CreateUserDto) {
    return this.usersService.create(createUserDto);
  }

在上面的代码中：

@Post()装饰器标明create方法是通过POST请求调用的。
@ApiOperation({ summary: '添加用户' })装饰器为这个方法添加了Swagger文档信息。
@Body()装饰器表示createUserDto参数的数据来源于HTTP请求的body部分。

常见的Nest.js装饰器

路由装饰器

@Controller(): 标记一个类为Nest.js控制器。
@Get(): 处理HTTP GET请求。
@Post(): 处理HTTP POST请求。
@Put(): 处理HTTP PUT请求。
@Delete(): 处理HTTP DELETE请求。

参数装饰器

@Body(): 绑定请求体的数据。
@Query(): 绑定查询参数。
@Param(): 绑定路由参数。
@Headers(): 绑定请求头。

其他装饰器

@Injectable(): 标记一个类可以被依赖注入。
@Module(): 定义一个模块，组织和管理代码。

自定义装饰器

除了Nest.js内置的装饰器，我们还可以自定义装饰器。自定义装饰器可以让我们将重复的逻辑提取出来，提高代码的复用性。

typescript 复制代码

import { createParamDecorator, ExecutionContext } from '@nestjs/common';

export const User = createParamDecorator(
  (data: unknown, ctx: ExecutionContext) => {
    const request = ctx.switchToHttp().getRequest();
    return request.user;
  },
);

在上面的例子中，我们创建了一个自定义装饰器@User()，它从请求中提取用户信息。

自定义用户控制器的使用

在src/users/users.controller.ts文件中，我们可以这样使用@User()装饰器：

typescript 复制代码

import { Controller, Get } from '@nestjs/common';
import { User } from '../common/decorators/user.decorator';

@Controller('users')
export class UsersController {
  @Get('profile')
  getProfile(@User() user: any) {
    return user;
  }
}

在上面的代码中，我们在getProfile方法的参数上使用了@User()装饰器。这个装饰器会自动从请求对象中提取用户信息并赋值给user参数。

总结

通过本篇博客，你了解了Nest.js中的装饰器是什么，常见的装饰器有哪些，以及如何自定义装饰器。装饰器在Nest.js中起着至关重要的作用，它们不仅使代码更加简洁和易读，还提高了开发效率和代码复用性。