inversify

安装与配置

Inversify 是一个用于 TypeScript 和 JavaScript 的轻量级依赖注入（DI）库，reflect-metadata 则是它依赖的一个库，用于支持 TypeScript 中的装饰器和元数据功能。结合使用这两个库，可以轻松实现基于装饰器的依赖注入。

npm i inversify reflect-metadata

然后，确保在 TypeScript 项目中启用装饰器和反射元数据，编辑你的 tsconfig.json：

tsconfig.json

{
  "compilerOptions": {
    "experimentalDecorators": true,//开启装饰器
    "emitDecoratorMetadata": true//开启元数据发射
  }
}

创建IOC容器

import { Container } from "inversify";

const container = new Container();

依赖注入

首先，我们定义 Engine 接口和它的实现类 GasEngine：

// Engine.ts
export interface Engine {
  start(): string;
}

@injectable()  // 使用 @injectable 装饰器标记该类可以被注入
export class GasEngine implements Engine {
  start(): string {
    return "Gas engine started!";
  }
}

然后，定义 Car 类，它依赖于 Engine：

// Car.ts
import { Engine } from './Engine';
import { injectable, inject } from "inversify";

@injectable()  // 使用 @injectable 装饰器标记该类可以被注入
export class Car {
  private engine: Engine;

  constructor(@inject("Engine") engine: Engine) {  // 使用 @inject 装饰器注入 Engine 依赖
    this.engine = engine;
  }

  startCar() {
    console.log(this.engine.start());  // 调用引擎的 start 方法
  }
}

• @injectable()：给类打上“可注入”标记。这个类可以由容器进行实例化，并且它的元数据需要被记录。
• @inject("Engine")：将 Engine 类型的依赖注入到 Car 类中。这里 @inject 装饰器的参数 "Engine" 是在容器中用来标识依赖的标识符。

为什么需要@injectable()

container.bind(Car).toSelf()已经进行了依赖注册与绑定，为什么还需要@injectable() ？

装饰器和类型是TS所独有，运行时会编译成JS。因此TS中的类型信息将会丢失：

class Car {
  constructor(engine) {
    this.engine = engine;
  }
}
// 这里的 engine 是什么类型？JS 引擎完全不知道。

为了保存类型信息，我们需要使用@injectable() 装饰器保存元数据，这也是为什么需要开启experimentalDecorators和emitDecoratorMetadata

依赖注册与绑定

bind

在IOC容器中存在如下的数据结构，用于存储标识符和实现类之间的绑定关系

Map<ServiceIdentifier, Binding[]>

• ServiceIdentifier：标识符，支持string，symbol，class
• Binding：相关实现

---

• 使用class

container.bind(Car).toSelf();

标识符为什么可以使用class？

因为 类本身就是一个运行时存在的唯一标识符，构造函数本身就是一个对象（函数对象），适合作为标识符

• 使用string

container.bind("Engine").to(GasEngine);

• 同一个标识符可以绑定多个实现。

container.bind(Weapon).to(Sword)
container.bind(Weapon).to(Gun)

to

绑定标识符和实现类

container.bind(接口标识符).to(具体实现类)

container.bind("Engine").to(GasEngine);

toSelf

如果标识符和实现类相同，也可以直接使用toSelf自绑定

container.bind(Car).toSelf()

等价于：

container.bind(Car).to(Car)

提示

这也是推荐使用class作为标识符的原因

创建实例

get

container.get() 是 Inversify 里真正触发实例创建的方法。

container.get(Key)

• Key：ServiceIdentifier，在IOC容器中注册的标识符

---

• 使用了class注册了依赖，你也需要使用class获取

container.bind(Car).to(Car);
const car = container.get<Car>(Car);

• 使用了string注册了依赖，你也需要使用string获取

container.bind('Car').to(Car);
const car = container.get<Car>("Car");