ASP.NET Core - 依賴注入(三)

啊晚發表於2023-02-28
ASP.NET依賴注入

4. 容器中的服務建立與釋放

我們使用了 IoC 容器之後，服務例項的建立和銷燬的工作就交給了容器去處理，前面也講到了服務的生命週期，那三種生命週期中物件的建立和銷燬分別在什麼時候呢。以下面的例子演示以下：

首先是新增三個類，用於註冊三種不同的生命週期：

public class Service1
{
    public Service1()
    {
        Console.WriteLine("Service1 Created");
    }
}
public class Service2
{
    public Service2()
    {
        Console.WriteLine("Service2 Created");
    }
}
public class Service3
{
    public Service3()
    {
        Console.WriteLine("Service3 Created");
    }
}

接下來是演示場景，為了簡單起見，就用後臺服務程式吧

IHost host = Host.CreateDefaultBuilder(args)
    .ConfigureServices(services =>
    {
        services.AddHostedService<Worker>();
        services.AddSingleton<Service1>();
        services.AddScoped<Service2>();
        services.AddTransient<Service3>();
    })
    .Build();

await host.RunAsync();

public class Worker : BackgroundService
{
    private readonly ILogger<Worker> _logger;
    private readonly IServiceProvider _serviceProvid
    public Worker(ILogger<Worker> logger, IServiceProvider serviceProvider)
    {
        _logger = logger;
        _serviceProvider = serviceProvider;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        #region 生命週期例項建立
        Console.WriteLine("Service1 第一次呼叫");
        var service11 = _serviceProvider.GetService<Service1>();
        Console.WriteLine("Service1 第二次呼叫");
        var service12 = _serviceProvider.GetService<Service1>();

        // 建立作用域，與 Web 應用中的一次請求一樣
        using (var scope = _serviceProvider.CreateScope())
        {
            Console.WriteLine("Service2 第一次呼叫");
            var service31 = scope.ServiceProvider.GetService<Service2>();
            Console.WriteLine("Service2 第二次呼叫");
            var service32 = scope.ServiceProvider.GetService<Service2>();

            using (var scope1 = _serviceProvider.CreateScope())
            {
                Console.WriteLine("Service2 第三次呼叫");
                var service33 = scope1.ServiceProvider.GetService<Service2>();
            }
        }
        {
            Console.WriteLine("Service3 第一次呼叫");
            var service41 = _serviceProvider.GetService<Service3>();

            Console.WriteLine("Service3 第二次呼叫");
            var service42 = _serviceProvider.GetService<Service3>();
            }
            #endregion
        }
    }
}

最終的輸出如下：

image

透過輸出，我們可以單例生命週期服務在第一次使用的時候建立，之後一直是一個例項，作用域生命週期服務在一個作用域中第一次使用的時候建立例項，之後在同一個例項中只保持一個，但在其他作用域中則會重新建立，而瞬時生命週期服務每次都會建立一個新例項。

看完建立，我們再看例項銷燬的時機。

若服務實現了IDisposable介面，並且該服務是由DI容器建立的，則我們不應該手動去Dispose，DI容器會對服務自動進行釋放。這裡由兩個關鍵點，一個是要實現 Idisposable 介面，一個是由容器建立。這裡再增加多兩個類，用於演示，並且為了避免干擾將之前演示建立過程的程式碼註釋。

public class Service1 : IDisposable
{
    public Service1()
    {
        Console.WriteLine("Service1 Created");
  
    public void Dispose()
    {
        Console.WriteLine("Service1 Dispose");
    }
}

public class Service2 : IDisposable
{
    public Service2()
    {
        Console.WriteLine("Service2 Created");

    public void Dispose()
    {
        Console.WriteLine("Service2 Dispose");
    }
}

public class Service3 : IDisposable
{
    public Service3()
    {
        Console.WriteLine("Service3 Created");
    }

    public void Dispose()
    {
        Console.WriteLine("Service3 Dispose");
    }
}

public class Service4 : IDisposable
{
    public void Dispose()
    {
        Console.WriteLine("Service4 Dispose");
    }
}

public class Service5 : IDisposable
{
    public void Dispose()
    {
        Console.WriteLine("Service5 Dispose");
    }
}

之後後臺服務程式也做一些修改

IHost host = Host.CreateDefaultBuilder(args)
    .ConfigureServices(services =>
    {
        services.AddHostedService<Worker>();
        services.AddSingleton<Service1>();
        services.AddScoped<Service2>();
        services.AddTransient<Service3>();
        // 這種方式依舊由容器建立例項，只不過提供了工廠方法
        services.AddSingleton<Service4>(provider => new Service4());
        // 這種方式是用外部建立例項，只有單例生命週期可用
        services.AddSingleton<Service5>(new Service5());
    })
    .Build();

await host.RunAsync();

public class Worker : BackgroundService
{
    private readonly ILogger<Worker> _logger;
    private readonly IServiceProvider _serviceProvid
    public Worker(ILogger<Worker> logger, IServiceProvider serviceProvider)
    {
        _logger = logger;
        _serviceProvider = serviceProvider;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        #region 生命週期實
        Console.WriteLine("Service1 呼叫");
        var service1 = _serviceProvider.GetService<Service1>();

        // 建立作用域，與 Web 應用中的一次請求一樣
        using (var scope = _serviceProvider.CreateScope())
        {
            Console.WriteLine("Service2 呼叫");
            var service2 = scope.ServiceProvider.GetService<Service2>();
            Console.WriteLine("即將結束作用域
            Console.WriteLine("Service3 呼叫");
            var service3 = scope.ServiceProvider.GetService<Service3>();
        }

        Console.WriteLine("Service4 呼叫");
        var service4 = _serviceProvider.GetService<Service4>();
        Console.WriteLine("Service5 呼叫");
        var service5 = _serviceProvider.GetService<Service5>();

        #endregion
    }
}

這樣要直接用命令啟動應用，不能夠透過vs除錯，之後Ctrl+C停止應用的時候，輸出如下：

image

透過輸出可以看得到，瞬時生命週期服務和作用域生命週期服務在超出作用範圍就會被釋放，而單例生命週期服務則在應用關閉時才釋放，同為單例生命週期的Service5沒有被釋放。

這裡要提一下的是，在解析瞬時生命週期服務Service3的時候，示例程式碼中是放到一個單獨的作用域中的，這是因為在透過 services.AddHostedService<Worker>(); 注入Worker的時候是注入為單例生命週期的，而在單例生命週期物件中解析其他生命週期的物件是會有問題的，這也是服務注入、解析需要注意的一個關鍵點。

一定要注意服務解析範圍，不要在 Singleton 中解析 Transient 或 Scoped 服務，這可能導致服務狀態錯誤（如導致服務例項生命週期提升為單例，因為單例生命週期的服務物件只會在應用停止的時候釋放，而單例物件都沒釋放，它的依賴項肯定不會釋放）。允許的方式有：

  • 在 Scoped 或 Transient 服務中解析 Singleton 服務
  • 在 Scoped 或 Transient 服務中解析 Scoped 服務（不能和前面的Scoped服務相同）

如果要在單例生命週期示例中臨時解析作用域、瞬時生命週期的服務，可以透過建立一個子作用域的方式。對子作用域 IServiceScope 的工作方式感興趣的，可閱讀一下這篇文章：細聊.Net Core中IServiceScope的工作方式 。



參考文章：
ASP.NET Core 依賴注入 | Microsoft Learn
理解ASP.NET Core - 依賴注入(Dependency Injection)



ASP.NET Core 系列：

目錄：ASP.NET Core 系列總結
上一篇：ASP.NET Core - 依賴注入(二)

相關文章