ASP.NET Core 3框架揭秘之異步線程無(wú)法使用IServiceProvider怎么辦

這篇文章給大家分享的是有關(guān)ASP.NET Core 3框架揭秘之異步線程無(wú)法使用IServiceProvider怎么辦的內(nèi)容。小編覺(jué)得挺實(shí)用的，因此分享給大家做個(gè)參考，一起跟隨小編過(guò)來(lái)看看吧。

一、問(wèn)題重現(xiàn)

我們通過(guò)一個(gè)簡(jiǎn)單的實(shí)例來(lái)模擬該同事遇到的問(wèn)題。我們采用極簡(jiǎn)的方式創(chuàng)建了如下這個(gè)ASP.NET Core MVC應(yīng)用。如下面的代碼片段所示，除了注冊(cè)與ASP.NET Core MVC框架相關(guān)的服務(wù)與中間件之外，我們還調(diào)用了IHostBuilder的UseDefaultServiceProvider方法將配置選項(xiàng)ServiceProviderOptions的ValidateScopes屬性設(shè)置為T(mén)rue，以開(kāi)啟針對(duì)服務(wù)范圍的驗(yàn)證。我們還采用Scoped生命周期模式注冊(cè)了服務(wù)IFoobar，具體的實(shí)現(xiàn)類(lèi)型Foobar還實(shí)現(xiàn)了IDisposable接口。

public class Program
{
 public static void Main()
 {
 Host
 .CreateDefaultBuilder()
 .UseDefaultServiceProvider(options => options.ValidateScopes = true)
 .ConfigureWebHostDefaults(builder => builder
 .ConfigureLogging(logging => logging.ClearProviders())
 .ConfigureServices(services => services
  .AddScoped<IFoobar, Foobar>()
  .AddRouting()
  .AddControllers())
 .Configure(app => app
  .UseRouting()
  .UseEndpoints(endpoints => endpoints.MapControllers())))
 .Build()
 .Run();
 }
}

public interface IFoobar { }
public class Foobar : IFoobar, IDisposable
{
 public void Dispose() => Console.WriteLine("Foobar.Dispose();");
}

我們創(chuàng)建了如下這個(gè)HomeController，它的構(gòu)造函數(shù)中注入了一個(gè)IServiceProvider對(duì)象。在Action方法Index中，我們調(diào)用Task的靜態(tài)方法Run異步執(zhí)行了一些操作。具體來(lái)說(shuō)，在異步執(zhí)行的操作中，我們利用調(diào)用上面注入的這個(gè)IServiceProvider對(duì)象的GetRequiredService<T>方法試圖獲取一個(gè)IFoobar服務(wù)實(shí)例。由于這段操作時(shí)在一個(gè)Try/Catch中執(zhí)行的，拋出的異常消息的堆棧信息會(huì)直接輸出到控制臺(tái)上。

public class HomeController: Controller
{
 private readonly IServiceProvider _requestServices;
 public HomeController(IServiceProvider requestServices)
 {
 _requestServices = requestServices;
 }
 [HttpGet("/")]
 public IActionResult Index()
 {
 Task.Run(async() => {
 try
 {
 await Task.Delay(100);
 var foobar = _requestServices.GetRequiredService<IFoobar>();
 }
 catch (Exception ex)
 {
 Console.WriteLine(ex.Message);
 Console.WriteLine(ex.StackTrace);
 }
 });
 return Ok();
 }
}

在運(yùn)行該應(yīng)用程序后，我們利用瀏覽器采用根路徑（“/”）對(duì)Action方法Index發(fā)起訪問(wèn)后，服務(wù)端控制臺(tái)上會(huì)出現(xiàn)如下所示的錯(cuò)誤信息。

二、ApplicationServices與RequestServices

從上圖所示的錯(cuò)誤消息可以看出，問(wèn)題出在我們?cè)噲D利用一個(gè)被Dispose的IServiceProvider來(lái)獲取我們所需的服務(wù)實(shí)例。我們知道，ASP.NET Core應(yīng)用在啟動(dòng)和請(qǐng)求處理過(guò)程中所需的服務(wù)幾乎都是由代表DI容器的IServiceProvider提供的。具體來(lái)說(shuō)，這里存在著兩種類(lèi)型的IServiceProvider對(duì)象，一種與當(dāng)前應(yīng)用的生命周期保持一致，我們一般將其稱(chēng)為ApplicationServices，另一種則是具體針對(duì)每個(gè)請(qǐng)求的IServiceProvider對(duì)象，我們將其稱(chēng)為RequestServices。

一般來(lái)說(shuō)，ApplicationServices用于提供管道構(gòu)建過(guò)程中所需的服務(wù)實(shí)例，具體請(qǐng)求處理過(guò)程中所需的服務(wù)實(shí)例一般由RequestServices提供。具體來(lái)說(shuō)，對(duì)于接收的每一個(gè)請(qǐng)求，ASP.NET Core框架都會(huì)利用ApplicationServices創(chuàng)建一個(gè)代表服務(wù)范圍的IServiceScope對(duì)象，后者就是對(duì)RequestServices的封裝。在完成了針對(duì)請(qǐng)求的處理之后，服務(wù)范圍被終結(jié)，RequestServices被Dispose。

對(duì)于我們演示的實(shí)例來(lái)說(shuō)，注入到HomeController構(gòu)造函數(shù)中的IServiceProvider是RequestServices，由于針對(duì)RequestServices的使用是在另一個(gè)后臺(tái)線程中執(zhí)行的，并且在使用的時(shí)候針對(duì)當(dāng)前請(qǐng)求的處理已經(jīng)結(jié)束（因?yàn)槲覀內(nèi)藶榈却?00毫秒），自然就會(huì)出現(xiàn)上圖所示的異常。

三、如何獲取ApplicationServices

既然與請(qǐng)求綁定的RequestServices不能用，我們只能使用與應(yīng)用綁定的ApplicationServices，那么后者如何得到呢？ASP.NET Core 3采用了基于IHost/IHostBuilder的承載方式，表示宿主的IHost接口具有如下所示的Services屬性，它返回的正式我們所需的ApplicationServices。

public interface IHost : IDisposable
{
 Task StartAsync(CancellationToken cancellationToken = new CancellationToken());
 Task StopAsync(CancellationToken cancellationToken = new CancellationToken());

 IServiceProvider Services { get; }
}

對(duì)于我們演示的程序來(lái)說(shuō)，我們可以采用如下的方式在HomeController的構(gòu)造中注入IHost服務(wù)的方式間接地獲得這個(gè)ApplicationServices對(duì)象。

public class HomeController: Controller
{
 private readonly IServiceProvider _applicationServices;
 public HomeController(IHost host)
 {
 _applicationServices = host.Services;
 }
 [HttpGet("/")]
 public IActionResult Index()
 {
 Task.Run(async() => {
 try
 {
 await Task.Delay(100);
 var foobar = _applicationServices.GetRequiredService<IFoobar>();
 }
 catch (Exception ex)
 {
 Console.WriteLine(ex.Message);
 Console.WriteLine(ex.StackTrace);
 }
 });
 return Ok();
 }
}

當(dāng)我們采用如上的方式將RequestServices替換成ApplicationServices之后，我們的問(wèn)題是否就解決了呢？在采用上面相同的方式進(jìn)行測(cè)試之后，我們會(huì)發(fā)現(xiàn)服務(wù)端控制臺(tái)上出現(xiàn)了如下所示的錯(cuò)誤消息。

四、服務(wù)實(shí)例的生命周期

上面的問(wèn)題是由我們?cè)噲D利用一個(gè)代表“根容器”的IServiceProvider對(duì)象去解析一個(gè)生命周期模式為Scoped服務(wù)實(shí)例導(dǎo)致，具體的原因在《依賴注入[8]：服務(wù)實(shí)例的生命周期》已經(jīng)講得很清楚了。為了解決這個(gè)問(wèn)題，我們應(yīng)該根據(jù)ApplicationServices創(chuàng)建一個(gè)“服務(wù)范圍”，并在該服務(wù)范圍內(nèi)提取我們所需的服務(wù)實(shí)例。為了確保服務(wù)實(shí)例能夠被正?；厥?，我們還應(yīng)該將代表服務(wù)范圍的IServiceScope對(duì)象及時(shí)終結(jié)掉。如下所示的是正確的編程方式。

public class HomeController: Controller
{
 private readonly IServiceProvider _applicationServices;
 public HomeController(IHost host)
 {
 _applicationServices = host.Services;
 }
 [HttpGet("/")]
 public IActionResult Index()
 {
 Task.Run(async() => {
 await Task.Delay(100);
 using (var scope = _applicationServices.CreateScope())
 {
 var foobar = scope.ServiceProvider.GetRequiredService<IFoobar>();
 }
 });
 return Ok();
 }
}

五、統(tǒng)一的解決方案

之前我們將問(wèn)題的解決方案落實(shí)在如何獲取與當(dāng)前應(yīng)用具有相同生命周期的ApplicationServices上，所以我們采用注入IHost的方式得到這個(gè)ApplicationServices。如果采用傳統(tǒng)的基于IWebHost/IWebHostBuilder的承載方式，IHost自然是獲取不到了。但是我們是真的需要這個(gè)ApplicationServices對(duì)象嗎？其實(shí)不是，我們真正需要的是利用它創(chuàng)建一個(gè)代表服務(wù)范圍的IServiceScope對(duì)象，并在該范圍內(nèi)消費(fèi)我們所需的服務(wù)實(shí)例。由于IServiceScope是通過(guò)IServiceScopeFactory創(chuàng)建的，所以我們只需要注入IServiceScopeFactory即可。

public class HomeController : Controller
{
 private readonly IServiceScopeFactory _serviceScopeFactory;

 public HomeController(IServiceScopeFactory serviceScopeFactory)
 {
 _serviceScopeFactory = serviceScopeFactory;
 }

 [HttpGet("/")]
 public IActionResult Index()
 {
 Task.Run(async () =>
 {
 await Task.Delay(100);
 using (var scope = _serviceScopeFactory.CreateScope())
 { 
 var foobar = scope.ServiceProvider.GetRequiredService<IFoobar>();
 }
 });
 return Ok();
 }
}

感謝各位的閱讀！關(guān)于“ASP.NET Core 3框架揭秘之異步線程無(wú)法使用IServiceProvider怎么辦”這篇文章就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，讓大家可以學(xué)到更多知識(shí)，如果覺(jué)得文章不錯(cuò)，可以把它分享出去讓更多的人看到吧！