NestJS 中的使用装饰器

2023-09-13 13:54:04

前言

在上一篇文章：《TypeScript 装饰器的基本语法》中，我分享了如何在 TypeScript 中实现装饰器。只不过在文章中，为了说明简要的说明装饰器的实现语法，里面举的例子都没有具体的功能，只是装饰器的语法示例。本文将详细介绍如何在 NestJS 中使用装饰器，包括如何使用装饰器来实现依赖注入、模块化、服务、控制器、路由、HTTP 请求处理和数据验证等功能。NestJS 是一个流行的 Node.js 框架，它使用 TypeScript 作为编程语言，并提供了许多有用的装饰器来简化开发过程。通过本文，您将能够更好地理解和使用 NestJS 中的装饰器，从而提高开发效率和代码质量。

依赖注入

装饰器在 NestJS 中最常见的使用场景之一就是依赖注入。依赖注入是一种设计模式，它可以帮助我们解耦应用程序中的组件，使它们更加松散耦合和易于维护。在 NestJS 中，我们可以使用 @Injectable() 装饰器来标记一个类，使其可以被其他类注入。例如，以下代码演示了如何使用 @Injectable() 装饰器来标记一个 UserService 类：

import { Injectable } from '@nestjs/common';

@Injectable()
export class UserService {
  findAll() {
    return [];
  }
}

然后，我们可以使用 @Inject() 装饰器来将 UserService 注入到另一个类中。例如，以下代码演示了如何使用 @Inject() 装饰器将 UserService 注入到 UserController 类中：

import { Injectable, Controller, Get, Inject } from '@nestjs/common';
import { UserService } from './user.service';

@Controller('users')
export class UserController {
  constructor(@Inject(UserService) private readonly userService: UserService) {}

  @Get()
  findAll() {
    return this.userService.findAll();
  }
}

模块化

装饰器在 NestJS 中的另一个常见使用场景是模块化。模块化是一种设计模式，它可以帮助我们将应用程序划分为更小的、可重用的单元。在 NestJS 中，我们可以使用 @Module() 装饰器来标记一个类，使其成为一个模块。例如，以下代码演示了如何使用 @Module() 装饰器来创建一个 UserModule 模块：

import { Module } from '@nestjs/common';
import { UserService } from './user.service';
import { UserController } from './user.controller';

@Module({
  providers: [UserService],
  controllers: [UserController],
})
export class UserModule {}

然后，我们可以使用 @Import() 装饰器来将 UserModule 导入到另一个模块中。例如，以下代码演示了如何使用 @Import() 装饰器将 UserModule 导入到 AppModule 模块中：

import { Module, Import } from '@nestjs/common';
import { UserModule } from './user.module';

@Module({
  imports: [UserModule],
})
export class AppModule {}

服务

装饰器在 NestJS 中的另一个常见使用场景是服务。服务是一种设计模式，它可以帮助我们将应用程序中的业务逻辑封装成独立的单元。在 NestJS 中，我们可以使用 @Injectable() 装饰器来标记一个类，使其成为一个服务。例如，以下代码演示了如何使用 @Injectable() 装饰器来创建一个 UserService 类：

import { Injectable } from '@nestjs/common';

@Injectable()
export class UserService {
  findAll() {
    return [];
  }
}

import { Injectable, Controller, Get, Inject } from '@nestjs/common';
import { UserService } from './user.service';

@Controller('users')
export class UserController {
  constructor(@Inject(UserService) private readonly userService: UserService) {}

  @Get()
  findAll() {
    return this.userService.findAll();
  }
}

控制器

装饰器在 NestJS 中的另一个常见使用场景是控制器。控制器是一种设计模式，它可以帮助我们处理 HTTP 请求。在 NestJS 中，我们可以使用 @Controller() 装饰器来标记一个类，使其成为一个控制器。例如，以下代码演示了如何使用 @Controller() 装饰器来创建一个 UserController 类：

import { Controller, Get } from '@nestjs/common';

@Controller('users')
export class UserController {
  @Get()
  findAll() {
    return [];
  }
}

然后，我们可以使用 @Get() 装饰器来标记一个方法，使其成为一个路由。例如，以下代码演示了如何使用 @Get() 装饰器来创建一个 findAll() 路由：

import { Controller, Get } from '@nestjs/common';

@Controller('users')
export class UserController {
  @Get()
  findAll() {
    return [];
  }
}

路由

装饰器在 NestJS 中的另一个常见使用场景是路由。路由是一种设计模式，它可以帮助我们将 HTTP 请求映射到不同的控制器和方法。在 NestJS 中，我们可以使用 @Get()、@Post()、@Put()、@Delete() 等装饰器来标记一个方法，使其成为一个路由。例如，以下代码演示了如何使用 @Get() 装饰器来创建一个 findAll() 路由：

import { Controller, Get } from '@nestjs/common';

@Controller('users')
export class UserController {
  @Get()
  findAll() {
    return [];
  }
}

HTTP 请求处理

装饰器在 NestJS 中的另一个常见使用场景是 HTTP 请求处理。在 NestJS 中，我们可以使用 @Request() 和 @Response() 装饰器来获取和响应 HTTP 请求。例如，以下代码演示了如何使用 @Request() 和 @Response() 装饰器来获取和响应一个 HTTP 请求：

import { Controller, Get, Request, Response } from '@nestjs/common';

@Controller('users')
export class UserController {
  @Get()
  findAll(@Request() req, @Response() res) {
    res.send([]);
  }
}

数据验证

装饰器在 NestJS 中的另一个常见使用场景是数据验证。在 NestJS 中，我们可以使用 @Body()、@Param()、@Query() 等装饰器来验证 HTTP 请求中的数据。例如，以下代码演示了如何使用 @Body() 装饰器来验证 HTTP 请求中的数据：

import { Controller, Get, Body, ValidationPipe } from '@nestjs/common';

@Controller('users')
export class UserController {
  @Get()
  findAll(@Body(new ValidationPipe()) body: any) {
    return [];
  }
}

总结

装饰器是 NestJS 中一种非常强大的工具，它可以帮助我们简化开发过程、提高开发效率和代码质量。本文详细介绍了如何在 NestJS 中使用装饰器，包括如何使用装饰器来实现依赖注入、模块化、服务、控制器、路由、HTTP 请求处理和数据验证等功能。通过本文，您应该能够更好地理解和使用 NestJS 中的装饰器。