主頁 > 知識(shí)庫 > 解讀ASP.NET 5 & MVC6系列教程(7):依賴注入

解讀ASP.NET 5 & MVC6系列教程(7):依賴注入

熱門標(biāo)簽:外呼電話機(jī)器人成本 地圖標(biāo)注軟件免費(fèi)下載 聯(lián)通官網(wǎng)400電話辦理 蘇州如何辦理400電話 百應(yīng)電話機(jī)器人外呼系統(tǒng) 網(wǎng)絡(luò)電話外呼系統(tǒng)上海 西寧呼叫中心外呼系統(tǒng)線路商 臨沂智能電話機(jī)器人加盟 400電話辦理怎么樣

在前面的章節(jié)(Middleware章節(jié))中,我們提到了依賴注入功能(Dependency Injection),ASP.NET 5正式將依賴注入進(jìn)行了全功能的實(shí)現(xiàn),以便開發(fā)人員能夠開發(fā)更具彈性的組件程序,MVC6也利用了依賴注入的功能重新對(duì)Controller和View的服務(wù)注入功能進(jìn)行了重新設(shè)計(jì);未來的依賴注入功能還可能提供更多的API,所有如果還沒有開始接觸依賴注入的話,就得好好學(xué)一下了。

在之前版本的依賴注入功能里,依賴注入的入口有MVC中的IControllerFactory和Web API中的IHttpControllerActivator中,在新版ASP.NET5中,依賴注入變成了最底層的基礎(chǔ)支撐,MVC、Routing、SignalR、Entity Framrwork等都依賴于依賴注入的IServiceProvider接口,針對(duì)該接口微軟給出了默認(rèn)的實(shí)現(xiàn)ServiceProvider,以及Ninject和AutoFac版本的包裝,當(dāng)然你也可以使用其它第三方的依賴注入容器,如Castle Windsor等;一旦應(yīng)用了第三方容器,所有的依賴解析都會(huì)被路由到該第三方容器上。

針對(duì)通用的依賴類型的解析與創(chuàng)建,微軟默認(rèn)定義了4種類別的生命周期,分別如下:

類型 描述
Instance 任何時(shí)間都只能使用特定的實(shí)例對(duì)象,開發(fā)人員需要負(fù)責(zé)該對(duì)象的初始化工作。
Transient 每次都重新創(chuàng)建一個(gè)實(shí)例。
Singleton 創(chuàng)建一個(gè)單例,以后每次調(diào)用的時(shí)候都返回該單例對(duì)象。
Scoped 在當(dāng)前作用域內(nèi),不管調(diào)用多少次,都是一個(gè)實(shí)例,換了作用域就會(huì)再次創(chuàng)建實(shí)例,類似于特定作用內(nèi)的單例。

類型注冊(cè)與示例

依賴注入類型的注冊(cè)一般是在程序啟動(dòng)的入口中,如Startup.cs中的ConfigureServices中,該類的主要目的就是注冊(cè)依賴注入的類型。由于依賴注入的主要體現(xiàn)是接口編程,所以本例中,我以接口和實(shí)現(xiàn)類的方式來舉例。

首先聲明一個(gè)接口ITodoRepository和實(shí)現(xiàn)類TodoRepository1,代碼如下:

public interface ITodoRepository
{
 IEnumerableTodoItem> 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 ListTodoItem> _items = new ListTodoItem>();

 public IEnumerableTodoItem> 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;
 }
}

為了演示不同的聲明周期類型,建議多實(shí)現(xiàn)幾個(gè)類,比如TodoRepository2、TodoRepository3、TodoRepository4等,以便進(jìn)行演示。

然后在ConfigureServices方法內(nèi)注冊(cè)接口ITodoRepository類型和對(duì)應(yīng)的實(shí)現(xiàn)類,本例中根據(jù)不同的生命周期注冊(cè)了不同的實(shí)現(xiàn)類,具體示例如下:

//注冊(cè)單例模式,整個(gè)應(yīng)用程序周期內(nèi)ITodoRepository接口的示例都是TodoRepository1的一個(gè)單例實(shí)例
services.AddSingletonITodoRepository, TodoRepository1>();
services.AddSingleton(typeof(ITodoRepository), typeof(TodoRepository1)); // 等價(jià)形式

//注冊(cè)特定實(shí)例模型,整個(gè)應(yīng)用程序周期內(nèi)ITodoRepository接口的示例都是固定初始化好的一個(gè)單例實(shí)例

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

//注冊(cè)作用域型的類型,在特定作用域內(nèi)ITodoRepository的示例是TodoRepository3
services.AddScopedITodoRepository, TodoRepository3>();
services.AddScoped(typeof(ITodoRepository), typeof(TodoRepository3));// 等價(jià)形式

//獲取該ITodoRepository實(shí)例時(shí),每次都要實(shí)例化一次TodoRepository4類
services.AddTransientITodoRepository, TodoRepository4>();
services.AddTransient(typeof(ITodoRepository), typeof(TodoRepository));// 等價(jià)形式

//如果要注入的類沒有接口,那你可以直接注入自身類型,比如:
services.AddTransientLoggingHelper>();

依賴注入的在MVC中的使用方式目前有三種,分別是Controller的構(gòu)造函數(shù)、屬性以及View中的Inject形式。其中構(gòu)造函數(shù)注入和之前的MVC中的是一樣的,示例代碼如下:

public class TodoController : Controller
{
 private readonly ITodoRepository _repository;

 /// 依賴注入框架會(huì)自動(dòng)找到ITodoRepository實(shí)現(xiàn)類的示例,賦值給該構(gòu)造函數(shù)
 public TodoController(ITodoRepository repository)
 {
 _repository = repository;
 }

 [HttpGet]
 public IEnumerableTodoItem> GetAll()
 {
 return _repository.AllItems; //這里就可以使用該對(duì)象了
 }
}

屬性注入,則是通過在屬性上加一個(gè)[FromServices]屬性即可實(shí)現(xiàn)自動(dòng)獲取實(shí)例。

public class TodoController : Controller
{
 // 依賴注入框架會(huì)自動(dòng)找到ITodoRepository實(shí)現(xiàn)類的示例,賦值給該屬性
 [FromServices]
 public ITodoRepository Repository { get; set; }

 [HttpGet]
 public IEnumerableTodoItem> GetAll()
 {
 return Repository.AllItems;
 }
}

注意:這種方式,目前只適用于Controller以及子類,不適用于普通類
同時(shí):通過這種方式,你可以獲取到更多的系統(tǒng)實(shí)例對(duì)象,如
ActionContext、HttpContextHttpRequest、HttpResponse、 ViewDataDictionary以及ActionBindingContext。

在視圖中,則可以通過@inject關(guān)鍵字來實(shí)現(xiàn)注入類型的實(shí)例提取,示例如下:

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

而最一般的使用方式,則是獲取IServiceProvider的實(shí)例,獲取該IServiceProvider實(shí)例的方式目前有如下幾種(但范圍不同):

var provider1 = this.Request.HttpContext.ApplicationServices; 當(dāng)前應(yīng)用程序里注冊(cè)的Service
var provider2 = Context.RequestServices; // Controller中,當(dāng)前請(qǐng)求作用域內(nèi)注冊(cè)的Service
var provider3 = Resolver; //Controller中

然后通過GetService和GetRequiredService方法來獲取指定類型的實(shí)例,示例如下:

var _repository1 = provider1.GetService(typeof(ITodoRepository));
var _repository2 = provider1.GetServiceLoggingHelper>();//等價(jià)形式
//上述2個(gè)對(duì)象可能為空

var _repository3 = provider1.GetRequiredService(typeof(ITodoRepository));
var _repository4 = provider1.GetRequiredServiceLoggingHelper>();//等價(jià)形式
//上述2個(gè)對(duì)象肯定不為空,因?yàn)槿绻麨榭盏脑?,?huì)自動(dòng)拋異常出來

普通類的依賴注入

在新版的ASP.NET5中,不僅支持上面我們所說的接口類的依賴注入,還支持普通的類型的依賴注入,比如我們生命一個(gè)普通類,示例如下:

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

上述普通類要保證有無參數(shù)構(gòu)造函數(shù),那么注冊(cè)的用法,就應(yīng)該像如下這樣:

services.ConfigureAppSettings>(app =>
{
 app.SiteTitle = "111";
});

使用的時(shí)候,則需要獲取IOptionsAppSettings>類型的實(shí)例,然后其Options屬性即是AppSettings的實(shí)例,代碼如下:

var appSettings = app.ApplicationServices.GetRequiredServiceIOptionsAppSettings>>().Options;

當(dāng)然,我們也可以在視圖中,使用@inject語法來獲取實(shí)例,示例代碼如下:

@inject IOptionsAppSettings> AppSettings

title>@AppSettings.Options.SiteTitle/title>

基于Scope生命周期的依賴注入

普通的Scope依賴注入

基于Scope作用域的實(shí)例在創(chuàng)建的時(shí)候需要先創(chuàng)建作用域,然后在該作用域內(nèi)再獲取特定的實(shí)例,我們看看一個(gè)示例并對(duì)其進(jìn)行驗(yàn)證。首先,注冊(cè)依賴注入類型,代碼如下:

services.AddScopedITodoRepository, TodoRepository>();

然后創(chuàng)建作用域,并在該作用域內(nèi)獲取實(shí)例:

var serviceProvider = Resolver;

var scopeFactory = serviceProvider.GetServiceIServiceScopeFactory>(); //獲取Scope工廠類
using (var scope = scopeFactory.CreateScope()) // 創(chuàng)建一個(gè)Scope作用域
{
 var containerScopedService = serviceProvider.GetServiceITodoRepository>(); //獲取普通的實(shí)例
 var scopedService1 = scope.ServiceProvider.GetServiceITodoRepository>(); //獲取當(dāng)前Scope的實(shí)例
 Thread.Sleep(200);
 var scopedService2 = scope.ServiceProvider.GetServiceITodoRepository>(); //獲取當(dāng)前Scope的實(shí)例

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

另外,Scope也可以進(jìn)行嵌套,嵌套的內(nèi)外作用域所獲取的實(shí)例也是不相同的,實(shí)例代碼如下:

var serviceProvider = Resolver;

var outerScopeFactory = serviceProvider.GetServiceIServiceScopeFactory>();
using (var outerScope = outerScopeFactory.CreateScope()) //外部Scope作用域
{
 var innerScopeFactory = outerScope.ServiceProvider.GetServiceIServiceScopeFactory>();
 using (var innerScope = innerScopeFactory.CreateScope()) //內(nèi)部Scope作用域
 {
 var outerScopedService = outerScope.ServiceProvider.GetServiceITodoRepository>();
 var innerScopedService = innerScope.ServiceProvider.GetServiceITodoRepository>();

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

基于HTTP請(qǐng)求的Scope依賴注入

在之前很多流行的DI容器中,針對(duì)每個(gè)請(qǐng)求,在該請(qǐng)求作用域內(nèi)保留一個(gè)單實(shí)例對(duì)象是很流行的,也就是在每次請(qǐng)求期間一個(gè)類型的對(duì)象實(shí)例只會(huì)創(chuàng)建一次,這樣可以大大提高性能。

在ASP.NET5中,基于HTTP請(qǐng)求的Scope依賴注入是通過一個(gè)ContainerMiddleware來實(shí)現(xiàn)的,調(diào)用該Middleware時(shí),會(huì)創(chuàng)建一個(gè)限定作用域的DI容器,用于替換當(dāng)前請(qǐng)求中已有的默認(rèn)DI容器。在該管線中,所有后續(xù)的Middleware都會(huì)使用這個(gè)新的DI容器,在請(qǐng)求走完整個(gè)Pipeline管線以后,該ContainerMiddleware的作用就結(jié)束了,此時(shí)作用域會(huì)被銷毀,并且在該作用域內(nèi)創(chuàng)建的實(shí)例對(duì)象也都會(huì)銷毀釋放。

ContainerMiddleware的時(shí)序圖如下所示:

具體的使用方式如下:

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

普通類的依賴注入處理

目前普通類的依賴注入,只支持構(gòu)造函數(shù),比如我們定于一個(gè)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ù)來使用該實(shí)例,使用的時(shí)候需要先將該類注冊(cè)到DI容器中,代碼如下:

services.AddScopedITodoRepository, TodoRepository>();
services.AddSingletonTestService>();

然后調(diào)用如下語句即可使用:

var service = serviceProvider.GetRequiredServiceTestService>();

另外,需要注意,在目前的情況下,不能使用[FromServices]來使用依賴注入功能,比如,如下代碼在獲取TestService2實(shí)例的過程中會(huì)出現(xiàn)錯(cuò)誤:

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

普通類中獲取HttpContext實(shí)例

在MVC6中,我們沒辦法通過HttpContent.Current來獲取上下文對(duì)象了,所以在普通類中使用的時(shí)候就會(huì)出問題,要想在普通類中使用該上下文對(duì)象,需要通過依賴注入來獲取HttpContext實(shí)例,微軟在ASP.NET5中,提供了IHttpContextAccessor接口用于獲取該上下文對(duì)象。也就是說,我們可以將該類型的參數(shù)放在構(gòu)造函數(shù)中,以獲取上下文實(shí)例,代碼如下:

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

 public void Show()
 {
 var httpContext = _httpContextAccessor.HttpContext;//獲取上下文對(duì)象實(shí)例
 Console.WriteLine(httpContext.Request.Host.Value);
 }
}

而使用的時(shí)候,則直接通過如下語句就可以了,代碼如下:

var service = serviceProvider.GetRequiredServiceTestService3>();
service.Show();

提示:普通類的構(gòu)造函數(shù)中,可以傳入多個(gè)DI容器支持的數(shù)據(jù)類似作為參數(shù)。

使用第三方DI容器

目前,.NETCore不支持,只能在全功能版的.NET framework上才能使用,所以使用的時(shí)候需要注意一下。第三方DI容器的替換通常是在Startup.cs的Configure方法中進(jìn)行的,在方法的開始處進(jìn)行替換,以便后續(xù)的Middleware會(huì)使用相關(guān)的依賴注入功能。

首先要引入第三方的容器,以Autofac為例,引入Microsoft.Framework.DependencyInjection.Autofac,然后加入如下示例中的替換代碼即可:

app.UseServices(services =>
{
 services.AddMvc();// AddMvc要在這里注冊(cè)
 var builder = new ContainerBuilder();// 構(gòu)造容器構(gòu)建類
 builder.Populate(services);//將現(xiàn)有的Services路由到Autofac的管理集合中
 IContainer container = builder.Build();
 return container.ResolveIServiceProvider>();//返回AutoFac實(shí)現(xiàn)的IServiceProvider
});

注意,使用上述方法的時(shí)候,要把Mvc的注冊(cè)代碼services.AddMvc();必須要從ConfigureServices中挪到該表達(dá)式內(nèi),否則會(huì)報(bào)異常,等待微軟解決。

另外,還有一個(gè)方式,微軟目前的實(shí)例項(xiàng)目中還沒有公開,通過分析一些代碼,我們可以發(fā)現(xiàn),在Microsoft.AspNet.Hosting程序中的StartupLoader.cs負(fù)責(zé)程序入口點(diǎn)的執(zhí)行,在該文件中,我們知道首先是調(diào)用Startup.cs中的ConfigureServices方法,然后再調(diào)用Configure方法;我們可以看到示例中的ConfigureServices的返回值是void類型的,但在源碼分析中發(fā)現(xiàn),在根據(jù)約定解析ConfigureServices方法的時(shí)候,其首先判斷有沒有返回類型是IServiceProvider的,如果有則執(zhí)行該方法,用使用該返回中返回的新IServiceProvider實(shí)例;沒有的話,再繼續(xù)查找void類型的ConfigureServices方法。所以,我們可以通過這種方式,來替換第三方的DI容器,實(shí)例代碼如下:

// 需要先刪除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.ResolveIServiceProvider>(); //返回AutoFac實(shí)現(xiàn)的IServiceProvider
}

這樣,你就可以像以往一樣,使用Autofac的方式進(jìn)行依賴類型的管理了,示例如下:

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

 builder.Register(c => new ValuesService(c.ResolveILogger>()))
  .AsIValuesService>()
  .InstancePerLifetimeScope();
 }
}

地址:https://github.com/aspnet/Hosting/blob/dev/src/Microsoft.AspNet.Hosting/Startup/StartupLoader.cs
另外一個(gè)關(guān)于Autofac集成的案例:http://alexmg.com/autofac-4-0-alpha-1-for-asp-net-5-0-beta-3/

最佳實(shí)踐

在使用依賴注入的的時(shí)候,我們應(yīng)該遵守如下最佳實(shí)踐。

做任何事情之前,務(wù)必在程序入口點(diǎn)提前注冊(cè)所有的依賴類型。避免直接使用IServiceProvider接口,相反,在構(gòu)造函數(shù)里顯式添加需要依賴的類型即可,讓依賴注入引擎自己來解析實(shí)例,一旦依賴很難管理的話,就使用抽象工廠?;诮涌谶M(jìn)行編程,而不是基于實(shí)現(xiàn)進(jìn)行編程。

參考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

您可能感興趣的文章:
  • .NET Core中依賴注入AutoMapper的方法示例
  • 在.NET Core控制臺(tái)程序中如何使用依賴注入詳解
  • 詳解ASP.NET Core 在 JSON 文件中配置依賴注入
  • 詳解ASP.NET Core 中的框架級(jí)依賴注入
  • ASP.NET MVC實(shí)現(xiàn)依賴注入的完整過程
  • ASP.NET Core 過濾器中使用依賴注入知識(shí)點(diǎn)總結(jié)
  • .NET IoC模式依賴反轉(zhuǎn)(DIP)、控制反轉(zhuǎn)(Ioc)、依賴注入(DI)
  • 詳解asp.net core 依賴注入
  • .NET學(xué)習(xí)筆記之默認(rèn)依賴注入

標(biāo)簽:中衛(wèi) 海西 甘肅 臨夏 慶陽 聊城 清遠(yuǎn)

巨人網(wǎng)絡(luò)通訊聲明:本文標(biāo)題《解讀ASP.NET 5 & MVC6系列教程(7):依賴注入》,本文關(guān)鍵詞  解讀,ASP.NET,amp,MVC6,系列,;如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問題,煩請(qǐng)?zhí)峁┫嚓P(guān)信息告之我們,我們將及時(shí)溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò),涉及言論、版權(quán)與本站無關(guān)。
  • 相關(guān)文章
  • 下面列出與本文章《解讀ASP.NET 5 & MVC6系列教程(7):依賴注入》相關(guān)的同類信息!
  • 本頁收集關(guān)于解讀ASP.NET 5 & MVC6系列教程(7):依賴注入的相關(guān)信息資訊供網(wǎng)民參考!
  • 推薦文章