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

在前面的章節（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種類別的生命周期，分別如下：

類型注冊與示例

依賴注入類型的注冊一般是在程序啟動的入口中，如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接口的示例都是固定初始化好的一個單例實例TodoRepository2services.AddInstance<ITodoRepository>(new TodoRepository2());services.AddInstance(typeof(ITodoRepository), new TodoRepository2());  // 等價形式//注冊作用域型的類型，在特定作用域內ITodoRepository的示例是TodoRepository3services.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;  //這里就可以使用該對象了    }}

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

public class TodoController : Controller{    // 依賴注入框架會自動找到ITodoRepository實現類的示例，賦值給該屬性    [Activate]    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; 當前應用程序里注冊的Servicevar provider2 = Context.RequestServices;  // Controller中，當前請求作用域內注冊的Servicevar 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依賴注入