Nest系列（九）完全弄懂Nestjs的依赖注入Dependency Injection (DI)的工作原理及要点

四季如春的业余小码农
4,209 阅读6分钟

开启掘金成长之旅！这是我参与「掘金日新计划 · 12 月更文挑战」的第10天，点击查看活动详情

文中的CatsModule案例来自官网，希望通过本篇文章带你完全掌握NestJS中依赖注入的基本工作原理

依赖注入是一种控制反转IOC(inversion of control)技术，就是你可以把对象或依赖的实例化交给IOC容器去处理，在NestJS中这个容器就是NestJS的运行时系统。当需要一个对象实例的时候，我们不需要自己手动new xxxClass()，只需要在合适的地方对类进行注册，在需要用到的地方直接注入，容器将为我们完成new的动作，这为我们省了很多事。最突出的应用场景就是单例模式的运用，很多我们要用到的方法服务都会封装在一个类中，比如与数据库打交道的各个Service类，调用这些服务方法都需要通过服务类实例进行调用。

在NestJS中，我们要使用依赖注入一般分为三步：

1. 声明定义

使用@Injectable来声明一个类，如下：

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

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

它会跟NestJS runtime system进行对话，“嘿，Nest，我有一个CatService类，以后就交给你管理了，当我要调用findAll()方法的时候一定给我提供一个实例哦”，NestJS runtime system看到这个类带上了@injectable装饰器，就爽快的答应了，“放心吧老弟，交给我就行了，你只管用就行，其它的不用管”。

2. 声明在什么地方使用

这是依赖注入的地方，即明确告诉NestJS我要在什么地方使用，一般是在类的构造函数constructor()中进行注入，如下在Controller中使用：

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

  @Get()
  async findAll(): Promise<Cat[]> {
    return this.catsService.findAll();
  }
}

官方把CatsService称为token，NestJS会根据这个token在容器中找到第1步中声明的类（这个对应关系将在第三步中进行关联注册），从而提供对应的实例，这里的实例全局唯一，只有1个！在第一次需要该实例的时候，Nest会new一个出来，而后会缓存起来，后序如果其它地方也注入了这个依赖，那Nest会从缓存中拿到之前new出来的实例供大家使用。

3. 建立注入依赖和容器中类的联系

在Module中，会把上一步的token和容器中对应的CatsService类进行关联，下面是一个语法糖的写法：

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

我们使用完整的写法来说明这里的对应关系：

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

这里provide后面的CatsService对应的是token，useClass后面的CatsService对应的是在容器中管理的类。这里的关联关系是这样的：在Controller中使用的那个catsService对应了一个唯一的token，Nest会根据providers中提供的token-Service类对应关系，为Controller提供对应的实例。可能有同学会有疑问，就是在第2步的constructor中其实已经明确了使用的是CatsService，这里的关联关系总感觉是没有必要的，其实并不是这样的，第2部只能说明catsService是CatsService的一个实例，但这个实例从哪里来并不知道！在Module中我们声明了这一对应关系，解决了实例对象从哪里来的问题，就是从NestJS runtime system统一管理的容器中来。这里会有一点绕，可以多看看好好思考一下，自然而然就会明白了。

Nest会根据所有注入的依赖关系生成一个依赖关系图，就有点类似我们使用import引入各个模块时也会生成一个复杂的依赖关系图。这里CatsController中依赖了CatsService，如果CatsService中还依赖其它东西也会一并放到Nest构建的依赖关系图中，Nest会从下到上按照依赖顺序构建出一整张依赖关系图保证所有的依赖关系正常运作。类似下面这样的依赖关系，一层一层往上，Nest会把每一个Service都统一管理起来想用户提供实例。

image-20221212232356291.png

上面的例子有些同学看了可能还是会有点懵，下面我们在通过另外一个写法来说明这个对应关系。

// cats.controller.ts
@Controller('cats')
export class CatsController {
  constructor(@Inject('tokenName')private readonly catsService: CatsService) {}
}
// app.module.ts
@Module({
  controllers: [CatsController],
  providers: [
    provide: 'tokenName',
    useClass: CatsService
  ],
})

可以看出，上面我把provide改为了tokenName这个字符串，在Controller中使用@Inject('tokenName')显示声明这个catsService实例来自于useClass指定的这个CatsService类，而这个类由Nest进行了统一管理。如果在providers中不指定这个对应关系，Nest是不会给用户自动提供这个类的实例的，因而在Controller中使用的时候也会报错。

4. 分析一个自定义Provider的对应关系案例

为了给大家展示一下这个对应关系的必要性，我写了一个小案例给大家分析一下：

  • 定义两个服务类给Nest管理
// user.service1.ts
@Injectable()
export class UserService1 {
    getHello() {
    return 'hello, service1';
  }
}

// user.service2.ts
@Injectable()
export class UserService2 {
    getHello() {
    return 'hello, service1';
  }
}
  • 在user.controller.ts中使用
@Controller('user')
export class UserController {
  constructor(
    private readonly userService1: UserService1,
    @Inject('userService2') private readonly UserService2: UserService2,
    @Inject('TEST') private readonly test: number,
  ) {}
}
  • 在user.module.ts中声明对应关系
@Module({
  controllers: [UserController],
  providers: [
    UserService1,
    {
      provide: 'userService2',
      useClass: UserService2,
    },
    {
      provide: 'TEST',
      inject: [UserService1，'userService2'],
      useFactory(userService1: UserService1， userService2: UserService2) {
        console.log(userService1.getHello());
        console.log(userService2.getHello());
        return 123;
      },
    },
  ],
})

可以看到，我们TEST这个token的对应关系中，我们在工厂函数中即依赖于UserService1又依赖于UserService2，关键是inject要怎么写？可以看到上面我写的是不一样的！为什么呢？这就是对应关系在其中影响着。

首先，根据上面的对应关系，我们知道Nest中维护着的UserService1对应的token是UserService1，UserService2对应的token是'userService2'，这两个是不一样的，一个是类名，一个是字符串。也就是告诉我们，如果我们想在其它任何地方要使用这两个服务，我们必须指定对应的token才能保证所用到的实例是Nest为我们提供的！

当我们运行时将得到预想的结果：

image-20221213001140258.png

如果我们将`inject`中的`'userService2'`改为`UserService2`即如下：

inject: [UserService1，UserService2],

我们将会得到如下的错误： image-20221213001345965.png

Nest识别不到这个token，建立不了对应关系也就没法建立依赖关系图，所以报错了！我们在使用的时候可能很少会注意这个问题，因为我们常规操作都是直接使用类名作为token了，但实际上那只是一个语法糖，真正的原理弄懂了怎么变换都不怕！

希望我的文章能帮到有困惑的你，如果有所帮助别忘了点个赞哟。

avatar
文章
阅读
粉丝