asp.net core 系列 4 注入服務的生存期

時間 2019-11-12

標籤 asp.net asp core 系列注入服務存期欄目 ASP 简体版

原文原文鏈接

一.服務的生存期

　　在容器中每一個註冊的服務，根據程序應用需求均可以選擇合適的服務生存期，ASP.NET Core 服務有三種生存期配置：ui

　　　　(1) Transient：暫時生存期，在每次請求時被建立。這種生存期適合輕量級的，無狀態的服務。this

　　　　(2) Scoped: 做用域生存期，在每次請求被建立一次。spa

　　　　(3) Singleton: 單例生存期，在它們第一次被請求時建立。每一個後續請求將使用相同的實例。若是應用程序須要單例行爲，建議讓服務容器管理服務的生命週期，而不是在本身的類中實現單例模式。3d

　　1.1 演示案例code

　　　　爲了演示生存期和註冊選項之間的差別, 如下服務接口，任務是演示標識符 OperationId 的操做值變化。根據爲如下接口配置操做服務的生存期的方式，容器在類請求時提供相同或不一樣的服務實例：對象

public interface IOperation
    {
        Guid OperationId { get; }
    }
    //用於演示暫時生存期
    public interface IOperationTransient : IOperation
    {
    }
    //用於演示做用域生存期
    public interface IOperationScoped : IOperation
    {
    }
    //用於演示單例生存期
    public interface IOperationSingleton : IOperation
    {
    }
    //用於演示單例中空GUID
    public interface IOperationSingletonInstance : IOperation
    {
    }

上面四種服務接口在 Operation 類中實現。調用 Operation類時將自動生成一個 GUID（若是實例化Operation類時沒有指定GUID），下面是Operation類的實現：blog

public class Operation : IOperationTransient,
     IOperationScoped,
     IOperationSingleton,
     IOperationSingletonInstance
    {
        /// <summary>
        /// 構造方法中生成GUID，在實例化類時
        /// </summary>
        public Operation() : this(Guid.NewGuid())
        {
        }

        public Operation(Guid id)
        {
            OperationId = id;
        }

        /// <summary>
        /// 獲取GUID
        /// </summary>
        public Guid OperationId { get; private set; }
    }

再註冊一個 OperationService 服務，該服務取決於每一個其餘 Operation 類型。當經過依賴關係注入請求 OperationService 時，它將接收每一個服務的新實例或基於從屬服務(Operation )的生存期的現有實例。OperationService 服務做用就是第二次調用 Operation類，查看Operation類實例的做用域變化。接口

public class OperationService
    {

        public IOperationTransient TransientOperation { get; }
        public IOperationScoped ScopedOperation { get; }
        public IOperationSingleton SingletonOperation { get; }
        public IOperationSingletonInstance SingletonInstanceOperation { get; }


        public OperationService(
        IOperationTransient transientOperation,
        IOperationScoped scopedOperation,
        IOperationSingleton singletonOperation,
        IOperationSingletonInstance instanceOperation)
        {
            TransientOperation = transientOperation;
            ScopedOperation = scopedOperation;
            SingletonOperation = singletonOperation;
            SingletonInstanceOperation = instanceOperation;
        }
    }

　　　　(1) 若是在請求時建立了臨時服務(Transient)，則 IOperationTransient 服務的 OperationId 與 OperationService 的 OperationId 不一樣。 OperationService 將接收 IOperationTransient 類的新實例。新實例將生成一個不一樣的 OperationId。生命週期

　　　　(2) 若是按請求建立有做用域的服務(Scoped)，則 IOperationScoped 服務的 OperationId 與請求中 OperationService 的該 ID 相同。在請求中，兩個服務共享不一樣的 OperationId 值。作用域

　　　　(3) 若是單一實例服務(Singleton)，則只建立一次並在全部請求和全部服務中使用，則 OperationId 在全部服務請求中保持不變。

下面是在 Startup.ConfigureServices 服務容器中註冊，指定服務的生存期：

services.AddTransient<IOperationTransient, Operation>();
            services.AddScoped<IOperationScoped, Operation>();
            services.AddSingleton<IOperationSingleton, Operation>();
            services.AddSingleton<IOperationSingletonInstance>(new Operation(Guid.Empty));

            services.AddTransient<OperationService, OperationService>();

爲了演示各個請求中的對象生存期。下面示例應用 Index頁面，請求 IOperation 類型和 OperationService。而後查看Operation類屬性OperationId 值的變化：

public class IndexModel : PageModel
    {
        public OperationService OperationService { get; }
        public IOperationTransient TransientOperation { get; }
        public IOperationScoped ScopedOperation { get; }
        public IOperationSingleton SingletonOperation { get; }
        public IOperationSingletonInstance SingletonInstanceOperation { get; }
   
        public IndexModel(
        OperationService operationService,
        IOperationTransient transientOperation,
        IOperationScoped scopedOperation,
        IOperationSingleton singletonOperation,
        IOperationSingletonInstance singletonInstanceOperation)
        {
            OperationService = operationService;
            TransientOperation = transientOperation;
            ScopedOperation = scopedOperation;
            SingletonOperation = singletonOperation;
            SingletonInstanceOperation = singletonInstanceOperation;
        }

        public string BindGUIDMsg { get; set; }
        public void OnGet()
        {
            BindGUIDMsg += "IOperation操做: <br/> ";
            BindGUIDMsg += "暫時性:" + TransientOperation.OperationId.ToString() + "</br>";
            BindGUIDMsg += "有做用域:" + ScopedOperation.OperationId.ToString() + "</br>";
            BindGUIDMsg += "單一實例:" + SingletonOperation.OperationId.ToString() + "</br>";
            BindGUIDMsg += "實例:" + SingletonInstanceOperation.OperationId.ToString() + "</br>";

            BindGUIDMsg += "</br></br></br>OperationService操做:</br>";
            BindGUIDMsg += "暫時性:" + OperationService.TransientOperation.OperationId.ToString() + "</br>";
            BindGUIDMsg += "有做用域:" + OperationService.ScopedOperation.OperationId.ToString() + "</br>";
            BindGUIDMsg += "單一實例:" + OperationService.SingletonOperation.OperationId.ToString() + "</br>";
            BindGUIDMsg += "實例:" + OperationService.SingletonInstanceOperation.OperationId.ToString() + "</br>";
        }
    }

  <div >
        @{
          @Html.Raw(@Model.BindGUIDMsg);  
        }
    </div>

　　　　第一次Index頁面請求：

　　　　IOperation 操做：
　　　　暫時性：8ef874a3-743d-4288-98d4-3df126cd940d
　　　　有做用域：256ff050-f469-4ea3-8dde-16cdd3087c83
　　　　單一實例：d2caf297-a9b1-4dcf-ADDA-c68e46fe0741
　　　　實例：00000000-0000-0000-0000 -000000000000

　　　　OperationService操做：
　　　　暫時性：5411fd0d-f2e1-4885-beee-2d7ccf48dceb
　　　　有做用域：256ff050-f469-4ea3-8dde-16cdd3087c83
　　　　單一實例：d2caf297-a9b1-4dcf-adda-c68e46fe0741
　　　　實例：00000000-0000-0000- 0000-000000000000

　　　　第二次Index頁面請求：

　　　　IOperation操做：
　　　　暫時性:e685fd0e-d2e0-4900-9eff-e6bc41cd2f80
　　　　有做用域:ca233b49-8326-4a7e-8ee4-6993d70786ed
　　　　單一實例:d2caf297-a9b1-4dcf-adda-c68e46fe0741
　　　　實例:00000000-0000-0000-0000-000000000000

　　　　OperationService操做：
　　　　暫時性:db89be00-c3b7-4f99-bead-5be693ccc2c0
　　　　有做用域:ca233b49-8326-4a7e-8ee4-6993d70786ed
　　　　單一實例:d2caf297-a9b1-4dcf-adda-c68e46fe0741
　　　　實例:00000000-0000-0000-0000-000000000000

　　下面再總結一下：

　　　　(1)暫時性註冊的服務，每次調用服務都會是一個新的服務對象實例。至關於在IndexModel類的局部(方法或屬性中)實例化一個依賴對象Operation類，僞代碼是：

public class IndexModel
{
    public void OnGet()
        {
               //加載index頁時，實例化了二次Operation類
　　　　　　　　　//第一次
               OperationService operationService=new OperationService();
　　　　　　　　 //第二次
　　　　　　　　 IOperationTransient TransientOperation =new Operation();
        }
}

(2)做用域註冊的服務，一次請求內(加載一次index頁)對象實例是相同的，但每次請求會產生一個新實例。至關於在IndexModel類的全局中實例化一次依賴對象Operation類,僞代碼是：

OperationService operationService = null;
        public IndexModel()
        {
            operationService = new OperationService();
            operationService.ScopedOperation = new Operation();
        }

        public void OnGet()
        {
            operationService.ScopedOperation.OperationId;
            IOperationScoped operationScoped=operationService.ScopedOperation;
            operationScoped.OperationId
        ｝

　　(3)單例註冊的服務，實例對象對每一個對象和每一個請求都是相同的。至關於在整個應用Application中只實例化一次，常見的單例模式。

　參考文獻：

　　　　官方文檔：ASP.NET Core