Asp.Net Core中服務(wù)的生命周期選項(xiàng)區(qū)別與用法詳解

更新時(shí)間：2018年11月03日 16:02:27 作者：微笑刺客D

這篇文章主要給大家介紹了關(guān)于Asp.Net Core中服務(wù)的生命周期選項(xiàng)區(qū)別與用法的相關(guān)資料，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

前言

最近在做一個(gè)小的Demo中，在一個(gè)界面上兩次調(diào)用視圖組件，并且在視圖組件中都調(diào)用了數(shù)據(jù)庫(kù)查詢，結(jié)果發(fā)現(xiàn)，一直報(bào)錯(cuò)，將兩個(gè)視圖組件的調(diào)用分離，單獨(dú)進(jìn)行，卻又是正常的，尋找一番，發(fā)現(xiàn)是配置依賴注入服務(wù)時(shí)，對(duì)于服務(wù)的生命周期沒(méi)有配置得當(dāng)導(dǎo)致，特此做一次實(shí)驗(yàn)來(lái)認(rèn)識(shí)三者之間(甚至是四者之間的用法及區(qū)別)。

本文demo地址(具體見(jiàn)WebApi控制器中):https://gitee.com/530521314/koInstance.git （本地下載）

一、服務(wù)的生命周期

在Asp.Net Core中，內(nèi)置容器負(fù)責(zé)管理服務(wù)的生命周期，從被依賴注入容器創(chuàng)建開(kāi)始，等我們調(diào)用完服務(wù)時(shí)，到容器釋放該服務(wù)的所有實(shí)力為止，有幾種形式表現(xiàn)：

　　1、Transient：每次請(qǐng)求服務(wù)時(shí)，都會(huì)創(chuàng)建一個(gè)新實(shí)例，這種生命周期適合用于輕量級(jí)服務(wù)（如Repository和ApplicationService服務(wù)）。

　　2、Scoped：為每個(gè)HTTP請(qǐng)求創(chuàng)建一個(gè)實(shí)例，生命周期將橫貫整次請(qǐng)求。

　　3、SingleTon：在第一次請(qǐng)求服務(wù)時(shí)，為該服務(wù)創(chuàng)建一個(gè)實(shí)例，之后每次請(qǐng)求將會(huì)使用第一次創(chuàng)建好的服務(wù)。

　　4、Instance：與SingleTon類似，但在應(yīng)用程序啟動(dòng)時(shí)會(huì)將該實(shí)例注冊(cè)到容器中，可以理解為比SingleTon還早存在。

應(yīng)用程序中相關(guān)服務(wù)的控制生命周期的方法時(shí)通過(guò)相應(yīng)的Add*指定，如下三種，當(dāng)然還可以通過(guò)擴(kuò)展方法來(lái)簡(jiǎn)化ConfigurationServices方法中所見(jiàn)的代碼數(shù)量。

services.AddTransient<IApplicationService, ApplicationService>();
services.AddScoped<IApplicationService, ApplicationService>();
services.AddSingleton<IApplicationService, ApplicationService>();

二、代碼設(shè)計(jì)服務(wù)生命周期

首先設(shè)計(jì)一些服務(wù)相關(guān)的操作接口

public interface IOperation
 {
 Guid GetGuid();
 }

 public interface IOperationTransient: IOperation
 {

 }

 public interface IOperationScoped : IOperation
 {

 }

 public interface IOperationSingleton : IOperation
 {
 
 }

 public interface IOperationInstance : IOperation
 {
 
 }

基礎(chǔ)服務(wù)接口

其次對(duì)這些操作類予以實(shí)現(xiàn)并生成相關(guān)服務(wù)

/// <summary>
 /// 常規(guī)服務(wù)
 /// </summary>
 public class Operation : IOperation
 {
 private readonly Guid _guid;

 public Operation()
 {
 _guid = Guid.NewGuid();
 }

 public Operation(Guid guid)
 {
 _guid = guid == Guid.Empty ? Guid.NewGuid() : guid;
 }

 public Guid GetGuid()
 {
 return _guid;
 }
 }

 /// <summary>
 /// 瞬時(shí)服務(wù)
 /// </summary>
 public class OperationTransient : IOperationTransient
 {
 private readonly Guid _guid;

 public OperationTransient()
 {
 _guid = Guid.NewGuid();
 }

 public OperationTransient(Guid guid)
 {
 _guid = guid == Guid.Empty ? Guid.NewGuid() : guid;
 }

 public Guid GetGuid()
 {
 return _guid;
 }
 }

 /// <summary>
 /// 單次請(qǐng)求內(nèi)服務(wù)固定
 /// </summary>
 public class OperationScoped : IOperationScoped
 {
 private readonly Guid _guid;

 public OperationScoped()
 {
 _guid = Guid.NewGuid();
 }

 public OperationScoped(Guid guid)
 {
 _guid = guid == Guid.Empty ? Guid.NewGuid() : guid;
 }

 public Guid GetGuid()
 {
 return _guid;
 }
 }


 /// <summary>
 /// 所有請(qǐng)求內(nèi)固定服務(wù)
 /// </summary>
 public class OperationSingleton : IOperationSingleton
 {
 private readonly Guid _guid;

 public OperationSingleton()
 {
 _guid = Guid.NewGuid();
 }

 public OperationSingleton(Guid guid)
 {
 _guid = guid == Guid.Empty ? Guid.NewGuid() : guid;
 }

 public Guid GetGuid()
 {
 return _guid;
 }
 }

 /// <summary>
 /// 應(yīng)用程序內(nèi)固定服務(wù)
 /// </summary>
 public class OperationInstance : IOperationInstance
 {
 private readonly Guid _guid;

 public OperationInstance()
 {
 _guid = Guid.NewGuid();
 }

 public OperationInstance(Guid guid)
 {
 _guid = guid == Guid.Empty ? Guid.NewGuid() : guid;
 }

 public Guid GetGuid()
 {
 return _guid;
 }
 }

基礎(chǔ)服務(wù)具體實(shí)現(xiàn)

對(duì)基礎(chǔ)服務(wù)的聚合接口，提供統(tǒng)一服務(wù)接口

public interface IOperationService
 {
 /// <summary>
 /// 獲取四種形式的Guid碼
 /// </summary>
 /// <returns></returns>
 List<string> GetGuidString();
 }

聚合服務(wù)接口

對(duì)基礎(chǔ)服務(wù)的聚合實(shí)現(xiàn)，將基礎(chǔ)服務(wù)全部接入進(jìn)來(lái)作為統(tǒng)一服務(wù)

/// <summary>
 /// 服務(wù)調(diào)用
 /// </summary>
 public class OperationService : IOperationService
 {
 public IOperationTransient _transientOperation { get; }
 public IOperationScoped _scopedOperation { get; }
 public IOperationSingleton _singletonOperation { get; }
 public IOperationInstance _instanceOperation { get; }

 public OperationService(IOperationTransient transientOperation,
 IOperationScoped scopedOperation,
 IOperationSingleton singletonOperation,
 IOperationInstance instanceOperation)
 {
 _transientOperation = transientOperation;
 _scopedOperation = scopedOperation;
 _singletonOperation = singletonOperation;
 _instanceOperation = instanceOperation;
 }

 public List<string> GetGuidString()
 {
 return new List<string>()
 {
 $"Transient:"+_transientOperation.GetGuid(),
 $"Scoped:"+_scopedOperation.GetGuid(),
 $"Singleton:" +_singletonOperation.GetGuid(),
 $"Instance:"+_instanceOperation.GetGuid(),
 };
 }
 }

聚合服務(wù)的實(shí)現(xiàn)

在控制器中進(jìn)行服務(wù)注入

[Route("api/[controller]")]
 [ApiController]
 public class ValuesController : ControllerBase
 {
 private readonly IOperationService _operationService;

 public ValuesController(IOperationService operationService)
 {
 _operationService = operationService;
 }

 [HttpGet]
 [Route(nameof(GetGuidString))]
 public ActionResult<string> GetGuidString()
 {
 return string.Join("\n", _operationService.GetGuidString());
 }
 }

在StartUp中完成服務(wù)注入邏輯，這里實(shí)現(xiàn)服務(wù)注入的方式多種均可。

services.AddTransient<IOperationTransient, OperationTransient>();
services.AddScoped<IOperationScoped, OperationScoped>();
services.AddSingleton<IOperationSingleton, OperationSingleton>();//應(yīng)用程序啟動(dòng)時(shí)便注入該實(shí)例
services.AddSingleton<IOperationInstance>(new OperationInstance(Guid.Empty));
services.AddTransient<IOperationService, OperationService>();

通過(guò)訪問(wèn)預(yù)期Api地址可以得到不同的四種基礎(chǔ)服務(wù)的Guid信息，

第一次啟動(dòng)程序(不關(guān)閉)發(fā)起訪問(wèn)：

第二次(第一次基礎(chǔ)上再次訪問(wèn))發(fā)起訪問(wèn)：

可以看見(jiàn)，兩次訪問(wèn)下，Singleton和Instance是相同的，都是由應(yīng)用程序啟動(dòng)時(shí)和應(yīng)用服務(wù)加載時(shí)決定完畢，Singleton在首次進(jìn)入服務(wù)時(shí)進(jìn)行分配，并始終保持不變，而Instance在應(yīng)用程序啟動(dòng)時(shí)，便將實(shí)例注入，進(jìn)入服務(wù)也保持著最先的實(shí)例，沒(méi)有重新分配實(shí)例。而Transient和Scoped則進(jìn)行著變化。

關(guān)閉程序，重啟，第三次發(fā)起訪問(wèn)：

可以見(jiàn)到，Singleton和Instance都發(fā)生了變化，也說(shuō)明了之前在Singleton和Instance處寫(xiě)上的作用。

接下來(lái)開(kāi)始設(shè)計(jì)Transient和Scoped的不同之處，對(duì)于已有代碼加上新功能，此次我們只針對(duì)Scoped和Transient進(jìn)行比較。

首先在StartUp中將HttpContextAccessor服務(wù)注入，目的是在后期能夠針對(duì)Scoped獲取新的服務(wù)實(shí)例(盡管兩個(gè)實(shí)例是相同的)。

 services.AddHttpContextAccessor();

接著在聚合服務(wù)中增加一個(gè)方法，用來(lái)針對(duì)Transient、Scoped測(cè)試。

 /// <summary>
 /// 獲取Transient、Scoped的Guid碼
 /// </summary>
 /// <returns></returns>
 List<string> GetTransientAndScopedGuidString();

在聚合服務(wù)實(shí)現(xiàn)中實(shí)現(xiàn)該方法并對(duì)已有的服務(wù)重新獲取實(shí)例，得到不同實(shí)例下的Guid碼。

public List<string> GetTransientAndScopedGuidString()
 {
 //var tempTransientService = (IOperationTransient)ServiceLocator.Instance.GetService(typeof(IOperationTransient));

 var tempTransientService = (IOperationTransient)_httpContextAccessor.HttpContext.RequestServices.GetService(typeof(IOperationTransient));
 var tempScopedService = (IOperationScoped)_httpContextAccessor.HttpContext.RequestServices.GetService(typeof(IOperationScoped));

 return new List<string>()
 {
 $"原生Transient請(qǐng)求服務(wù):"+_transientOperation.GetGuid(),
 $"手動(dòng)Transient請(qǐng)求服務(wù):"+ tempTransientService.GetGuid(),
 $"原生Scoped請(qǐng)求服務(wù):"+_scopedOperation.GetGuid(),
 $"手動(dòng)Scoped請(qǐng)求服務(wù):"+tempScopedService.GetGuid(),
 };
 }

在控制器部分調(diào)用該聚合服務(wù)即可，并返回相應(yīng)的結(jié)果，本次我返回的結(jié)果：