Nest.js 系列——Provider 的多种引入方式

前言

Nest中使用了依赖注入的方式，来管理各个模块之间的依赖关系。在Nest中，提供了Provider来注入服务。但是引入有多种方式，这里来记录下每种方法的使用场景和要求。

通过类来引入

在前面知道，provider一般都是用@Injectable装饰的类

@Injectable()
export class AppService {
  getWater(): string {
    return 'hello water'
  }
}

在模块的providers中，通过类来引入，比如服务这种提供者。

import { Module } from '@nestjs/common'
import { AppController } from './app.controller'
import { AppService } from './app.service'

@Module({
  imports: [],
  controllers: [AppController],
  providers: [AppService]
})
export class AppModule {}

其实上面的提供者是一种简写方式，完整的写法如下：

@Module({
  imports:[],
  controllers: [AppController],
  providers: [{
    provide: AppService,
    useClass: AppService,
  }],
})

通过 token 引入

通过 provide 指定注入的 token，通过 useClass 指定注入的对象的类，Nest 会自动对它做实例化再注入

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  getWater(): string {
    return this.appService.getWater()
  }
}

这里是使用的构造函数注入，也可以通过属性注入。

@Controller()
export class AppController {
  @Inject()
  private readonly appService: AppService

  @Get()
  getWater(): string {
    return this.appService.getWater()
  }
}

通过@Inject装饰器来注入。指定注入的provider的token就行了，而且这个token还可以是一个字符串。

@Module({
  imports: [],
  controllers: [AppController],
  providers: [
    {
      provide: 'app_service',
      useClass: AppService
    }
  ]
})
export class AppModule {}

那么当token是字符串的时候，那么导入的方式就变成下面这样了。

@Controller()
export class AppController {
  constructor(@Inject('app_service') private readonly appService: AppService) {}
  // 或者
  // @Inject('app_service')
  // private readonly appService: AppService;

  @Get()
  getWater(): string {
    return this.appService.getWater()
  }
}

指定一个值

除了指定一个类，还可以指定一个值，比如字符串，数字，布尔值等。

@Module({
  imports: [],
  controllers: [AppController],
  providers: [
    {
      provide: 'water_token',
      useValue: {
        name: 'water',
        age: 18
      }
    }
  ]
})
export class AppModule {}

@Controller()
export class AppController {
  constructor(@Inject('water_token') private readonly waterToken: { name: string; age: number }) {}
}

也可以通过useFactory来动态生成一个值。

@Module({
  imports: [],
  controllers: [AppController],
  providers: [
    {
      provide: 'water_token',
      useFactory: () => {
        return {
          name: 'water',
          age: 18
        }
      }
    }
  ]
})
export class AppModule {}

使用方式与上面一致。同时使用useFactory还支持参数传递。

{
    provide: 'water_token',
    useFactory: (name: string) => {
      return {
        name: name,
        age: 18,
      }
    },
    inject: ['name']
}

provide还可以通过useExisting来指定别名，比如把name这个provider的别名指定为water_token。

@Module({
  imports: [],
  controllers: [AppController],
  providers: [
    {
      provide: 'water_token',
      useExisting: 'name'
    }
  ]
})
export class AppModule {}

总结

通过类来引入，通过token来引入，通过useValue来引入一个值，通过useFactory来引入一个值，通过useExisting来引入别名。

以上就是Nest中Provider的多种引入方式。