解讀ASP.NET 5 & MVC6系列（7）：依賴注入

阿新 • • 發佈：2018-12-29

在前面的章節（Middleware章節）中，我們提到了依賴注入功能（Dependency Injection），ASP.NET 5正式將依賴注入進行了全功能的實現，以便開發人員能夠開發更具彈性的元件程式，MVC6也利用了依賴注入的功能重新對Controller和View的服務注入功能進行了重新設計；未來的依賴注入功能還可能提供更多的API，所有如果還沒有開始接觸依賴注入的話，就得好好學一下了。

在之前版本的依賴注入功能裡，依賴注入的入口有MVC中的IControllerFactory和Web API中的IHttpControllerActivator中，在新版ASP.NET5中，依賴注入變成了最底層的基礎支撐，MVC、Routing、SignalR、Entity Framrwork等都依賴於依賴注入的IServiceProvider

介面，針對該介面微軟給出了預設的實現ServiceProvider，以及Ninject和AutoFac版本的包裝，當然你也可以使用其它第三方的依賴注入容器，如Castle Windsor等；一旦應用了第三方容器，所有的依賴解析都會被路由到該第三方容器上。

針對通用的依賴型別的解析與建立，微軟預設定義了4種類別的生命週期，分別如下：

型別	描述
Instance	任何時間都只能使用特定的例項物件，開發人員需要負責該物件的初始化工作。
Transient	每次都重新建立一個例項。
Singleton	建立一個單例，以後每次呼叫的時候都返回該單例物件。
Scoped	在當前作用域內，不管呼叫多少次，都是一個例項，換了作用域就會再次建立例項，類似於特定作用內的單例。

型別註冊與示例

依賴注入型別的註冊一般是在程式啟動的入口中，如Startup.cs中的ConfigureServices中，該類的主要目的就是註冊依賴注入的型別。由於依賴注入的主要體現是介面程式設計，所以本例中，我以介面和實現類的方式來舉例。

首先宣告一個介面ITodoRepository和實現類TodoRepository1，程式碼如下：

public interface ITodoRepository
{
    IEnumerable<TodoItem> AllItems { get; }
    void Add(TodoItem item);
    TodoItem GetById(int id);
    bool TryDelete(int id);
}

public class TodoItem
{
    public int Id { get; set; }
    public string Name { get; set; }
}

public class TodoRepository : ITodoRepository
{
    readonly List<TodoItem> _items = new List<TodoItem>();

    public IEnumerable<TodoItem> AllItems
    {
        get { return _items; }
    }

    public TodoItem GetById(int id)
    {
        return _items.FirstOrDefault(x => x.Id == id);
    }

    public void Add(TodoItem item)
    {
        item.Id = 1 + _items.Max(x => (int?)x.Id) ?? 0;
        _items.Add(item);
    }

    public bool TryDelete(int id)
    {
        var item = GetById(id);

        if (item == null) { return false; }

        _items.Remove(item);

        return true;
    }
}

為了演示不同的宣告週期型別，建議多實現幾個類，比如TodoRepository2、TodoRepository3、TodoRepository4等，以便進行演示。

然後在ConfigureServices方法內註冊介面ITodoRepository型別和對應的實現類，本例中根據不同的生命週期註冊了不同的實現類，具體示例如下：

//註冊單例模式，整個應用程式週期內ITodoRepository介面的示例都是TodoRepository1的一個單例例項
services.AddSingleton<ITodoRepository, TodoRepository1>();
services.AddSingleton(typeof(ITodoRepository), typeof(TodoRepository1));  // 等價形式

//註冊特定例項模型，整個應用程式週期內ITodoRepository介面的示例都是固定初始化好的一個單例例項

TodoRepository2
services.AddInstance<ITodoRepository>(new TodoRepository2());
services.AddInstance(typeof(ITodoRepository), new TodoRepository2());  // 等價形式

//註冊作用域型的型別，在特定作用域內ITodoRepository的示例是TodoRepository3
services.AddScoped<ITodoRepository, TodoRepository3>();
services.AddScoped(typeof(ITodoRepository), typeof(TodoRepository3));// 等價形式

//獲取該ITodoRepository例項時，每次都要例項化一次TodoRepository4類
services.AddTransient<ITodoRepository, TodoRepository4>();
services.AddTransient(typeof(ITodoRepository), typeof(TodoRepository));// 等價形式

//如果要注入的類沒有介面，那你可以直接注入自身型別，比如：
services.AddTransient<LoggingHelper>();

依賴注入的在MVC中的使用方式目前有三種，分別是Controller的建構函式、屬性以及View中的Inject形式。其中建構函式注入和之前的MVC中的是一樣的，示例程式碼如下：

public class TodoController : Controller
{
    private readonly ITodoRepository _repository;

    /// 依賴注入框架會自動找到ITodoRepository實現類的示例，賦值給該建構函式
    public TodoController(ITodoRepository repository)
    {
        _repository = repository;
    }

    [HttpGet]
    public IEnumerable<TodoItem> GetAll()
    {
        return _repository.AllItems;  //這裡就可以使用該物件了
    }
}

屬性注入，則是通過在屬性上加一個[FromServices]屬性即可實現自動獲取例項。

public class TodoController : Controller
{
    // 依賴注入框架會自動找到ITodoRepository實現類的示例，賦值給該屬性
    [FromServices]
    public ITodoRepository Repository { get; set; }

    [HttpGet]
    public IEnumerable<TodoItem> GetAll()
    {
        return Repository.AllItems;
    }
}

注意：這種方式，目前只適用於Controller以及子類，不適用於普通類
同時：通過這種方式，你可以獲取到更多的系統例項物件，如ActionContext、HttpContext、HttpRequest、HttpResponse、 ViewDataDictionary、以及ActionBindingContext。

在檢視中，則可以通過@inject關鍵字來實現注入型別的例項提取，示例如下：

@using WebApplication1
@inject ITodoRepository repository
<div>
    @repository.AllItems.Count()
</div>

而最一般的使用方式，則是獲取IServiceProvider的例項，獲取該IServiceProvider例項的方式目前有如下幾種（但範圍不同）：

var provider1 = this.Request.HttpContext.ApplicationServices; 當前應用程式裡註冊的Service
var provider2 = Context.RequestServices;  // Controller中，當前請求作用域內註冊的Service
var provider3 = Resolver; //Controller中

然後通過GetService和GetRequiredService方法來獲取指定型別的例項，示例如下：

var _repository1 = provider1.GetService(typeof(ITodoRepository));
var _repository2 = provider1.GetService<LoggingHelper>();//等價形式
//上述2個物件可能為空

var _repository3 = provider1.GetRequiredService(typeof(ITodoRepository));
var _repository4 = provider1.GetRequiredService<LoggingHelper>();//等價形式
//上述2個物件肯定不為空，因為如果為空的話，會自動拋異常出來

普通類的依賴注入

在新版的ASP.NET5中，不僅支援上面我們所說的介面類的依賴注入，還支援普通的型別的依賴注入，比如我們生命一個普通類，示例如下：

public class AppSettings
{
    public string SiteTitle { get; set; }
}

上述普通類要保證有無引數建構函式，那麼註冊的用法，就應該像如下這樣：

services.Configure<AppSettings>(app =>
{
    app.SiteTitle = "111";
});

使用的時候，則需要獲取IOptions<AppSettings>型別的例項，然後其Options屬性即是AppSettings的例項，程式碼如下：

var appSettings = app.ApplicationServices.GetRequiredService<IOptions<AppSettings>>().Options;

當然，我們也可以在檢視中，使用@inject語法來獲取例項，示例程式碼如下：

@inject IOptions<AppSettings> AppSettings

<title>@AppSettings.Options.SiteTitle</title>

基於Scope生命週期的依賴注入

普通的Scope依賴注入

基於Scope作用域的例項在建立的時候需要先建立作用域，然後在該作用域內再獲取特定的例項，我們看看一個示例並對其進行驗證。首先，註冊依賴注入型別，程式碼如下：

services.AddScoped<ITodoRepository, TodoRepository>();

然後建立作用域，並在該作用域內獲取例項：

var serviceProvider = Resolver;

var scopeFactory = serviceProvider.GetService<IServiceScopeFactory>(); //獲取Scope工廠類
using (var scope = scopeFactory.CreateScope())  // 建立一個Scope作用域
{
    var containerScopedService = serviceProvider.GetService<ITodoRepository>();  //獲取普通的例項
    var scopedService1 = scope.ServiceProvider.GetService<ITodoRepository>(); //獲取當前Scope的例項
    Thread.Sleep(200);
    var scopedService2 = scope.ServiceProvider.GetService<ITodoRepository>(); //獲取當前Scope的例項

    Console.WriteLine(containerScopedService == scopedService1); // 輸出：False
    Console.WriteLine(scopedService1 == scopedService2); //輸出：True
}

另外，Scope也可以進行巢狀，巢狀的內外作用域所獲取的例項也是不相同的，例項程式碼如下：

var serviceProvider = Resolver;

var outerScopeFactory = serviceProvider.GetService<IServiceScopeFactory>();
using (var outerScope = outerScopeFactory.CreateScope()) //外部Scope作用域
{
    var innerScopeFactory = outerScope.ServiceProvider.GetService<IServiceScopeFactory>();
    using (var innerScope = innerScopeFactory.CreateScope()) //內部Scope作用域
    {
        var outerScopedService = outerScope.ServiceProvider.GetService<ITodoRepository>();
        var innerScopedService = innerScope.ServiceProvider.GetService<ITodoRepository>();

        Console.WriteLine(outerScopedService == innerScopedService); // 輸出：False
    }
}

基於HTTP請求的Scope依賴注入

在之前很多流行的DI容器中，針對每個請求，在該請求作用域內保留一個單例項物件是很流行的，也就是在每次請求期間一個型別的物件例項只會建立一次，這樣可以大大提高效能。

在ASP.NET5中，基於HTTP請求的Scope依賴注入是通過一個ContainerMiddleware來實現的，呼叫該Middleware時，會建立一個限定作用域的DI容器，用於替換當前請求中已有的預設DI容器。在該管線中，所有後續的Middleware都會使用這個新的DI容器，在請求走完整個Pipeline管線以後，該ContainerMiddleware的作用就結束了，此時作用域會被銷燬，並且在該作用域內建立的例項物件也都會銷燬釋放。

ContainerMiddleware的時序圖如下所示：

具體的使用方式如下：

app.Use(new Func<RequestDelegate, RequestDelegate>(nextApp => new ContainerMiddleware(nextApp, app.ApplicationServices).Invoke));

普通類的依賴注入處理

目前普通類的依賴注入，只支援建構函式，比如我們定於一個TestService類，程式碼如下：

public class TestService
{
    private ITodoRepository _repository;
    public TestService(ITodoRepository r)
    {
        _repository = r;
    }

    public void Show()
    {
        Console.WriteLine(_repository.AllItems);
    }
}

通過在建構函式裡傳入ITodoRepository類的引數來使用該例項，使用的時候需要先將該類註冊到DI容器中，程式碼如下：

services.AddScoped<ITodoRepository, TodoRepository>();
services.AddSingleton<TestService>();

然後呼叫如下語句即可使用：

var service = serviceProvider.GetRequiredService<TestService>();

另外，需要注意，在目前的情況下，不能使用[FromServices]來使用依賴注入功能，比如，如下程式碼在獲取TestService2例項的過程中會出現錯誤：

public class TestService2
{
    [FromServices]
    public ITodoRepository Repository { get; set; }
    public void Show()
    {
        Console.WriteLine(Repository.AllItems);
    }
}

普通類中獲取HttpContext例項

在MVC6中，我們沒辦法通過HttpContent.Current來獲取上下文物件了，所以在普通類中使用的時候就會出問題，要想在普通類中使用該上下文物件，需要通過依賴注入來獲取HttpContext例項，微軟在ASP.NET5中，提供了IHttpContextAccessor介面用於獲取該上下文物件。也就是說，我們可以將該型別的引數放在建構函式中，以獲取上下文例項，程式碼如下：

public class TestService3
{
    private IHttpContextAccessor _httpContextAccessor;
    public TestService3(IHttpContextAccessor httpContextAccessor)
    {
        _httpContextAccessor = httpContextAccessor;
    }

    public void Show()
    {
        var httpContext = _httpContextAccessor.HttpContext;//獲取上下文物件例項
        Console.WriteLine(httpContext.Request.Host.Value);
    }
}

而使用的時候，則直接通過如下語句就可以了，程式碼如下：

var service = serviceProvider.GetRequiredService<TestService3>();
service.Show();

提示：普通類的建構函式中，可以傳入多個DI容器支援的資料類似作為引數。

使用第三方DI容器

目前，.NETCore不支援，只能在全功能版的.NET framework上才能使用，所以使用的時候需要注意一下。第三方DI容器的替換通常是在Startup.cs的Configure方法中進行的，在方法的開始處進行替換，以便後續的Middleware會使用相關的依賴注入功能。

首先要引入第三方的容器，以Autofac為例，引入Microsoft.Framework.DependencyInjection.Autofac，然後加入如下示例中的替換程式碼即可：

app.UseServices(services =>
{
    services.AddMvc();// AddMvc要在這裡註冊
    var builder = new ContainerBuilder();// 構造容器構建類
    builder.Populate(services);//將現有的Services路由到Autofac的管理集合中
    IContainer container = builder.Build();
    return container.Resolve<IServiceProvider>();//返回AutoFac實現的IServiceProvider
});

注意，使用上述方法的時候，要把Mvc的註冊程式碼services.AddMvc();必須要從ConfigureServices中挪到該表示式內，否則會報異常，等待微軟解決。

另外，還有一個方式，微軟目前的例項專案中還沒有公開，通過分析一些程式碼，我們可以發現，在Microsoft.AspNet.Hosting程式中的StartupLoader.cs負責程式入口點的執行，在該檔案中，我們知道首先是呼叫Startup.cs中的ConfigureServices方法，然後再呼叫Configure方法；我們可以看到示例中的ConfigureServices的返回值是void型別的，但在原始碼分析中發現，在根據約定解析ConfigureServices方法的時候，其首先判斷有沒有返回型別是IServiceProvider的，如果有則執行該方法，用使用該返回中返回的新IServiceProvider例項；沒有的話，再繼續查詢void型別的ConfigureServices方法。所以，我們可以通過這種方式，來替換第三方的DI容器，例項程式碼如下：

// 需要先刪除void型別的ConfigureServices方法
public IServiceProvider ConfigureServices(IServiceCollection services)
{
    var builder = new ContainerBuilder();  // 構造容器構建類
    builder.Populate(services);  //將現有的Services路由到Autofac的管理集合中
    IContainer container = builder.Build();
    return container.Resolve<IServiceProvider>(); //返回AutoFac實現的IServiceProvider
}

這樣，你就可以像以往一樣，使用Autofac的方式進行依賴型別的管理了，示例如下：

public class AutofacModule : Module
{
    protected override void Load(ContainerBuilder builder)
    {
        builder.Register(c => new Logger())
            .As<ILogger>()
            .InstancePerLifetimeScope();

        builder.Register(c => new ValuesService(c.Resolve<ILogger>()))
            .As<IValuesService>()
            .InstancePerLifetimeScope();
    }
}

地址：https://github.com/aspnet/Hosting/blob/dev/src/Microsoft.AspNet.Hosting/Startup/StartupLoader.cs
另外一個關於Autofac整合的案例：http://alexmg.com/autofac-4-0-alpha-1-for-asp-net-5-0-beta-3/

最佳實踐

在使用依賴注入的的時候，我們應該遵守如下最佳實踐。

做任何事情之前，務必在程式入口點提前註冊所有的依賴型別。
避免直接使用IServiceProvider介面，相反，在建構函式裡顯式新增需要依賴的型別即可，讓依賴注入引擎自己來解析例項，一旦依賴很難管理的話，就使用抽象工廠。
基於介面進行程式設計，而不是基於實現進行程式設計。

參考1：http://social.technet.microsoft.com/wiki/contents/articles/28875.dependency-injection-in-asp-net-vnext.aspx
參考2：http://blogs.msdn.com/b/webdev/archive/2014/06/17/dependency-injection-in-asp-net-vnext.aspx

解讀ASP.NET 5 & MVC6系列（7）：依賴注入

型別註冊與示例

普通類的依賴注入

基於Scope生命週期的依賴注入

普通的Scope依賴注入

基於HTTP請求的Scope依賴注入

普通類的依賴注入處理

普通類中獲取HttpContext例項

使用第三方DI容器

最佳實踐

同步與推薦

解讀ASP.NET 5 & MVC6系列（7）：依賴注入

解讀ASP.NET 5 & MVC6系列（8）：Session與Caching

解讀ASP.NET 5 & MVC6系列（13）：TagHelper

解讀ASP.NET 5 & MVC6系列（16）：自定義View檢視檔案查詢邏輯

解讀ASP.NET 5 & MVC6系列（12）：基於Lamda表示式的強型別Routing實現

解讀ASP.NET 5 & MVC6系列（10）：Controller與Action

解讀ASP.NET 5 & MVC6系列（15）：MvcOptions配置

解讀ASP.NET 5 & MVC6系列（11）：Routing路由

解讀ASP.NET 5 & MVC6系列（14）：View Component

解讀ASP.NET 5 & MVC6系列（17）：MVC中的其他新特性

解讀ASP.NET 5 & MVC6系列（9）：日誌框架

解讀ASP.NET 5 & MVC6系列（3）：專案釋出與部署

解讀ASP.NET 5 & MVC6系列（2）：初識專案

解讀ASP.NET 5 & MVC6系列（1）：ASP.NET 5簡介

解讀ASP.NET 5 & MVC6系列（4）：核心技術與環境配置

解讀ASP.NET 5 & MVC6系列（6）：Middleware詳解

解讀ASP.NET 5 & MVC6系列（5）：Configuration配置資訊管理

Asp.Net MVC4入門指南（7）：給電影表和模型新增新欄位

ASP.NET AJAX入門系列（6）：UpdateProgress控制元件簡單介紹

ASP.NET AJAX入門系列（9）：在母版頁中使用UpdatePanel

解讀ASP.NET 5 & MVC6系列（7）：依賴注入

型別註冊與示例

普通類的依賴注入

基於Scope生命週期的依賴注入

普通的Scope依賴注入

基於HTTP請求的Scope依賴注入

普通類的依賴注入處理

普通類中獲取HttpContext例項

使用第三方DI容器

最佳實踐

同步與推薦

相關推薦