ASP.NET?Core依賴注入詳解
ASP.NET Core的底層設(shè)計支持和使用依賴注入。ASP.NET Core應(yīng)用程序可以利用內(nèi)置的框架服務(wù)將它們注入到啟動類的方法中,并且應(yīng)用程序服務(wù)能夠配置注入。由ASP.NET Core提供的默認(rèn)服務(wù)容器提供了最小功能集,并不是要取代其它容器。
一、什么是依賴注入
依賴注入(Dependency injection,DI)是一種實現(xiàn)對象及其合作者或依賴項之間松散耦合的技術(shù)。將類用來執(zhí)行其操作的這些對象以某種方式提供給該類,而不是直接實例化合作者或使用靜態(tài)引用。通常,類會通過它們的構(gòu)造函數(shù)聲明其依賴關(guān)系,允許它們遵循顯示依賴原則。這種方法被稱為“構(gòu)造函數(shù)注入”。
當(dāng)類的設(shè)計使用DI思想時,它們的耦合更加松散,因為它們沒有對它們的合作者直接硬編碼的依賴。這遵循“依賴倒置原則(Dependency Inversion Principle)”,其中指出,“高層模塊不應(yīng)該依賴于低層模塊;兩者都應(yīng)該依賴于抽象”。類要求在它們構(gòu)造時向其提供抽象(通常是interfaces),而不是引用特定的實現(xiàn)。提取接口的依賴關(guān)系和提供這些接口的實現(xiàn)作為參數(shù)也是“策略設(shè)計模式”的一個示例。
當(dāng)系統(tǒng)被設(shè)計使用DI,很多類通過它們的構(gòu)造函數(shù)(或?qū)傩裕┱埱笃湟蕾囮P(guān)系,當(dāng)一個類被用來創(chuàng)建這些類及其相關(guān)的依賴關(guān)系是很有幫助的。這些類被稱為“容器(containers)”,或者更具體地被稱為“控制反轉(zhuǎn)(Inversion of Control,IOC)容器”或者“依賴注入(Dependency injection,DI)容器”。容器本質(zhì)上是一個工廠,負責(zé)提供向它請求的類型實例。如果一個給定類型聲明它具有依賴關(guān)系,并且容器已經(jīng)被配置為提供依賴類型,那么它將把創(chuàng)建依賴關(guān)系作為創(chuàng)建請求實例的一部分。通過這種方式,可以向類型提供復(fù)雜的依賴關(guān)系而不需要任何硬編碼的類型構(gòu)造。除了創(chuàng)建對象的依賴關(guān)系外,容器通常還會管理應(yīng)用程序中對象的生命周期。
ASP.NET Core包含了一個默認(rèn)支持構(gòu)造函數(shù)注入的簡單內(nèi)置容器(由IServiceProvider接口表示),并且ASP.NET Core使某些服務(wù)可以通過DI獲取。ASP.NET Core的容器指的是它管理的類型為services。services是指由ASP.NET Core的IOC容器管理的類型。我們可以在應(yīng)用程序Startup類的ConfigureServices方法中配置內(nèi)置容器的服務(wù)。
二、使用框架提供的服務(wù)
Startup類中的ConfigureServices方法負責(zé)定義應(yīng)用程序?qū)⑹褂玫姆?wù),包括平臺功能,比如EntityFramework Core和ASP.NET Core MVC。最初,IServiceCollection只向ConfigureServices提供了幾個服務(wù)定義。如下面的例子:
除了使用默認(rèn)提供的幾個服務(wù)定義,我們還可以自己添加。下面是一個如何使用一些擴展方法(如AddDbContext,AddIdentity)向容器中添加額外服務(wù)的例子:
public void ConfigureServices(IServiceCollection services) { // 添加EntityFrameworkCore服務(wù) services.AddDbContext<AppDbContext>(options => { options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")); }); // 添加MVC服務(wù) services.AddControllersWithViews(); }
ASP.NET提供的功能和中間件,例如MVC,遵循約定使用一個單一的AddService擴展方法來注冊所有該功能所需的服務(wù)。
當(dāng)然,除了使用各種框架功能配置應(yīng)用程序外,還可以使用ConfigureServices來配置自己的應(yīng)用程序服務(wù)。
三、注冊服務(wù)
可以按照下面的方式注冊自己的應(yīng)用程序服務(wù)。第一個泛型類型表示將要從容器中請求的類型(這里的類型通常是一個接口)。第二個泛型類型表示將由容器實例化并且用于完成這些請求的具體類型:
// 添加自己的服務(wù) // IRepository是一個接口,表示要請求的類型 // UserRepository表示IRepository接口的具體實現(xiàn)類型 services.AddTransient<IRepository, UserRepository>();
每個services.Add<service>調(diào)用添加服務(wù)。例如,services.AddControllersWithViews()表示添加MVC需要的服務(wù)。
在示例中,有一個名稱為CharactersController的控制器。它的Index方法顯示已經(jīng)存儲在應(yīng)用程序的當(dāng)前字符列表,并且,如果它不存在的話,則初始化具有少量字符的集合。值得注意的是:雖然應(yīng)用程序使用Entity Framework Core和AppDbContext類作為持久化工具,這在控制器中都不是顯而易見的。相反,具體的數(shù)據(jù)訪問機制被抽象在遵循倉儲模式的ICharacterRepository接口后面。ICharacterRepository實例是通過構(gòu)造函數(shù)注入的,并且分配給一個私有字段,然后用來訪問所需的字符:
using System.Linq; using DependencyInjectionDemo.Model; using DependencyInjectionDemo.Repository; using Microsoft.AspNetCore.Mvc; namespace DependencyInjectionDemo.Controllers { public class CharactersController : Controller { // 定義私有的只讀字段 private readonly ICharacterRepository _characterRepository; /// <summary> /// 通過構(gòu)造函數(shù)注入并且給私有字段賦值 /// </summary> /// <param name="characterRepository"></param> public CharactersController(ICharacterRepository characterRepository) { _characterRepository = characterRepository; } public IActionResult Index() { return View(); } private void PopulateCharactersIfNoneExist() { // 如果不存在則添加 if(!_characterRepository.ListAll().Any()) { _characterRepository.Add(new Character("Tom")); _characterRepository.Add(new Character("Jack")); _characterRepository.Add(new Character("Kevin")); } } } }
ICharacterRepository接口中只定義了控制器需要使用的Character實例的兩個方法:
using DependencyInjectionDemo.Model; using System.Collections.Generic; namespace DependencyInjectionDemo.Repository { public interface ICharacterRepository { IEnumerable<Character> ListAll(); int Add(Character character); } }
這個接口在運行時需要使用一個具體的CharacterRepository類型來實現(xiàn)。
在CharacterRepository類中使用DI的方式是一個可以在你的應(yīng)用程序服務(wù)遵循的通用模型,不只是在“倉儲”或者數(shù)據(jù)訪問類中:
using DependencyInjectionDemo.Context; using DependencyInjectionDemo.Model; using System.Collections.Generic; using System.Linq; namespace DependencyInjectionDemo.Repository { public class CharacterRepository : ICharacterRepository { // 定義私有字段 private readonly AppDbContext _dbContext; /// <summary> /// 通過構(gòu)造函數(shù)注入,并且給私有字段賦值 /// </summary> /// <param name="dbContext"></param> public CharacterRepository(AppDbContext dbContext) { _dbContext = dbContext; } public int Add(Character character) { // 添加 _dbContext.Characters.Add(character); // 保存 return _dbContext.SaveChanges(); } public IEnumerable<Character> ListAll() { return _dbContext.Characters.AsEnumerable(); } } }
需要注意的是,CharacterRepository需要一個AppDbContext在它的構(gòu)造函數(shù)中。依賴注入用于像這樣的鏈?zhǔn)椒椒ú⒉簧僖?,每個請求依次請求它的依賴關(guān)系。容器負責(zé)解析所有的依賴關(guān)系,并返回完全解析后的服務(wù)。
創(chuàng)建請求對象和它需要的所有對象,以及那些需要的所有對象,有時稱為一個對象圖。同樣的,必須解析依賴關(guān)系的集合通常稱為依賴樹或者依賴圖。
在這種情況下,ICharacterRepository和AppDbContext都必須在Startup類的ConfigureServices方法的服務(wù)容器中注冊。AppDbContext配置調(diào)用AddDbContex<T>擴展方法。下面的代碼展示了ICharacterRepository和AppDbContext類型的注冊:
public void ConfigureServices(IServiceCollection services) { // 添加EntityFrameworkCore服務(wù) // 這里是注冊AppDbContext使用AddDbContext<T>的形式 services.AddDbContext<AppDbContext>(options => { options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")); }); // 添加自己的服務(wù) // IRepository是一個接口,表示要請求的類型 // UserRepository表示IRepository接口的具體實現(xiàn)類型 services.AddTransient<IRepository, UserRepository>(); // 注冊ICharacterRepository類型 services.AddTransient<ICharacterRepository, CharacterRepository>(); // 添加MVC服務(wù) services.AddControllersWithViews(); }
Entity Framework Core的數(shù)據(jù)上下文應(yīng)當(dāng)使用Scope的生命周期添加到服務(wù)容器中。如果使用上面的AddDbContext<T>方法則會自動處理。倉儲將使用與Entity Framework Core相同的生命周期。
四、生命周期
ASP.NET Core服務(wù)可以配置為以下三種生命周期:
- Transient:瞬時生命周期。瞬時生命周期服務(wù)在它們每次請求時被創(chuàng)建。這一生命周期適合輕量級的、無狀態(tài)的服務(wù)。
- Scoped:作用域生命周期。作用域生命周期服務(wù)在每次請求時被創(chuàng)建一次。
- Singleton:單例生命周期。單例生命周期服務(wù)在它們第一次被請求時創(chuàng)建,并且每個后續(xù)請求將使用相同的實例。如果你的應(yīng)用程序需要單例行為,則建議讓服務(wù)容器管理服務(wù)的生命周期,而不是在自己的類中實現(xiàn)單例模式和管理對象的生命周期。
服務(wù)可以用多種方式在容器中注冊。我們已經(jīng)看到了如何通過指定具體類型來注冊一個給定類型的服務(wù)實現(xiàn)。除此之外,可以指定一個工廠,它將被用來創(chuàng)建需要的實例。第三種方式是直接指定要使用的類型的實例。在這種情況下,容器將永遠不會嘗試創(chuàng)建一個實例。
為了說明這些生命周期和注冊選項之間的差異,考慮一個簡單的接口將一個或多個任務(wù)表示為有一個唯一標(biāo)識符OperationId的操作。根據(jù)我們配置這個服務(wù)的生命周期的方法,容器將為請求的類提供相同或不同的服務(wù)實例。為了弄清楚哪一個生命周期被請求,我們需要創(chuàng)建每一個生命周期選項的類型。我們先定義一個接口,里面定義基接口和三種注入模式的接口:
using System; namespace DependencyInjectionDemo.Repository { /// <summary> /// 基接口 /// </summary> public interface IOperationRepository { Guid GetOperationId(); } /// <summary> /// 瞬時接口 /// </summary> public interface IOperationTransientRepository: IOperationRepository { } /// <summary> /// 作用域接口 /// </summary> public interface IOperationScopeRepository : IOperationRepository { } /// <summary> /// 單例接口 /// </summary> public interface IOperationSingletonRepository : IOperationRepository { } }
我們使用OperationRepository類來實現(xiàn)這些接口:
using System; namespace DependencyInjectionDemo.Repository { public class OperationRepository : IOperationRepository { private readonly Guid _guid; public OperationRepository() { _guid = Guid.NewGuid(); } public Guid GetOperationId() { return _guid; } } public class OperationTransientRepository : OperationRepository, IOperationTransientRepository { } public class OperationScopeRepository : OperationRepository, IOperationScopeRepository { } public class OperationSingletonRepository : OperationRepository, IOperationSingletonRepository { } }
然后在Startup類的ConfigureServices中,每一個類型根據(jù)它們命名的生命周期被添加到容器中:
public void ConfigureServices(IServiceCollection services) { // 添加EntityFrameworkCore服務(wù) // 這里是注冊AppDbContext使用AddDbContext<T>的形式 services.AddDbContext<AppDbContext>(options => { options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")); }); // 添加自己的服務(wù) // IRepository是一個接口,表示要請求的類型 // UserRepository表示IRepository接口的具體實現(xiàn)類型 services.AddTransient<IRepository, UserRepository>(); // 注冊ICharacterRepository類型 services.AddTransient<ICharacterRepository, CharacterRepository>(); // 添加瞬時生命周期 services.AddTransient<IOperationTransientRepository, OperationTransientRepository>(); // 添加作用域生命周期 services.AddScoped<IOperationScopeRepository, OperationScopeRepository>(); // 添加單例生命周期 services.AddSingleton<IOperationSingletonRepository, OperationSingletonRepository>(); // 添加MVC服務(wù) services.AddControllersWithViews(); }
然后添加一個控制器:
using DependencyInjectionDemo.Repository; using Microsoft.AspNetCore.Mvc; namespace DependencyInjectionDemo.Controllers { public class OperationController : Controller { // 定義私有字段 private readonly IOperationTransientRepository _transientRepository; private readonly IOperationScopeRepository _scopeRepository; private readonly IOperationSingletonRepository _singletonRepository; /// <summary> /// 通過構(gòu)造函數(shù)實現(xiàn)注入 /// </summary> /// <param name="transientRepository"></param> /// <param name="scopeRepository"></param> /// <param name="singletonRepository"></param> public OperationController(IOperationTransientRepository transientRepository, IOperationScopeRepository scopeRepository, IOperationSingletonRepository singletonRepository) { _transientRepository = transientRepository; _scopeRepository = scopeRepository; _singletonRepository = singletonRepository; } public IActionResult Index() { // ViewBag賦值 ViewBag.TransientGuid = _transientRepository.GetOperationId(); ViewBag.ScopedGuid = _scopeRepository.GetOperationId(); ViewBag.SingletonGuid = _singletonRepository.GetOperationId(); return View(); } } }
對應(yīng)的Index視圖代碼:
<div class="row"> <div> <h2>GuidItem Shows</h2> <h3>TransientGuid: @ViewBag.TransientGuid</h3> <h3>ScopedGuid: @ViewBag.ScopedGuid</h3> <h3>SingletonGuid: @ViewBag.SingletonGuid</h3> </div> </div>
然后我們打開兩個瀏覽器,刷新多次,只會發(fā)現(xiàn)“TransientGuid” 和“ScopedGuid”的值在不斷變化,而“SingletonGuid”的值是不會變化的,這就體現(xiàn)了單例模式的作用,如下圖所示:
但是這樣還不夠,要知道我們的Scoped的解讀是“生命周期橫貫整次請求”,但是現(xiàn)在演示起來和Transient好像沒有什么區(qū)別(因為兩個頁面每次瀏覽器請求仍然是獨立的,并不包含于一次中),所以我們采用以下代碼來演示下(同一請求源):
@*引入命名空間*@ @using DependencyInjectionDemo.Repository @*通過該inject引入*@ @inject IOperationTransientRepository OperationTransientRepository @inject IOperationScopeRepository OperationScopeRepository @inject IOperationSingletonRepository OperationSingletonRepository <div class="row"> <div> <h2>GuidItem Shows</h2> <h3>TransientGuid: @OperationTransientRepository.GetOperationId()</h3> <h3>ScopedGuid: @OperationScopeRepository.GetOperationId()</h3> <h3>SingletonGuid: @OperationSingletonRepository.GetOperationId()</h3> </div> </div>
然后修改Index視圖:
<div class="row"> <div> @Html.Partial("GuidPartial") <h2>**************************</h2> <h2>GuidItem Shows</h2> <h3>TransientGuid: @ViewBag.TransientGuid</h3> <h3>ScopedGuid: @ViewBag.ScopedGuid</h3> <h3>SingletonGuid: @ViewBag.SingletonGuid</h3> </div> </div>
在運行程序執(zhí)行:
可以看到:每次請求的時候Scope生命周期在同一請求中是不變的,而Transient生命周期還是會不斷變化的。
- 瞬時(Transient):對象總是不同的,向每一個控制器和每一個服務(wù)提供了一個新的實例(同一個頁面內(nèi)的Transient也是不同的)。
- 作用域(Scoped):對象在一次請求中是相同的,但在不同請求中是不同的(在同一個頁面內(nèi)多個Scoped是相同的,在不同頁面中是不同的)。
- 單例(Singleton):對象對每個對象和每個請求是相同的(無論是否在ConfigureServices中提供實例)。
五、請求服務(wù)
來自HttpContext的一次ASP.NET請求中,可用的服務(wù)是通過RequestServices集合公開的。
請求服務(wù)將你配置的服務(wù)和請求描述為應(yīng)用程序的一部分。在你的對象指定依賴關(guān)系后,這些滿足要求的對象可通過查找RequestServices中對應(yīng)的類型得到,而不是ApplicationServices。
通過,不應(yīng)該直接使用這些屬性,而是通過類的構(gòu)造函數(shù)請求需要的類的類型,并且讓框架來注入依賴關(guān)系。這將會生成更易于測試的和更松散耦合的類。
六、設(shè)計你的依賴服務(wù)
應(yīng)該設(shè)計你的依賴注入服務(wù)來獲取它們的合作者。這意味著在你的服務(wù)中,避免使用有狀態(tài)的靜態(tài)方法調(diào)用和直接實例化依賴的類型。
如果你的類有太多的依賴關(guān)系被注入時該怎么辦?這通常表明你的類試圖做太多,并且可能違反了單一職責(zé)原則。看看是否可以通過轉(zhuǎn)移一些職責(zé)到一個新的類來重構(gòu)。
注意,你的Controller類應(yīng)該重點關(guān)注用戶界面(UI),因此業(yè)務(wù)規(guī)則和數(shù)據(jù)訪問實現(xiàn)細節(jié)應(yīng)該保存在這些適合單獨關(guān)注的類中。
關(guān)于數(shù)據(jù)訪問,如果你已經(jīng)在Startup類中配置了EF,那么你能夠方便地注入Entity Framework的DBContext類型到你的控制器中。然而,最好不要在你的UI項目中直接依賴DBContext。相反,應(yīng)該依賴于一個抽象(比如一個倉儲接口),并且限定使用EF(或其他任何數(shù)據(jù)訪問技術(shù))來實現(xiàn)這個接口。這將減少應(yīng)用程序和特定的數(shù)據(jù)訪問策略之間的耦合,并且使你的應(yīng)用程序代碼更容易測試。
GitHub示例代碼:https://github.com/jxl1024/DependencyInjection
到此這篇關(guān)于ASP.NET Core依賴注入的文章就介紹到這了。希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
ASP.NET Core 2.0 使用支付寶PC網(wǎng)站支付實現(xiàn)代碼
這篇文章主要介紹了ASP.NET Core 2.0 使用支付寶PC網(wǎng)站支付實現(xiàn)代碼,需要的朋友可以參考下2017-10-10WinForm中窗體間的數(shù)據(jù)傳遞交互的一些方法
通過子窗口向外引發(fā)一個事件,父窗口去實現(xiàn)該事件,我們可以再不關(guān)閉父窗口和子窗口的情況下進行數(shù)據(jù)的傳輸顯示2012-12-12GridView中動態(tài)設(shè)置CommandField是否可用或可見的小例子
GridView中動態(tài)設(shè)置CommandField是否可用或可見的小例子,需要的朋友可以參考一下2013-05-05