一文讀懂ASP.NET Core 依賴註入

作者：Emrys5

連結：http://www.cnblogs.com/emrys5/p/aspnetcoredi.html

一、什麼是依賴註入

1、首先在ASP.NET Core中是支援依賴註入軟體設計樣式，或者說依賴註入是ASP.NET Core的核心；

 

2、依賴註入（DI）和控制反轉（IOC）基本是一個意思，因為說起來誰都離不開誰；或者可以說他們是同一個概念的不同角度描述；

 

3、軟體設計原則中有一個依賴倒置原則（DIP），就是為瞭解耦；高層模組不應該依賴於底層模組。二者都應該依賴於抽象；抽象不應該依賴於細節，細節應該依賴於抽象；而依賴註入是實現這種原則的方式之一；

 

4、舉個現實中例子：小明去行政領一節5號電池，然後行政給了小明一節黑象牌5號電池來分析 ；

 

• 小明只需要向行政領一節5號電池即可，小明不需要關心什麼牌子的電池，電池從哪來的，電池的價格等等。他們倆共同需要關心的是一節5號電池即可；

• 即使後期行政給了小明北孚電池，小明仍可以正常使用；他們只需要滿足一個規則（5號電池）即可；

• 小明（高層模組）不應該依賴黑象牌電池（低層模組），兩者應該都依賴5號電池（抽象）。

• 如果小明直接獲取到（new）黑象牌電池，如果後期業務變更提供的是北孚電池，那麼我們就需要更改小明的程式碼；再如果公司有幾百個小明，程式碼量可想而知；

• 為瞭解決直接獲取（new）黑象牌電池，簡單說為瞭解耦，我們讓每位員工透過行政領取（建構式，屬性，方法等），這種即使更改其他品牌，而小明壓根不需要關心；

 

5、舉個.NET Core中的例子：.NET Core中使用分散式快取；

 

• 我們只需要在建構式中獲取IDistributedCache，然後就可以在方法中直接使用快取，我們不需要關心快取的實現方式，儲存位置等等；

• 如果快取從記憶體變成Redis或者sqlserver，甚至自己實現快取，而我們只需要在ConfigureServices中更改具體實現方式即可，而不需要更改任何使用快取的地方；

二、ASP.NET Core 中依賴註入的生命週期

依賴註入的生命週期有三種Transient，Scoped和Singleton；

 

1、Transient每次呼叫都是不同的實體，比如常用的Microsoft.Extensions.Options.IConfigureOptions；

2、Scoped每次請求是同一個實體，如 Entity Framework contexts；

3、Singleton只有一個實體，如Microsoft.Extensions.Logging.ILogger；

 

具體使用哪種，要根據具體情況而定；

 

1、比如我們一般的業務邏輯都是Transient，這個也是比較常用的；

 

2、Scoped相對用的比較少，當然也有很多業務邏輯也有用Scoped的；當然他的妙用肯定是每次請求一個實體，比如我們在系統中獲取登入系統使用者的Id，這時就可以用Scoped，不管在Service層或者Repository層等等，獲取的都是同一個使用者；

 

3、Singleton很多都是系統級別設計用單利，比如日誌；

三、在ASP.NET Core 中使用依賴註入

基礎業務邏輯程式碼，獲取使用者串列

public interface IUserInfoService
{
    IEnumerable GetUserInfo();
}
public class UserInfoService : IUserInfoService
{
    public IEnumerable GetUserInfo()
    {
        // 模擬db獲取資料
        return new List { new UserInfo { Id = 1, Name = "Emrys" }, new UserInfo { Id = 2, Name = "梅林" } };
    }
}
public class UserInfoMongoService : IUserInfoService
{
    public IEnumerable GetUserInfo()
    {
        // 模擬Mongodb獲取資料
        return new List { new UserInfo { Id = 1, Name = "Emrys" }, new UserInfo { Id = 2, Name = "梅林" } };
    }
}
public class UserInfo
{
    public int Id { get; set; }
    public string Name { get; set; }
}

 

1、傳統方式

public class ValuesController : ControllerBase
{
    IUserInfoService _userInfoService = new UserInfoService();
    [HttpGet]
    public IEnumerable Get()
    {
        return _userInfoService.GetUserInfo();
    }
}

 

在傳統方式中，獲取使用者的服務類直接用new的方式，這也是很多初學者或者很多老手最經常使用的方式；從中可以發現程式碼耦合度太高，非常不利於維護，在所有使用到IUserInfoService的地方都要new出物件；

 

如果後期需求變更，需要替換IUserInfoService的實現，比如從Mongodb中獲取資料（現實示例中，從黑象牌變成北孚電池），那麼就需要在所有new出UserInfoService的地方更改程式碼換成UserInfoMongoService，IUserInfoService _userInfoService = new UserInfoMongoService()；

 

我們如果需要new的物件需要實現單例樣式(Singleton)，每次請求new一個物件（Scoped）樣式，那麼還要另寫程式碼實現；

 

2、依賴註入方式

1、在Startup類的ConfigureServices方法中設定註入

public void ConfigureServices(IServiceCollection services)
{
    services.AddTransient();
 services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
}

 

2、在建構式中獲取實體

public class ValuesController : ControllerBase
{
    IUserInfoService _userInfoService;
    public ValuesController(IUserInfoService userInfoService)
    {
        _userInfoService = userInfoService;
    }
    [HttpGet]
    public IEnumerable Get()
    {
        return _userInfoService.GetUserInfo();
    }
}

 

在使用依賴註入方式時，解決了傳統方式耦合度，如果後期變更實現，只要在 services.AddTransient();變更成UserInfoMongoService即可；

 

在所有使用IUserInfoService的地方無須做任何改動；而且可以非常簡單的設定生命週期（Transient，Scoped，Singleton）；

四、總結

1、設定註入和獲取註入的方式不止一種，示例只是演示了最簡單和最常用的使用方式，其他方式可以參考檔案；

 

2、可以替換.net core中的預設註入容器， 如常用的autofac，可以實現更強大的功能；詳情參考 https://autofac.org/；其他容器可以參考  https://github.com/aspnet/Extensions/tree/master/src/DependencyInjection

 

3、可以直接在View中獲取註入 @inject IUserInfoService userInfoService

 

4、可以在httpcontext裡直接獲取註入HttpContext.RequestServices.GetService();

 

5、Startup中的ConfigureServices方法就是為了設定註入而存在的;