阅读 2932

十几行代码实现一个ts依赖注入

项目地址

灵感来自angular和我自己写的框架indiv

感谢大佬们star使用

github

关于依赖注入

IOC(Inversion of Control)即控制反转,DI(Dependency Injection)即依赖注入。

假设我们有一个类Human,要实例一个Human,我们需要实例一个类Clothes。而实例化衣服Clothes,我们又需要实例化布Cloth,实例化纽扣等等。

当需求达到一定复杂的程度时,我们不能为了一个人穿衣服去从布从纽扣开始从头实现,最好能把所有的需求放到一个工厂或者是仓库,我们需要什么直接从工厂的仓库里面直接拿。

这个时候就需要依赖注入了,我们实现一个IOC容器(仓库),然后需要衣服就从仓库里面直接拿实例好的衣服给人作为属性穿上去。

IOC是一种很好的解耦合思想,在开发中,IoC意味着你设计好的对象交给容器控制,而不是使用传统的方式,在对象内部直接控制。在软件开发中有很好的作用,不仅被应用在JavaEE里,在其它语言里同样适用。

其实总结起来大概就是你需要我,工厂就把我打扮好派我去找你。

实现一个IOC容器

因为key类型不一定是字符型,而且数组遍历比较浪费性能,因此不选择Object和Array而选择Map作为容器的数据结构。

因为目标是实现一个可以懒汉模式的IOC容器,所以可以在类Injector里写了两个私有类,一个存token和依赖,一个存token和实例化的依赖实例。

在需要某个依赖实例的时候,先去实例的Map中根据token查找出对应的token的实例,如果没有就从存放依赖类的Map中拿出来实例化之后再放入存放实例的Map。

export class Injector {
  private readonly providerMap: Map<any, any> = new Map();
  private readonly instanceMap: Map<any, any> = new Map();
  public setProvider(key: any, value: any): void {
    if (!this.providerMap.has(key)) this.providerMap.set(key, value);
  }
  public getProvider(key: any): any {
    return this.providerMap.get(key);
  }
  public setInstance(key: any, value: any): void {
    if (!this.instanceMap.has(key)) this.instanceMap.set(key, value);
  }
  public getInstance(key: any): any {
    if (this.instanceMap.has(key)) return this.instanceMap.get(key);
    return null;
  }
  public setValue(key: any, value: any): void {
    if (!this.instanceMap.has(key)) this.instanceMap.set(key, value);
  }
}
复制代码

现在new一下,这个容器就创建出来了。

export const rootInjector = new Injector();
复制代码

实现服务

偷偷借走了ng的Injectable,通过类装饰器把类存入容器。

export function Injectable(): (_constructor: any) => any {
  return function (_constructor: any): any {
      rootInjector.setProvider(_constructor, _constructor);
      return _constructor;
  };
}
复制代码

把类作为token,把该类存入provider容器,提供给需要依赖的类。

实现基于注解的属性注入

之所以不实现构造注入,setter注入是因为像ng和react这类框架会对直接对构造函数进行注入或是限制构造函数的参数,为了尽量跨框架跨前后端使用,所以还是用装饰器对属性注入尽量减少侵入性。

属性装饰器和反射能帮我们实现这一功能。

export function Inject(): (_constructor: any, propertyName: string) => any {
  return function (_constructor: any, propertyName: string): any {
    const  propertyType: any = Reflect.getMetadata('design:type', _constructor, propertyName);
    const injector: Injector = rootInjector;

    let providerInsntance = injector.getInstance(propertyType);
    if (!providerInsntance) {
        injector.getProvider(propertyType);
        providerInsntance = new providerClass();
        injector.setInstance(key, providerInsntance);
    }
    _constructor[propertyName] = providerInsntance;

    return (_constructor as any)[propertyName];
  };
}
复制代码

使用Reflect的元数据 Reflect.getMetadata('design:type') 获取属性的类型,并作为token去 injector.getInstance 查询对应的实例,如果有则直接将属性映射为查找到的实例。这样就保证我们每次使用装饰器的属性都会获得单例。

如果没有查询到则去另外一个Map中拿出依赖并实例化存入实例的Map。因为js单线程懒汉模式不存在线程安全这么一说,所以没有选择初始化时就把全部的依赖实例化。

demo

import { Inject, Injectable } from '../injector';

@Injectable()
class Cloth {
    public name: string = '麻布';
}

@Injectable()
class Clothes {
  @Inject() public cloth: Cloth;
}

class Human {
  @Inject() public clothes: Clothes;
}

const pepe = new Human();
console.log(pepe);
// {
//   clothes: {
//      cloth: {
//        name: '麻布'
//      }
//   }
//}
复制代码

最后我们可以直接new pepe,不需要关心pepe穿的衣服 Clothes 和衣服需要的布料 Cloth

最后推荐结合rxjs做响应式编程。ng大法好!