提供者 Provider & 模块 Module
依赖注入、Provider 注册与模块组织
说明
准确的说所有带有 Injectable 装饰器的类都可以被称为 provider 提供者;
包括后面会提到的 Guard 守卫、Interceptor 拦截器、Pipe 管道等。
凡是带有 Injectable 标识是由 Nest IOC 容器管理的类。
IOC 全名 Inversion of Control 控制反转,面相对象的一种设计思想,用于解决组件之间过渡耦合的问题;是前面提到的 DI 的一种实现方式;
Service 服务
Service 服务是 Nest 中最常见的 provider 提供者,用于处理业务逻辑、数据访问等功能。
import { Injectable } from '@nestjs/common';
@Injectable()
export class UsersService {
findAll() {
return 'this action returns all users';
}
findOne(id: number) {
return `this action returns a #${id} user`;
}
}在 module 中注册 Service 服务;在 controller 中通过构造函数注入 Service 服务。
// users.module.ts
import { Module } from '@nestjs/common';
import { UsersController } from './users.controller';
import { UsersService } from './users.service';
@Module({
controllers: [UsersController],
providers: [UsersService],
})
export class UsersModule {}
// users.controller.ts
import { Controller, Get } from '@nestjs/common';
import { UsersService } from './users.service';
@Controller('users')
export class UsersController {
// 将 UsersService 注入到 UsersController 中,后续则可以通过 this.usersService 直接调用内部方法。
constructor(private readonly usersService: UsersService) {}
}非 class 的 provider 提供者
实际开发中避免不了一些并不是通过 class 定义的实现;此种场景也可以通过其他的方式注册到 Nest IOC 容器中;
import { Module } from '@nestjs/common';
export const CONFIG = {
host: 'localhost',
port: 3306,
password: 'password',
};
@Module({
providers: [
{
provide: 'CONFIG',
useValue: CONFIG,
}
]
})
export class DatabaseModule {}
// 通过 @Inject() 装饰器注入 CONFIG
import { Controller, Get, Inject } from '@nestjs/common';
@Controller('database')
export class DatabaseController {
constructor(@Inject('CONFIG') private readonly config) {}
}Module 模块
说明
上述配置中除了 useValue 以外还可以使用 useFactory、useClass 等方式注册 provider 提供者;
module 是 Nest 中组织和管理应用的重要组成,使用 @Module()。 上述内容也提供了一些简单的示例。
继续上面的例子,看 useClass 、 useFactory 的场景及用途;
provider 中的 useClass useFactory useValue
useValue 使用与一些配置项的注入,上面已经提到;
useClass 则可以通过一些判定或者一些特定的逻辑来决定注入哪个类;
import { Module } from '@nestjs/common';
@Module({
providers: [
{
provide: ConfigService,
useClass: process.env.NODE_ENV === 'production' ? DevelopmentConfigService : ProductionConfigService,
}
]
})
export class ConfigModule {}useFactory 则可以通过工厂函数的方式来创建 provider 提供者;也可以注入其他的 provider 提供者;
import { Module } from '@nestjs/common';
@Module({
providers: [
{
provide: ConfigService,
useFactory: (configOptions: ConfigOptions) => {
return new ConfigService(configOptions);
},
inject: [ConfigOptions],
}
]
})
export class ConfigModule {}全局模块
通过 @Global() 装饰器将模块标记为全局模块;全局模块中的 provider 提供者可以在任何地方被注入使用;
注册为全局模块后,其他模块在使用该模块时就不需要先注册模块、再注入依赖,而是直接注入使用。
import { Global, Module } from '@nestjs/common';
@Global()
@Module({
providers: [xxxService],
exports: [xxxService], // 导出 xxxService 服务,使其可以被其他模块调用
})
export class ConfigModule {}动态模块 register forRoot
与之配套的还有 registerAsync、forRootAsync 的异步版本。
实际上两者能够达到一样的目的
register每次使用时都希望得到不同的配置;它是高度特化的。forRoot期望在应用中只配置一次,通常在AppModule中,配置会被多个模块共享。
import { Module, DynamicModule } from '@nestjs/common';
@Module({})
export class AIGatewayModule {
static forRoot(apiKey: string): DynamicModule {
return {
module: AIGatewayModule,
providers: [
{ provide: 'AI_KEY', useValue: apiKey }
],
exports: 'AI_KEY',
global: true
}
}
static register(options: { model: string, prompt: string}): DynamicModule {
return {
module: AIGatewayModule,
providers: [
{ provide: 'AI_TASK_CONFIG', useValue: options }
],
exports: 'AI_TASK_CONFIG'
}
}
}在其他模块中注册时则可以使用 forRoot、register 方法并且传入配置进行注册;
// app.module.ts
@Module({
providers: [AIGatewayModule.forRoot('你的 ai key')]
})
export class AppModule {}
// agent.module.ts
@Module({
providers: [AIGatewayModule.register({ model: 'gpt-5.4', prompt: 'balbala'})]
})
export class AgentModule {}使用时,通过 Inject 去获取实际的内容;
// agent.service.ts
@Injectable()
class AgentService {
constructor(
@Inject('AI_KEY') private readonly apiKey: string,
@Inject('AI_TASK_CONFIG') private readonly aiTaskConfig: { model: string; prompt: string }
) {}
}