注入 npm 模块
下面的示例展示了如何注入 npm 模块(lodash
和 sequelize
)到 SomeClass
类。
示例目录结构如下:
src/
├── entities
│ └── some_class.ts
├── index.ts
└── ioc
├── interfaces.ts
├── ioc.ts
└── types.
/src/ioc/types.ts
const TYPES = {
Sequelize: Symbol.for("Sequelize"),
Lodash: Symbol.for("Lodash"),
SomeClass: Symbol.for("SomeClass")
};
export { TYPES };
/src/ioc/interfaces.ts
import * as sequelize from "sequelize";
import * as _ from "lodash";
export type Sequelize = typeof sequelize;
export type Lodash = typeof _;
export interface SomeClassInterface {
test(): void;
}
/src/ioc/ioc.ts
import { Container, ContainerModule } from "inversify";
import * as sequelize from "sequelize";
import * as _ from "lodash";
import { TYPES } from "./types";
import { Sequelize, Lodash } from "./interfaces";
import { SomeClass } from "../entities/some_class";
const thirdPartyDependencies = new ContainerModule((bind) => {
bind<Sequelize>(TYPES.Sequelize).toConstantValue(sequelize);
bind<Lodash>(TYPES.Lodash).toConstantValue(_);
// ..
});
const applicationDependencies = new ContainerModule((bind) => {
bind<SomeClass>(TYPES.SomeClass).to(SomeClass);
// ..
});
const container = new Container();
container.load(thirdPartyDependencies, applicationDependencies);
export { container };
/src/entities/some_class.ts
import { Container, injectable, inject } from "inversify";
import { TYPES } from "../ioc/types";
import { Lodash, Sequelize, SomeClassInterface } from "../ioc/interfaces";
@injectable()
class SomeClass implements SomeClassInterface {
private _lodash: Lodash;
private _sequelize: Sequelize;
public constructor(
@inject(TYPES.Lodash) lodash,
@inject(TYPES.Sequelize) sequelize,
) {
this._sequelize = sequelize;
this._lodash = lodash;
}
public test() {
const sequelizeWasInjected = typeof this._sequelize.BIGINT === "function";
const lodashWasInjected = this._lodash.cloneDeep === "function";
console.log(sequelizeWasInjected); // true
console.log(lodashWasInjected); // true
}
}
export { SomeClass };
/src/index.ts
import "reflect-metadata";
import { container } from "./ioc/ioc";
import { SomeClassInterface } from "./ioc/interfaces";
import { TYPES } from "./ioc/types";
const someClassInstance = container.get<SomeClassInterface>(TYPES.SomeClass);
someClassInstance.test();
/package.json
{
"name": "test",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC",
"dependencies": {
"inversify": "^4.1.0",
"lodash": "^4.17.4",
"reflect-metadata": "^0.1.10",
"sequelize": "^3.30.4"
},
"devDependencies": {
"@types/lodash": "^4.14.63",
"@types/sequelize": "^4.0.51"
}
}
/tsconfig.json
{
"compilerOptions": {
"target": "es5",
"lib": ["es6", "dom"],
"types": ["reflect-metadata"],
"module": "commonjs",
"moduleResolution": "node",
"experimentalDecorators": true,
"emitDecoratorMetadata": true
}
}