ASP.NET Core依賴注入初識與思考

艾三元發表於2021-04-02
ASP.NET依賴注入

文章首發地址

一、前言

在上一篇中，我們講述了什麼是控制反轉(IoC)以及通過哪些方式實現的。這其中，我們明白了，控制反轉（IoC） 是一種軟體設計的模式，指導我們設計出更優良，更具有鬆耦合的程式，而具體的實現方式有依賴注入和依賴查詢。

在上篇例項中，我們通過日誌的方式舉例說明，其中通過程式碼建立了一個ILogger的介面，並實現介面例項，基於控制反轉的模式，依賴的建立也移交到了外部，但是也發現存在了問題，如果類似存在這樣多個介面和實現類，依賴太多，一一建立，沒有統一的管理，這反而增加了實際工作量麻煩。

因此我們需要一個可以統一管理系統中所有的依賴的地方，因此，IoC容器誕生了。

容器負責兩件事情：

  • 繫結服務與例項之間的關係
  • 獲取例項，並管理例項物件生命週期（建立與銷燬）

所以在這一篇中，我們主要講述Asp.Net Core中內建的IoC容器。

二、說明

在Asp.Net Core中已經為我們整合提供了一個內建的IoC容器，我們可以看到在Startup.cs的ConfigureServices中，涉及到依賴注入的核心元件,一個負責例項註冊的IServiceCollection和一個負責提供例項的IServiceProvider

簡單的說就是兩步：1. 把例項註冊到容器中；2. 從容器中獲取例項

而在這其中，IServiceCollection為實現將開發者定義好的例項註冊進去提供了三種方法。

分別是：

AddTransient 、AddScoped 、AddSingleton

而這三種不同例項方法也對應的著三種不同的例項生命週期。

三種不同的生命週期：

2.1 暫時性

AddTransient

每次在向服務容器進行請求時都會建立新的例項，這種生存期適合輕量級、 無狀態的服務。

2.2 作用域內

AddScoped

在每次Web請求時被建立一次例項，生命週期橫貫整次請求。

區域性單例物件, 在某個區域性內是同一個物件(作用域單例,本質是容器單例);一次請求內是一個單例物件，多次請求則多個不同的單例物件。

2.3 單例

AddSingleton

建立單例生命週期服務的情況如下：

  • 在首次請求它們時進行建立；
  • 或者在向容器直接提供實現例項時由開發人員進行建立。 很少用到此方法。

其後的每一個後續請求都使用同一個例項。如果開發者的應用需要單例服務情景，推薦的做法是交給服務容器來負責單例的建立和生命週期管理，而不是手動實現單例模式然後由開發者在自定義類中進行操作。

不要從單一例項解析指定了作用域的服務。 當處理後續請求時，它可能會導致服務處於不正確的狀態。 可以從範圍內或暫時性服務解析單一例項服務。

三、開始

3.1 介面

定義三個介面，分別測試Singleton，Scope，Transient三種，一個 TestService服務

    public interface ITransientService
    {
           string GetGuid();
    }

    public interface IScopedService
    {
        string GetGuid();
    }


    public interface ISingletonService
    {
        string GetGuid();
    }

    public interface ITestService  
    {
        public  string GetSingletonID();
        public string GetTransientID();
        public string GetScopedID();
    }

3.2 實現

根據上面定義的幾種介面，並一一實現對應的介面


    public class TransientService : ITransientService
    {
        public string OperationId { get; }
        public TransientService()
        {
            OperationId = Guid.NewGuid().ToString()[^4..];
        }
        public string GetGuid()
        {
            return $"這是一個 Transient service ： " + OperationId;
        }
    }


    public class ScopedService : IScopedService
    {
        public string OperationId { get; }
        public ScopedService()
        {
            OperationId = Guid.NewGuid().ToString()[^4..];
        }

        public string GetGuid()
        {
            return $"這是一個 scoped service ： "+ OperationId;  
        }
    }

    public class SingletonService : ISingletonService
    {
        public string OperationId { get; }
        public SingletonService()
        {
            OperationId = Guid.NewGuid().ToString()[^4..];
        }


        public string GetGuid()
        {
            return $"這是一個 Singleton service ： " + OperationId;
        }
    }

    public class TestService : ITestService
    {
        private ITransientService _transientService;
        private IScopedService _scopedService;
        private ISingletonService _singletonService;
        public TestService(ITransientService transientService, IScopedService scopedService, ISingletonService singletonService)
        {
            _transientService = transientService;
            _scopedService = scopedService;
            _singletonService = singletonService;
        }

        public string GetSingletonID()
        {
            return _singletonService.GetGuid();
        }
        public string GetTransientID()
        {
            return _transientService.GetGuid();
        }
        public string GetScopedID()
        {
            return _scopedService.GetGuid();
        }
    }

3.3 注入

在Startup.cs類檔案ConfigureServices方法中，注入依賴

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
            services.AddTransient<ITransientService, TransientService>();
            services.AddSingleton<ISingletonService, SingletonService>();
            services.AddScoped<IScopedService, ScopedService>();
            services.AddScoped<ITestService, TestService>();
        }

3.4 呼叫

定義一個控制器，實現呼叫

[ApiController]
[Route("[controller]")]
public class TestController : ControllerBase
{
    private ITransientService _transientService;
    private IScopedService _scopedService;
    private ISingletonService _singletonService; 
    private ITestService _testService;
    public TestController(ITransientService transientService, IScopedService scopedService, ISingletonService singletonService, 
       ITestService  testService
        )
    {
        _transientService = transientService;
        _scopedService = scopedService;
        _singletonService = singletonService;
         
        _testService = testService;
    }

    [HttpGet]
    public JsonResult Get()
    {
        var data1 =   _transientService.GetGuid();
        var data2 = _testService.GetTransientID();

        var data3 = _scopedService.GetGuid();
        var data4 = _testService.GetScopedID();

        var data5 = _singletonService.GetGuid();
        var data6 = _testService.GetSingletonID();
        return new JsonResult(new { 
            data1, 
            data2, 
            data3 ,

            data4,
            data5,
            data6,
        });
    }
}

在上面中我們瞭解到，注入的方式一般有三種,建構函式注入, 方法注入,屬性注入，而在ASP.NET Core中自帶的這個IoC容器,預設採用了建構函式注入的方式。

3.5 測試

啟動執行專案，訪問介面/Test

效果如下：

3.6 對比

對比兩次的請求訪問可以發現，上面我們一共得到了 4個Transient例項，2個Scope例項，1個Singleton例項。

在請求中，AddSingleton方式的id值相同；

AddScope方式兩次請求之間不同，但同一請求內是相同的；

AddTransient方式在同一請求內的多次注入間都不相同。

3.7小結

通過上述的程式碼示例，也證實了之前的三種方式對應不同生命週期的說明。

暫時性(Transient) : 生命週期是每次獲得物件都是一次新的物件,每一次都不一樣。

作用域內(Scoped) : 生命週期是在每一次請求作用域內是同一個物件，非作用域內則是新的物件。

單例（Singletion) : 生命週期是這個服務啟動後都是一個物件，也即是全域性單例物件。

四、其他Ioc容器

通過上述的瞭解，我們知道IoC容器是一個依賴注入框架，在.NET Core中也提供了內建的IoC容器，通過AddXXX方法來例項依賴物件，而在實際開發中，就是每一個例項都需要一個個的新增，這樣的實現方式在小專案中還好，但是如果在複雜大型的專案中，就略向麻煩些，可能需要新增很多方法來實現，整體的可觀性也不好。

為了達到可以簡化我們工作量，應該採用批量註冊，因此我們也可以引入其他的Ioc容器框架，實現更多的功能和擴充套件。

在平時開發中，常用的IoC框架有很多，而在這裡我們選擇用Autofac，這也是在.net下比較流行的，其他的框架不做說明，可自行查閱瞭解。

ASP.Net Core中使用Autofac 框架注入 (在後續篇章會具體說明)

五、思考

在實際的開發中，對於這幾種生命週期，我們應該如何應用呢？

比如，在像DBContext這種例項，在實際開發中是用Transient 還是Scoped呢？

建議使用Scoped

因為有些物件在請求中可以需要用到多個方法或者多個Service、Repository的時候，為了減少例項初始化的消耗，實現事務功能，可以在整個請求的生命週期共用一個Scope。

其他的思考：

  1. ASP.NET Core中，預設採用了建構函式注入的方式，如果採用屬性注入或者方法注入，又該怎麼實現？
  2. 一個介面多種實現的時候，我們將多種實現都給注入進了依賴注入容器中，但是在服務呼叫的時候總是獲取到最後注入的那個方法的實現，這時候就在想能不能實現動態的選擇使用哪種實現呢？
  3. 一個作用域（Scoped）服務中注入一個瞬時（Transient）服務時，瞬時服務中的值還會每次都變化嗎？
  4. 鏈式注入時，生存期的選擇，三種注入方式的權重問題

以上的思考，大家可以說說自己的想法

在後續的篇章中，也會對這些問題，進行深入討論說明。

六、總結

本篇主要介紹了什麼是IoC容器，瞭解到它是DI構造函注入的框架，它管理著依賴項的生命週期以及對映關係，同時也介紹實踐了在ASP.Net Core中,預設提供的內建IoC容器，以及它的例項註冊方式和相應的生命週期。

好啦，這篇文章就先講述到這裡吧，在後續篇章中會對ASP.Net Core中使用Autofac 框架實踐說明，希望對大家有所幫助。

如果有不對的或不理解的地方，希望大家可以多多指正，提出問題，一起討論,不斷學習,共同進步。?

相關文章