在前面的章節(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接口的示例都是固定初始化好的一個單例實例 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