实战Asp.Net Core：DI生命周期

---

title: 实战Asp.Net Core：DI生命周期
date: 2018-11-30 21:54:52
---

一、前言

Asp.Net Core 默认支持 DI（依赖注入） 软件设计模式，那使用 DI 的过程当中，咱们势必会接触到对象的生命周期，那么几种不一样的对象生命周期究竟是怎么样的呢？咱们拿代码说话。

关于 DI 与 IOC：

我的理解：IOC（控制反转） 是目的（下降代码、服务间的耦合），而 DI 是达到该目的的一种手段（具体办法）。

二、DI生命周期

DI的生命周期，根据框架、库的不一样，会略有差别。此处，咱们就以微软的DI扩展为例，来讲下DI中经常使用的几种生命周期。

首先，咱们想象一个这样一个场景。假设咱们有寄快递的需求，那么咱们会致电快递公司：“咱们要寄快递，派一个快递员过来收货”。接着，快递公司会如何作呢？

1. 一直派遣同一个快递员来收货。
2. 第一周派遣快递员A、第二周派遣快递员B收货。
3. 每次都派遣一个新的快递员收货。

这对应到生命周期就是：

1. 单例（Singleton），单一实例，每次使用都是该实例。
2. 做用域实例（Scoped），在一个做用域（好比单次请求）内是同一个实例，不一样的做用域实例不一样。
3. 瞬时实例（Transient），每次使用都建立新的实例。

快递公司也就是咱们在DI中常说的容器（Container）了。

2.一、验证准备

首先，咱们须要三个Services（Service1\Service2\Service3）内容一致，以下：

// Service1.cs，Service二、Service3除类名之外，内容一致
public class Service1
{
    private int value = 0;

    public int GetValue()
    {
        this.value++;
        return this.value;
    }
}

而后，咱们须要一个业务类，再一次注入这三个Service，内容以下：

// DefaultBusiness.cs 
public class DefaultBusiness
{
    private readonly Service1 s1;
    private readonly Service2 s2;
    private readonly Service3 s3;

    public DefaultBusiness(Service1 s1, Service2 s2, Service3 s3)
    {
        this.s1 = s1;
        this.s2 = s2;
        this.s3 = s3;
    }

    public int GetS1Value()
    {
        return this.s1.GetValue();
    }

    public int GetS2Value()
    {
        return this.s2.GetValue();
    }

    public int GetS3Value()
    {
        return this.s3.GetValue();
    }
}

最后，还须要在Startup.cs进行注入

// Startup.cs
public void ConfigureServices(IServiceCollection services)
{
  // 单例模式
  services.AddSingleton<Service1>();
  // 做用域模式
  services.AddScoped<Service2>();
  // 瞬时模式
  services.AddTransient<Service3>();
  // 为了保证结果，将Business类注册为瞬时模式，每次注入都是全新的。
  services.AddTransient<Business.DefaultBusiness>();
}

2.二、验证单例（Singleton）

对于单例来讲，咱们指望，在整个程序启动期间，都是同一个实例，因此，咱们只须要在Service中，增长一个局部变量，作累加就能够验证。

// DefaultController.cs
[Route("singleton")]
public IActionResult SingletonTest()
{
    this.defaultBiz.GetS1Value();
    return Json(new
    {
        s1 = s1.GetValue()
    });
}

而后咱们访问 http://localhost:5000/singleton 屡次，输入以下：

// 第一次
{ s1: 2 }
// 第二次
{ s1: 4 }
// 第三次
{ s1: 6 }

能够发现，每请求一次，value都会增长2。分析下怎么来的呢？

1. 首先是执行 defaultBiz.GetValue() 中，根据内部代码，此处会对注入的实例，value + 1。
2. 以后，Json()中的，s1 = s1.GetValue()，此处再一次增长了1。
3. 综上，一次请求，s1 中的value值会增长2，因为是单例模式，在整个服务运行期间，都是一个实例，因此，每次请求都会累加2。

2.三、验证做用域实例（Scoped）

// DefaultController.cs
[Route("scoped")]
public IActionResult ScopedTest()
{
    this.defaultBiz.GetS2Value();
    return Json(new
    {
        s2 = s2.GetValue()
    });
}

而后咱们访问 http://localhost:5000/scoped 屡次，输入以下：

// 第一次
{ s2: 2 }
// 第二次
{ s2: 2 }
// 第三次
{ s2: 2 }

从结果能够看出，每次请求的返回值是固定的，都为2，也就是证实了Service2中，value++执行了两次。对于执行value++的代码，只有 defaultBiz.GetS2Value() 和 s2 = s2.GetValue()，因此这两处操做的是同一个实例。这也就证实了，对于 Scoped 生命周期，在做用域（能够简单理解为单次请求，实际上并不许确，注意，此处为考虑多线程的状况）内，都是使用的同一个实例。在不一样的请求之间，则是不一样的实例。

2.四、验证瞬时实例（Transient）

// DefaultController.cs
[Route("transient")]
public IActionResult TransientTest()
{
    return Json(new
    {
        s3 = s3.GetValue()
    });
}

而后咱们访问 http://localhost:5000/transient 屡次，输入以下：

// 第一次
{ s3: 1 }
// 第二次
{ s3: 1 }
// 第三次
{ s3: 1 }

从结果来看，每次请求的都是相同的返回值，s3 = 1，这说明了，两次操做的value++,是针对的不一样实例。也就是每次使用 Service1，都是全新的实例。

三、扩展（Autofac DI 类库）

Asp.Net Core中默认的DI，相对仍是比较简单的，只有三个生命周期。对于时下比较的依赖注入库，通常都会有更多的生命周期，有些还会有生命周期事件能够监控。

以 Autofac 为例，该类库提供了以下一些生命周期，能够作到更精细化的控制：

1. 单次依赖（Instance Per Dependency）- 也就是Transient，每次获取实例都是全新的。
2. 单例（Single Instance） - 也就是单例，整个服务周期都是一个实例。
3. 做用域隔离的实例（Instance Per Lifetime Scope） - 也就是一个做用域一个，示例代码以下：

// 先建立做用域
using(var scope1 = container.BeginLifetimeScope())
{
  
  for(var i = 0; i < 100; i++)
  {
    // 在做用域内，Resolve 的都是同一个实例
    var w1 = scope1.Resolve<Worker>();
  }
}

// 建立另外一个做用域
using(var scope2 = container.BeginLifetimeScope())
{
  for(var i = 0; i < 100; i++)
  {
    // 在做用域内，Resolve 的都是同一个实例，可是这个实例和 scope1 做用域中的 w1 不是同一个。
    var w2 = scope2.Resolve<Worker>();
  }
}

1. 带标签的做用域隔离实例（Instance Per Matching Lifetime Scope）
2. 单次请求做用域实例（Instance Per Request） - 每一个请求做为一个做用域。
3. 指定Owner的做用域实例（Instance Per Owned）- 对于同一个Owner，实例保持一致
4. 线程做用域实例（Thread Scope）

更多 Autofac 生命周期相关内容，请参考：https://autofac.readthedocs.io/en/latest/lifetime/instance-scope.html

四、总结

本文主要简单演示了 Asp.Net Core 中默认的几种服务生命周期效果，也抛砖引玉的说了下 Autofac 中的服务生命周期。合理的利用生命周期，能够减小对象的建立，提交程序性能。可是，用错了生命周期，则容易产生隐含的bug。在使用 DI 类库的时候，必定要理解清楚不一样的生命周期的应用场景。

本文示例代码：https://github.com/hstarorg/HstarDemoProject/tree/master/dotnet_demo/servicelifttime-demo/ServicelifttimeDemo

本文github地址