解讀ASP.NET 5 & MVC6系列（7）：依賴注入
在前面的章節(jié)(Middleware章節(jié))中，我們提到了依賴注入功能(Dependency Injection)，ASP.NET 5正式將依賴注入進行了全功能的實現(xiàn)，以便開發(fā)人員能夠開發(fā)更具彈性的組件程序，MVC6也利用了依賴注入的功能重新對Controller和View的服務(wù)注入功能進行了重新設(shè)計;未來的依賴注入功能還可能提供更多的API，所有如果還沒有開始接觸依賴注入的話，就得好好學一下了。
在之前版本的依賴注入功能里，依賴注入的入口有MVC中的IControllerFactory和Web API中的IHttpControllerActivator中，在新版ASP.NET5中，依賴注入變成了***層的基礎(chǔ)支撐，MVC、Routing、SignalR、Entity Framrwork等都依賴于依賴注入的IServiceProvider接口，針對該接口微軟給出了默認的實現(xiàn)ServiceProvider，以及Ninject和AutoFac版本的包裝，當然你也可以使用其它第三方的依賴注入容器，如Castle Windsor等;一旦應(yīng)用了第三方容器，所有的依賴解析都會被路由到該第三方容器上。
針對通用的依賴類型的解析與創(chuàng)建，微軟默認定義了4種類別的生命周期，分別如下：
類型注冊與示例
依賴注入類型的注冊一般是在程序啟動的入口中，如Startup.cs中的ConfigureServices中，該類的主要目的就是注冊依賴注入的類型。由于依賴注入的主要體現(xiàn)是接口編程，所以本例中，我以接口和實現(xiàn)類的方式來舉例。
首先聲明一個接口ITodoRepository和實現(xiàn)類TodoRepository1，代碼如下：
public interface ITodoRepository
{
IEnumerable 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 _items = new List(); public IEnumerable 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; } }
為了演示不同的聲明周期類型，建議多實現(xiàn)幾個類，比如TodoRepository2、TodoRepository3、TodoRepository4等，以便進行演示。然后在ConfigureServices方法內(nèi)注冊接口ITodoRepository類型和對應(yīng)的實現(xiàn)類，本例中根據(jù)不同的生命周期注冊了不同的實現(xiàn)類，具體示例如下：
- //注冊單例模式，整個應(yīng)用程序周期內(nèi)ITodoRepository接口的示例都是TodoRepository1的一個單例實例
- services.AddSingleton
依賴注入的在MVC中的使用方式目前有三種，分別是Controller的構(gòu)造函數(shù)、屬性以及View中的Inject形式。其中構(gòu)造函數(shù)注入和之前的MVC中的是一樣的，示例代碼如下：
- public class TodoController : Controller
- {
- private readonly ITodoRepository _repository;
- /// 依賴注入框架會自動找到ITodoRepository實現(xiàn)類的示例，賦值給該構(gòu)造函數(shù)
- public TodoController(ITodoRepository repository)
- {
- _repository = repository;
- }
- [HttpGet]
- public IEnumerable GetAll() { return _repository.AllItems; //這里就可以使用該對象了 } }
屬性注入，則是通過在屬性上加一個[Activate]屬性即可實現(xiàn)自動獲取實例。
- public class TodoController : Controller
- {
- // 依賴注入框架會自動找到ITodoRepository實現(xiàn)類的示例，賦值給該屬性
- [Activate]
- public ITodoRepository Repository { get; set; }
- [HttpGet]
- public IEnumerable GetAll() { return Repository.AllItems; } }
注意：這種方式，目前只適用于Controller以及子類，不適用于普通類
同時：通過這種方式，你可以獲取到更多的系統(tǒng)實例對象，如ActionContext、HttpContext、HttpRequest、HttpResponse、 ViewDataDictionary、以及ActionBindingContext。在視圖中，則可以通過@inject關(guān)鍵字來實現(xiàn)注入類型的實例提取，示例如下：
- @using WebApplication1
- @inject ITodoRepository repository
- @repository.AllItems.Count()
而最一般的使用方式，則是獲取IServiceProvider的實例，獲取該IServiceProvider實例的方式目前有如下幾種(但范圍不同)：
- var provider1 = this.Request.HttpContext.ApplicationServices; 當前應(yīng)用程序里注冊的Service
- var provider2 = Context.RequestServices; // Controller中，當前請求作用域內(nèi)注冊的Service
- var provider3 = Resolver; //Controller中
然后通過GetService和GetRequiredService方法來獲取指定類型的實例，示例如下：
var _repository1 = provider1.GetService(typeof(ITodoRepository)); var _repository2 = provider1.GetService();//等價形式 //上述2個對象可能為空 var _repository3 = provider1.GetRequiredService(typeof(ITodoRepository)); var _repository4 = provider1.GetRequiredService ();//等價形式 //上述2個對象肯定不為空，因為如果為空的話，會自動拋異常出來
普通類的依賴注入
在新版的ASP.NET5中，不僅支持上面我們所說的接口類的依賴注入，還支持普通的類型的依賴注入，比如我們生命一個普通類，示例如下：
- public class AppSettings
- {
- public string SiteTitle { get; set; }
- }
上述普通類要保證有無參數(shù)構(gòu)造函數(shù)，那么注冊的用法，就應(yīng)該像如下這樣：
- services.Configure(app => { app.SiteTitle = "111"; });
使用的時候，則需要獲取IOptions
- var appSettings = app.ApplicationServices.GetRequiredService
當然，我們也可以在視圖中，使用@inject語法來獲取實例，示例代碼如下：
- @inject IOptions<AppSettings> AppSettings
- <title>@AppSettings.Options.SiteTitle</title>
基于Scope生命周期的依賴注入
普通的Scope依賴注入
基于Scope作用域的實例在創(chuàng)建的時候需要先創(chuàng)建作用域，然后在該作用域內(nèi)再獲取特定的實例，我們看看一個示例并對其進行驗證。首先，注冊依賴注入類型，代碼如下：
services.AddScoped
然后創(chuàng)建作用域，并在該作用域內(nèi)獲取實例：
var serviceProvider = Resolver; var scopeFactory = serviceProvider.GetService(); //獲取Scope工廠類 using (var scope = scopeFactory.CreateScope()) // 創(chuàng)建一個Scope作用域 { var containerScopedService = serviceProvider.GetService (); //獲取普通的實例 var scopedService1 = scope.ServiceProvider.GetService (); //獲取當前Scope的實例 Thread.Sleep(200); var scopedService2 = scope.ServiceProvider.GetService (); //獲取當前Scope的實例 Console.WriteLine(containerScopedService == scopedService1); // 輸出：False Console.WriteLine(scopedService1 == scopedService2); //輸出：True }
另外，Scope也可以進行嵌套，嵌套的內(nèi)外作用域所獲取的實例也是不相同的，實例代碼如下：
var serviceProvider = Resolver; var outerScopeFactory = serviceProvider.GetService(); using (var outerScope = outerScopeFactory.CreateScope()) //外部Scope作用域 { var innerScopeFactory = outerScope.ServiceProvider.GetService (); using (var innerScope = innerScopeFactory.CreateScope()) //內(nèi)部Scope作用域 { var outerScopedService = outerScope.ServiceProvider.GetService (); var innerScopedService = innerScope.ServiceProvider.GetService (); Console.WriteLine(outerScopedService == innerScopedService); // 輸出：False } }
基于HTTP請求的Scope依賴注入
在之前很多流行的DI容器中，針對每個請求，在該請求作用域內(nèi)保留一個單實例對象是很流行的，也就是在每次請求期間一個類型的對象實例只會創(chuàng)建一次，這樣可以大大提高性能。
在ASP.NET5中，基于HTTP請求的Scope依賴注入是通過一個ContainerMiddleware來實現(xiàn)的，調(diào)用該Middleware時，會創(chuàng)建一個限定作用域的DI容器，用于替換當前請求中已有的默認DI容器。在該管線中，所有后續(xù)的Middleware都會使用這個新的DI容器，在請求走完整個Pipeline管線以后，該ContainerMiddleware的作用就結(jié)束了，此時作用域會被銷毀，并且在該作用域內(nèi)創(chuàng)建的實例對象也都會銷毀釋放。
ContainerMiddleware的時序圖如下所示：
具體的使用方式如下：
- app.Use(new Func
普通類的依賴注入處理
目前普通類的依賴注入，只支持構(gòu)造函數(shù)，比如我們定于一個TestService類，代碼如下：
- public class TestService
- {
- private ITodoRepository _repository;
- public TestService(ITodoRepository r)
- {
- _repository = r;
- }
- public void Show()
- {
- Console.WriteLine(_repository.AllItems);
- }
- }
通過在構(gòu)造函數(shù)里傳入ITodoRepository類的參數(shù)來使用該實例，使用的時候需要先將該類注冊到DI容器中，代碼如下：
- services.AddScoped
然后調(diào)用如下語句即可使用：
- var service = serviceProvider.GetRequiredService();
另外，需要注意，在目前的情況下，不能使用[Activate]來使用依賴注入功能，比如，如下代碼在獲取TestService2實例的過程中會出現(xiàn)錯誤：
- public class TestService2
- {
- [Activate]
- public ITodoRepository Repository { get; set; }
- public void Show()
- {
- Console.WriteLine(Repository.AllItems);
- }
- }
普通類中獲取HttpContext實例
在MVC6中，我們沒辦法通過HttpContent.Current來獲取上下文對象了，所以在普通類中使用的時候就會出問題，要想在普通類中使用該上下文對象，需要通過依賴注入來獲取HttpContext實例，微軟在ASP.NET5中，提供了IHttpContextAccessor接口用于獲取該上下文對象。也就是說，我們可以將該類型的參數(shù)放在構(gòu)造函數(shù)中，以獲取上下文實例，代碼如下：
- 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(); service.Show();
提示：普通類的構(gòu)造函數(shù)中，可以傳入多個DI容器支持的數(shù)據(jù)類似作為參數(shù)。
使用第三方DI容器
目前，.NETCore不支持，只能在全功能版的.NET framework上才能使用，所以使用的時候需要注意一下。第三方DI容器的替換通常是在Startup.cs的Configure方法中進行的，在方法的開始處進行替換，以便后續(xù)的Middleware會使用相關(guān)的依賴注入功能。
首先要引入第三方的容器，以Autofac為例，引入Microsoft.Framework.DependencyInjection.Autofac，然后加入如下示例中的替換代碼即可：
- app.UseServices(services =>
- {
- services.AddMvc();// AddMvc要在這里注冊
- var builder = new ContainerBuilder();// 構(gòu)造容器構(gòu)建類
- builder.Populate(services);//將現(xiàn)有的Services路由到Autofac的管理集合中
- IContainer container = builder.Build();
- return container.Resolve();//返回AutoFac實現(xiàn)的IServiceProvider });
注意，使用上述方法的時候，要把Mvc的注冊代碼services.AddMvc();必須要從ConfigureServices中挪到該表達式內(nèi)，否則會報異常，等待微軟解決。另外，還有一個方式，微軟目前的實例項目中還沒有公開，通過分析一些代碼，我們可以發(fā)現(xiàn)，在Microsoft.AspNet.Hosting程序中的StartupLoader.cs負責程序入口點的執(zhí)行，在該文件中，我們知道首先是調(diào)用Startup.cs中的ConfigureServices方法，然后再調(diào)用Configure方法;我們可以看到示例中的ConfigureServices的返回值是void類型的，但在源碼分析中發(fā)現(xiàn)，在根據(jù)約定解析ConfigureServices方法的時候，其首先判斷有沒有返回類型是IServiceProvider的，如果有則執(zhí)行該方法，用使用該返回中返回的新IServiceProvider實例;沒有的話，再繼續(xù)查找void類型的ConfigureServices方法。所以，我們可以通過這種方式，來替換第三方的DI容器，實例代碼如下：
// 需要先刪除void類型的ConfigureServices方法
public IServiceProvider ConfigureServices(IServiceCollection services)
{
var builder = new ContainerBuilder(); // 構(gòu)造容器構(gòu)建類
builder.Populate(services); //將現(xiàn)有的Services路由到Autofac的管理集合中
IContainer container = builder.Build();
return container.Resolve(); //返回AutoFac實現(xiàn)的IServiceProvider }
這樣，你就可以像以往一樣，使用Autofac的方式進行依賴類型的管理了，示例如下：
public class AutofacModule : Module
{
protected override void Load(ContainerBuilder builder)
{
builder.Register(c => new Logger())
.As() .InstancePerLifetimeScope(); builder.Register(c => new ValuesService(c.Resolve())) .As() .InstancePerLifetimeScope(); } }
地址：https://github.com/aspnet/Hosting/blob/dev/src/Microsoft.AspNet.Hosting/Startup/StartupLoader.cs
另外一個關(guān)于Autofac集成的案例：http://alexmg.com/autofac-4-0-alpha-1-for-asp-net-5-0-beta-3/
***實踐
在使用依賴注入的的時候，我們應(yīng)該遵守如下***實踐。
做任何事情之前，務(wù)必在程序入口點提前注冊所有的依賴類型。
避免直接使用IServiceProvider接口，相反，在構(gòu)造函數(shù)里顯式添加需要依賴的類型即可，讓依賴注入引擎自己來解析實例，一旦依賴很難管理的話，就使用抽象工廠。
基于接口進行編程，而不是基于實現(xiàn)進行編程。
參考2：http://blogs.msdn.com/b/webdev/archive/2014/06/17/dependency-injection-in-asp-net-vnext.aspx
