依赖注入[4]: 创建一个简易版的DI框架[上篇]

Posted tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了依赖注入[4]: 创建一个简易版的DI框架[上篇]相关的知识，希望对你有一定的参考价值。

本系列文章旨在剖析.NET Core的依赖注入框架的实现原理，到目前为止我们通过三篇文章（《控制反转》、《基于IoC的设计模式》和《 依赖注入模式》）从纯理论的角度对依赖注入进行了深入论述，为了让读者朋友能够更好地理解.NET Core的依赖注入框架的设计思想和实现原理，我们创建了一个简易版本的DI框架，也就是我们在前面文章中多次提及的Cat。我们会上下两篇来介绍这个被称为为Cat的DI框架，上篇介绍编程模型，下篇关注设计实现。[源代码从这里下载]

目录
一、DI容器的层次结构与服务实例生命周期
二、服务的注册于提取
三、提供泛型服务
四、多服务实例的提取
五、服务实例的释放回收

一、DI容器的层次结构与服务实例生命周期

虽然我们对这个名为Cat的DI框架进行了最大限度的简化，但是与.NET Core的真实DI框架相比，Cat不仅采用了一致的设计，而且几乎具备了后者所有的功能特性。作为DI容器的Cat对象不仅仅是作为服务实例的提供者，它同时还需要维护提供服务实例的生命周期。Cat提供了三种生命周期模式，如果要了解它们之间的差异，就必需对多个Cat之间的层次关系有充分的认识。一个代表DI容器的Cat用以来创建多个新的Cat对象，后者视前者为“父容器”，所以多个Cat对象通过其“父子关系”维系一个树形层次化结构。不过着仅仅是一个逻辑结构而已，实际上每个Cat对象只会按照图1所示的方式引用整棵树的根。

3-7
图1 Cat之间的关系

在了解了代表DI容器的多个Cat对象之间的关系之后，对于三种预定义的生命周期模式就很好理解了。如下所示的Lifetime枚举代表着三种生命周期模式，其中Transient代表容器针对每次服务请求都会创建一个新的服务实例，它代表一种“即用即取，用完即弃”的消费方式；而Self则是将提供服务实例保存在当前容器中，它代表针对某个容器的单例模式； Root则是将每个容器提供的服务实例统一存放到根容器中，所以该模式能够在多个“同根”容器范围内确保提供的服务是单例的。

public enum Lifetime
{
    Root,
    Self,
    Transient
}
代表DI容器的Cat对象为我们提供所需服务实例的前提是相应的服务注册已经在此之前已经添加到容器之中。服务总是针对服务类型（接口、抽象类或者具体类型）来注册的，Cat通过定义的扩展方法提供了如下三种注册方式。除了以指定服务实例的形式外（默认采用Root模式），我们在注册服务的时候必须指定一个具体的生命周期模式。
  • 指定注册服务的实现类型；
  • 指定一个现有的服务实例；
  • 指定一个创建服务实例的工厂。

二、服务的注册于提取

我们定义了如下的接口和对应的实现类型来演示针对Cat的服务注册和提取。其中Foo、Bar和Baz分别实现了对应的接口IFoo、IBar和IBaz，为了反映Cat对服务实例生命周期的控制，我们让它们派生于同一个基类Base。Base实现了IDisposable接口，我们在其构造函数和实现的Dispose方法中打印出相应的文字以确定对应的实例何时被创建和释放。我们还定义了一个泛型的接口IFoobar<T1, T2>和对应的实现类Foobar<T1, T2>来演示Cat针对泛型服务实例的提供。

public interface IFoo {}
public interface IBar {}
public interface IBaz {}
public interface IFoobar<T1, T2> {}
public class Base : IDisposable
{
    public Base() => Console.WriteLine($"An instance of {GetType().Name} is created.");
    public void Dispose() => Console.WriteLine($"The instance of {GetType().Name} is disposed.");
}

public class Foo : Base, IFoo, IDisposable { }
public class Bar : Base, IBar, IDisposable { }
public class Baz : Base, IBaz, IDisposable { }
public class Foobar<T1, T2>: IFoobar<T1,T2>
{
    public IFoo Foo { get; }
    public IBar Bar { get; }
    public Foobar(IFoo foo, IBar bar)
    {
        Foo = foo;
        Bar = bar;
    }
}

在如下所示的代码片段中我们创建了一个Cat对象并采用上面提到的方式针对接口IFoo、IBar和IBaz注册了对应的服务，它们采用的生命周期模式分别为Transient、Self和Root。接下来我们利用Cat对象创建了它的两个子容器，并利用调用后者的GetService<T>方法来提供相应的服务实例。

class Program
{
    static void Main()
    {
        var root = new Cat()
            .Register<IFoo, Foo>(Lifetime.Transient)
            .Register<IBar>(_=> new Bar(), Lifetime.Self) 
            .Register<IBaz, Baz>( Lifetime.Root);
        var cat1 = root.CreateChild();
        var cat2 = root.CreateChild();

        void GetServices<TService>(Cat cat)
        {
            cat.GetService<TService>();
            cat.GetService<TService>();
        }

        GetServices<IFoo>(cat1);
        GetServices<IBar>(cat1);
        GetServices<IBaz>(cat1);
        Console.WriteLine();
        GetServices<IFoo>(cat2);
        GetServices<IBar>(cat2);
        GetServices<IBaz>(cat2);
    }
}
上面的程序运行之后会在控制台上输出如图2所示的结果，输出的内容不仅表明Cat能够根据添加的服务注册提供对应类型的服务实例，还体现了它对生命周期的控制。由于IFoo被注册为Transient服务，所以Cat针对该接口类型的四次请求都会创建一个全新的Foo对象。IBar服务的生命周期模式为Self，如果我们利用同一个Cat对象来提供对应的服务实例，该Cat对象只会创建一个Bar对象，所以整个程序执行过程中会创建两个Bar对象。IBaz服务采用Root生命周期，所以具有同根的两个Cat对象提供的总是同一个Baz对象，后者只会被创建一次。

3-8
图2 Cat按照服务注册对应的生命周期模式提供服务实例

三、提供泛型服务

除了提供类似于IFoo、IBar和IBaz这样非泛型服务实例之外，如果具有对应的泛型定义（Generic Definition）的服务注册，Cat同样也能提供泛型服务实例。如下面的代码片段所示，在为创建的Cat对象添加了针对IFoo和IBar接口的服务注册之后，我们调用Register方法注册了针对泛型定义IFoobar<,>的服务注册，实现的类型为Foobar<,>。当我们利用该Cat对象提供一个类型为IFoobar<IFoo, IBar>的服务实例的时候，它会创建并返回一个Foobar<Foo, Bar>对象。

var cat = new Cat()
    .Register<IFoo, Foo>(Lifetime.Transient)
    .Register<IBar, Bar>(Lifetime.Transient)
    .Register(typeof(IFoobar<,>), typeof(Foobar<,>), Lifetime.Transient);

var foobar = (Foobar<IFoo, IBar>)cat.GetService<IFoobar<IFoo, IBar>>();
Debug.Assert(foobar.Foo is Foo);
Debug.Assert(foobar.Bar is Bar);

四、多服务实例的提取

当我们在进行服务注册的时候，可以为同一个类型添加多个服务注册。不过由于扩展方法GetService<T>总是返回一个唯一的服务实例，我们对该方法采用了“后来居上”的策略，即总是采用最近添加的服务注册来创建服务实例。如果我们调用另一个扩展方法GetServices<T>，它将利用返回所有服务注册提供的服务实例。

如下面的代码片段所示，我们为创建的Cat对象添加了三个针对Base类型的服务注册，对应的实现类型分别为Foo、Bar和Baz。我们最后将Base作为泛型参数调用了GetServices<Base>方法，该方法会返回包含三个Base对象的集合，集合元素的类型分别为Foo、Bar和Baz。

var services = new Cat()
    .Register<Base, Foo>(Lifetime.Transient)
    .Register<Base, Bar>(Lifetime.Transient)
    .Register<Base, Baz>(Lifetime.Transient)
    .GetServices<Base>();
Debug.Assert(services.OfType<Foo>().Any());
Debug.Assert(services.OfType<Bar>().Any());
Debug.Assert(services.OfType<Baz>().Any());

五、服务实例的释放回收

如果提供的服务实例实现了IDisposable接口，我们应该适当的时候调用其Dispose方法释放该服务实例。由于服务实例的生命周期完全由作为DI容器的Cat对象来管理，通过调用Dispose方法来释放服务实例自然也应该由它来负责。Cat针对提供服务实例的释放策略取决于对应的服务注册采用的生命周期模式，具体的策略如下：

  • Transient和Self：所有实现了IDisposable接口的服务实例会被作为服务提供者的当前Cat对象保存起来，当Cat对象自身的Dispose方法被调用的时候，这些服务实例的Dispose方法会随之被调用。

  • Root：由于服务实例保存在作为根容器的Cat对象上，所以后者的Dispose方法的调用会触发针对服务实例的释放。

上述的释放策略可以通过如下的演示实例来印证。我们在如下的代码片段中创建了一个Cat对象，并添加了针对IFoo、IBar和IBaz的服务注册。接下来我们调用了CreateChild方法创建代码子容器的Cat对象，并用后者提供了三个注册服务对应的实例。

class Program
{
    static void Main()
    {
        using (var root = new Cat()
            .Register<IFoo, Foo>(Lifetime.Transient)
            .Register<IBar, Bar>(Lifetime.Self)
            .Register<IBaz, Baz>(Lifetime.Root))
        {
            using (var cat = root.CreateChild())
            {
                cat.GetService<IFoo>();
                cat.GetService<IBar>();
                cat.GetService<IBaz>();
                Console.WriteLine("Child cat is disposed.");
            }
            Console.WriteLine("Root cat is disposed.");
        }
    }
}
由于两个Cat对象的创建都是在using块中进行的，所有针对它们的Dispose方法都会在using块结束的地方被调用，为了确定方法被调用的时机，我们特意在控制台上打印了相应的文字。该程序运行之后会在控制台上输出如图3所示的结果，我们可以看到当作为子容器的Cat对象的Dispose方法被调用的时候，由它提供的两个生命周期模式分别为Transient和Self的两个服务实例（Foo和Bar）被正常释放了。至于生命周期模式为Root的服务实例Baz，它的Dispose方法会延迟到作为根容器Cat对象被释放的时候。

3-9
图3 Root服务实例的释放

依赖注入[1]: 控制反转
依赖注入[2]: 基于IoC的设计模式
依赖注入[3]: 依赖注入模式
依赖注入[4]: 创建一个简易版的DI框架[上篇]
依赖注入[5]: 创建一个简易版的DI框架[下篇]
依赖注入[6]: .NET Core DI框架[编程体验]
依赖注入[7]: .NET Core DI框架[服务注册]
依赖注入[8]: .NET Core DI框架[服务消费]

以上是关于依赖注入[4]: 创建一个简易版的DI框架[上篇]的主要内容，如果未能解决你的问题，请参考以下文章

依赖注入[5]: 创建一个简易版的DI框架[下篇]

依赖注入 ---- 系列文章

[ASP.NET Core 3框架揭秘] 依赖注入：一个Mini版的依赖注入框架

DI 原理解析 并实现一个简易版 DI 容器

《ASP.NET Core 6框架揭秘》实例演示[04]：自定义依赖注入框架

Android依赖注入Dagger的使用和源码解析（上篇）