如何在 Nest.js 中定义提供者？

推荐答案

在 Nest.js 中，提供者（Provider）是通过 @Injectable() 装饰器定义的类。提供者可以是服务、存储库、工厂、助手类等。以下是一个简单的示例：

// www.javascriptcn.com code example
import { Injectable } from '@nestjs/common';

@Injectable()
export class CatsService {
  private readonly cats: string[] = [];

  findAll(): string[] {
    return this.cats;
  }

  create(cat: string) {
    this.cats.push(cat);
  }
}

在这个示例中，CatsService 是一个提供者，它被 @Injectable() 装饰器标记为可注入的类。然后，你可以在模块中注册这个提供者：

// www.javascriptcn.com code example
import { Module } from '@nestjs/common';
import { CatsService } from './cats.service';
import { CatsController } from './cats.controller';

@Module({
  controllers: [CatsController],
  providers: [CatsService],
})
export class CatsModule {}

本题详细解读

1. 提供者的定义

在 Nest.js 中，提供者是通过 @Injectable() 装饰器定义的类。这个装饰器告诉 Nest.js 这个类可以被注入到其他类中。提供者通常用于封装业务逻辑、数据访问、工具函数等。

2. 提供者的注册

提供者需要在模块的 providers 数组中注册。这样，Nest.js 的依赖注入系统才能知道如何创建和管理这些提供者的实例。在上面的示例中，CatsService 被注册到 CatsModule 的 providers 数组中。

3. 提供者的注入

一旦提供者被注册，它就可以通过构造函数注入到控制器、其他服务或模块中。例如：

// www.javascriptcn.com code example
import { Controller, Get } from '@nestjs/common';
import { CatsService } from './cats.service';

@Controller('cats')
export class CatsController {
  constructor(private readonly catsService: CatsService) {}

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

在这个示例中，CatsService 被注入到 CatsController 中，控制器可以通过 this.catsService 访问服务的方法。

4. 提供者的生命周期

Nest.js 提供了多种生命周期钩子，允许你在提供者的实例创建、销毁等时刻执行自定义逻辑。例如，你可以使用 OnModuleInit 和 OnModuleDestroy 钩子来执行模块初始化和销毁时的操作。

// www.javascriptcn.com code example
import { Injectable, OnModuleInit, OnModuleDestroy } from '@nestjs/common';

@Injectable()
export class CatsService implements OnModuleInit, OnModuleDestroy {
  onModuleInit() {
    console.log('CatsService initialized');
  }

  onModuleDestroy() {
    console.log('CatsService destroyed');
  }
}

通过这种方式，你可以更好地控制提供者的生命周期。