动手造轮子:实现一个简单的依赖注入(零)

intro

依赖注入为我们写程序带来了诸多好处,在微软的 .net core 出来的同时也发布了微软开发的依赖注入框架 microsoft.extensions.dependencyinjection,大改传统 asp.net 的开发模式,asp.net core 的开发更加现代化,更加灵活,更加优美。

依赖注入介绍

要介绍依赖注入,首先来聊一下控制反转(ioc)

ioc—inversion of control,即“控制反转”,不是什么技术,而是一种设计思想。ioc意味着将你设计好的对象交给容器控制,而不是传统的在你的对象内部直接控制。

  • 谁控制谁,控制什么:传统程序设计,我们直接在对象内部通过 new 进行创建对象,是程序主动去创建依赖对象;而ioc是有专门一个容器来创建这些对象,即由 ioc 容器来控制对 象的创建;谁控制谁?当然是ioc 容器控制了对象;控制什么?那就是主要控制了外部资源获取(不只是对象包括比如文件等)。
  • 为何是反转,哪些方面反转了:有反转就有正转,传统应用程序是由我们自己在对象中主动控制去直接获取依赖对象,也就是正转;而反转则是由容器来帮忙创建及注入依赖对象;为何是反转?因为由容器帮我们查找及注入依赖对象,对象只是被动的接受依赖对象,所以是反转;哪些方面反转了?依赖对象的获取被反转了。

ioc 对编程带来的最大改变不是从代码上,而是从思想上,发生了“主从换位”的变化。应用程序原本是老大,要获取什么资源都是主动出击,但是在 ioc/di 思想中,应用程序就变成被动的了,被动的等待 ioc 容器来创建并注入它所需要的资源了。

ioc 很好的体现了面向对象设计法则之一—— 好莱坞法则:“别找我们,我们找你”;即由 ioc 容器帮对象找相应的依赖对象并注入,而不是由对象主动去找。

di—dependency injection,即“依赖注入”组件之间依赖关系由容器在运行期决定,形象的说,即由容器动态的将某个依赖关系注入到组件之中依赖注入的目的并非为软件系统带来更多功能,而是为了提升组件重用的频率,并为系统搭建一个灵活、可扩展的平台。通过依赖注入机制,我们只需要通过简单的配置,而无需任何代码就可指定目标需要的资源,完成自身的业务逻辑,而不需要关心具体的资源来自何处,由谁实现。

理解di的关键是:“谁依赖谁,为什么需要依赖,谁注入谁,注入了什么”,那我们来深入分析一下:

  ●谁依赖于谁:当然是应用程序依赖于 ioc 容器

  ●为什么需要依赖:应用程序需要 ioc 容器来提供对象需要的外部资源

  ●谁注入谁:很明显是 ioc 容器注入应用程序里依赖的对象

  ●注入了什么:就是注入某个对象所需要的外部资源/依赖

 

依赖注入明确描述了 “被注入对象依赖 ioc 容器配置依赖对象”,依赖注入是控制反转设计思想的一种实现。

依赖注入的好处:

  • 对象的创建和销毁完全交给 ioc 容器去做,不再需要在应用中关心对象的创建的和销毁,这对于 c# 里的 idisposable 对象来说尤为重要,自己去 new 的时候,对于一些新手来说可能会忘记使用 using 或手动 dispose
  • 对象的复用,有时候很多对象没有必要每次用的时候就去创建一次,使用 ioc 可以控制在同一生命周期内的对象只被创建一次
  • 依赖关系更清晰
  • 更好的实现面向接口编程,替换实现只需要注入服务的时候换成另外一种实现就可以了

大概设计

大体使用类似于微软的依赖注入框架,但是比微软的依赖注入框架简单一些,性能也有待优化。

  • 服务生命周期:服务的生命周期沿用微软的服务生命周期,分为 singleton/scoped/transient,默认值是 singleton 单例模式
  • 服务注册方式:支持所有微软依赖注入的注册方式,实例注入/类型注入/接口-实现注入/func 注入
  • 注入方式:目前仅支持依赖注入,构造方法注入,未来暂时也没有支持属性注入的打算(支持的话也不复杂,但是依赖关系就不清晰了,也不推荐用),构造方法注入支持直接注入 ienumerable<t>ireadonlycollection<t>ireadonlylist<t> 来支持获取一个接口多个实现的注入,支持泛型注入

di 相关类图:

体验一下

可以参考单元测试:

using(iserviceconatiner container = new servicecontainer())
{
    container.addsingleton<iconfiguration>(new configurationbuilder()
         .addjsonfile("appsettings.json")
         .build()
    );
    container.addscoped<ifly, monkeyking>();
    container.addscoped<ifly, superman>();

    container.addscoped<hasdependencytest>();
    container.addscoped<hasdependencytest1>();
    container.addscoped<hasdependencytest2>();
    container.addscoped<hasdependencytest3>();
    container.addscoped(typeof(hasdependencytest4<>));

    container.addtransient<wukong>();
    container.addscoped<wujing>(serviceprovider => new wujing());
    container.addsingleton(typeof(genericservicetest<>));

    var rootconfig = container.resolveservice<iconfiguration>();

    assert.throws<invalidoperationexception>(() => container.resolveservice<ifly>());
    assert.throws<invalidoperationexception>(() => container.resolverequiredservice<idependencyresolver>());

    using (var scope = container.createscope())
    {
        var config = scope.resolveservice<iconfiguration>();

        assert.equal(rootconfig, config);

        var fly1 = scope.resolverequiredservice<ifly>();
        var fly2 = scope.resolverequiredservice<ifly>();
        assert.equal(fly1, fly2);

        var wukong1 = scope.resolverequiredservice<wukong>();
        var wukong2 = scope.resolverequiredservice<wukong>();

        assert.notequal(wukong1, wukong2);

        var wujing1 = scope.resolverequiredservice<wujing>();
        var wujing2 = scope.resolverequiredservice<wujing>();

        assert.equal(wujing1, wujing2);

        var s0 = scope.resolverequiredservice<hasdependencytest>();
        s0.test();
        assert.equal(s0._fly, fly1);

        var s1 = scope.resolverequiredservice<hasdependencytest1>();
        s1.test();

        var s2 = scope.resolverequiredservice<hasdependencytest2>();
        s2.test();

        var s3 = scope.resolverequiredservice<hasdependencytest3>();
        s3.test();

        var s4 = scope.resolverequiredservice<hasdependencytest4<string>>();
        s4.test();

        using (var innerscope = scope.createscope())
        {
            var config2 = innerscope.resolverequiredservice<iconfiguration>();
            assert.true(rootconfig == config2);

            var fly3 = innerscope.resolverequiredservice<ifly>();
            fly3.fly();

            assert.notequal(fly1, fly3);
        }

        var flysvcs = scope.resolveservices<ifly>();
        foreach (var f in flysvcs)
            f.fly();
    }

    var genericservice1 = container.resolverequiredservice<genericservicetest<int>>();
    genericservice1.test();

    var genericservice2 = container.resolverequiredservice<genericservicetest<string>>();
    genericservice2.test();
}

更多详情可以参考:< https://github.com/weihanli/weihanli.common/blob/dev/test/weihanli.common.test/dependencyinjectiontest.cs >

more

源码已经在 github 上,可以自行下载阅览或等后面的几篇文章分享解读

reference

  • https://github.com/aspnet/dependencyinjection/tree/rel/2.0.0
  • https://github.com/microsoft/minioc
  • https://github.com/weihanli/weihanli.common/tree/dev/src/weihanli.common/dependencyinjection