首页 > 解决方案 > 将 inversifyJS 配置文件拆分为多个文件

问题描述

我最近碰到一个使用 Typescript 的后端项目,想在 Inversify.js 的帮助下实现 IoC 原理。按照官方文档,我有一个名为的巨大文件,inversify.config.ts其中包含我所有的接口和实现它们的类:

import "reflect-metadata"
import { Container } from "inversify"
import TYPES from './types';

import { ModuleRepo } from '../repo/interfaces'
import { ModuleARepoImpl } from '../repo/moduleA'
import { ModuleBRepoImpl } from '../repo/moduleB'

import { ModuleService } from '../services/interfaces'
import { ModuleAServiceImpl } from '../services/moduleA'
import { ModuleBServiceImpl } from '../services/moduleB'

const container = Container();

container.bind<ModuleRepo>(TYPES.ModuleARepo).to(ModuleARepoImpl);
container.bind<ModuleRepo>(TYPES.ModuleBRepo).to(ModuleBRepoImpl);

container.bind<ModuleService>(TYPES.ModuleAService).to(ModuleAServiceImpl);
container.bind<ModuleService>(TYPES.ModuleBService).to(ModuleBServiceImpl);

export default container;

上述设置中的一个大问题是,当项目变得复杂时,会添加更多模块,从而导致配置文件非常长(假设您有几十个模块)。我的计划是把它分成更小的配置文件,inversify.config.ts仍然是主文件。

考虑以下设置:

./dependencies/interface/index.ts

import { Container } from 'inversify';
export type InversifyContainer = Container

export interface BasicInterface {
        register(container: InversifyContainer): void
        readonly types: Object
    }

./dependencies/moduleA/index.ts

import {InversifyContainer, BasicDependencies} from '../interface';
import { ModuleRepo } from '../../repo/interfaces'
import { ModuleARepoImpl } from '../../repo/moduleA'
import { ModuleService } from '../../services/interfaces'
import { ModuleAServiceImpl } from '../../services/moduleA'

export class ModuleADependencies {
    register(container: InversifyContainer) {
           container.bind<ModuleRepo>(TYPES.ModuleARepo).to(ModuleARepoImpl);
           container.bind<ModuleService>(TYPES.ModuleAService).to(ModuleAServiceImpl);
    }

    readonly types = {
          ModuleARepo: Symbol('ModuleARepo'),
          ModuleAService: Symbol('ModuleAService'),
    }
}

./dependencies/inversify.config.ts

import "reflect-metadata"
import { Container } from "inversify"

import { ModuleADependencies } from './moduleA';
import { ModuleBDependencies } from './moduleB'; // consider moduleB also has the same file

const container = Container();
const registrationList = [ModuleADependencies, ModuleBDependencies];
for (const reg of registrationList) {
    new reg().register(container);
}

export default container;

./dependencies/types.ts

import { ModuleADependencies } from './moduleA';
import { ModuleBDependencies } from './moduleB';

const TYPES = {
    ...(new ModuleADependencies().types),
    ...(new ModuleBDependencies().types),
}

export default TYPES

但是,这样我总是会出现错误,显示Cannot read property of ModuleARepo of undefined类型中的内容。我浏览了互联网,但似乎没有人关心inversify.config.ts如果它在一个复杂的项目中会有多长和多混乱。

希望有人可以帮助解决这个问题:)

标签: node.jstypescriptinversifyjs

解决方案


首先,您的问题在文档中进行了描述并有解决方案

您的解决方案通常是正确的,但存在循环依赖

./dependencies/types.ts -> ./dependencies/moduleA/index.ts -> ./dependencies/types.ts

types类的新实例中创建但包含类定义的模块导入types。您没有列出此导入,而是使用TYPES.ModuleARepoin bind

为避免这种情况,您可以将types字段设为静态或将其从类中移出到单独的可导出对象中。作为它的一个积极的副作用,将不需要在./dependencies/types.ts.

以防万一,请记住,如果您实例化一个具有 Symbol 作为字段的类,则该符号对于每个实例都是唯一的,因为Symbol('ModuleARepo') !== Symbol('ModuleARepo').

操场


推荐阅读