[.NET 6] 如何優雅(Gracefully Shutdown)的關閉 .NET Core Console 應用程式

2021-11-28

2959
0
Graceful Shutdown
2023-08-03

當有一個應用程序被用戶 ( SIGINT /Ctrl+C) 或 Docker ( SIGTERM / docker stop ) 停止時，它需要優雅地關閉一個長時間運行的工作；換句煥說，當應用程式收到關閉訊號的時候，要把工作做完，應用程式才可以關閉。微軟的 Microsoft.Extensions.Hosting 可以幫我們接收/處理關閉訊號，我們只需要告訴它要怎麼做就可以了，我在實作的過程當中，碰到了一些問題，以下是我的心得

開發環境

.NET 6
Rider 2021.3-EAP9-213.5744.160)

接收 SIGINT / SIGTERM 訊號

新增一個 .NET 6 Console 應用程式，並加入以下套件

dotnet add package Microsoft.Extensions.Hosting --version 6.0.0
dotnet add package Serilog.Extensions.Hosting --version 7.0.0
dotnet add package Serilog.Settings.Configuration --version
dotnet add package Serilog.Sinks.Console --version 4.1.0
dotnet add package Serilog.Sinks.File --version 5.0.0

在 .NET Core 的應用程式我知道有以下的方法

Console.CancelKeyPress
AssemblyLoadContext.Default.Unloading
AppDomain.CurrentDomain.ProcessExit

var sigintReceived = false;

Log.Logger = new LoggerConfiguration()
        .MinimumLevel.Information()
        .Enrich.FromLogContext()
        .WriteTo.Console()
        .WriteTo.File("logs/host-.txt", rollingInterval: RollingInterval.Day)
        .CreateBootstrapLogger()
    ;
Log.Information($"Process id: {Process.GetCurrentProcess().Id}");
Log.Information("等待以下訊號 SIGINT/SIGTERM");

Console.CancelKeyPress += (sender, e) =>
{
    e.Cancel = true;
    Log.Information("已接收 SIGINT (Ctrl+C)");
    sigintReceived = true;
};

AssemblyLoadContext.Default.Unloading += ctx =>
{
    if (!sigintReceived)
    {
        Log.Information("已接收 SIGTERM，AssemblyLoadContext.Default.Unloading");
    }
    else
    {
        Log.Information("@AssemblyLoadContext.Default.Unloading，已處理 SIGINT，忽略 SIGTERM");
    }
};

AppDomain.CurrentDomain.ProcessExit += (sender, e) =>
{
    if (!sigintReceived)
    {
        Log.Information("已接收 SIGTERM，ProcessExit");
    }
    else
    {
        Log.Information("@AppDomain.CurrentDomain.ProcessExit，已處理 SIGINT，忽略 SIGTERM");
    }
};

Graceful Shutdown for Generic Host

.NET 6 的 Generic Host 就已經支援接收關閉訊號

下段內容出自 .NET 泛型主機 - .NET | Microsoft Learn
使用 ConsoleLifetime (UseConsoleLifetime) ，它會接聽下列訊號，並嘗試正常停止主機。
SIGINT (或 CTRL+C)。
SIGQUIT (或 CTRL+BREAK (Windows 上)、CTRL+\ (Unix 上))。
SIGTERM (由其他應用程式傳送，例如 docker stop)。

如果使用 Host 裝載應用程式，關機流程會是這樣

下圖內容出自 .NET 泛型主機 - .NET | Microsoft Learn

接下來，我要實作，當任務需要較長時間的工作時，如果 .NET Core 應用程式收到 SIGINT/SIGTERM 訊號的時候會發生甚麼事。

@ Program.cs

註冊 HostedService

await Host.CreateDefaultBuilder(args)
    .ConfigureServices((hostContext, services) =>
    {
        // services.Configure<HostOptions>(opts => opts.ShutdownTimeout = TimeSpan.FromSeconds(15));
        // services.AddHostedService<GracefulShutdownService>();
        services.AddHostedService<GracefulShutdownService1>();
        // services.AddHostedService<GracefulShutdownService_Fail>();
    })
    .UseSerilog((context, services, config) =>
    {
        var formatter = new JsonFormatter();
        config.ReadFrom.Configuration(context.Configuration)
            .ReadFrom.Services(services)
            .Enrich.FromLogContext()
            .WriteTo.Console(formatter)
            .WriteTo.File(formatter, "logs/app-.txt", rollingInterval: RollingInterval.Minute);
    })
    .RunConsoleAsync();

RunConsoleAsync 預設就會使用 UseConsoleLifetime

GracefulShutdownService

這裡我用 IHostedService 來建立服務

StartAsync()，用 Task.Run 調用 ExecuteAsync
this._backgroundTask = Task.Run(async () => { await this.ExecuteAsync(cancel); }, cancel);，ExecuteAsync 是一個長時間運行的方法
StopAsync()，等待 _backgroundTask 完成

internal class GracefulShutdownService : IHostedService
{
    private readonly IHostApplicationLifetime _appLifetime;
    private Task _backgroundTask;
    private bool _stop;
    private ILogger<GracefulShutdownService> _logger;

    public GracefulShutdownService(IHostApplicationLifetime appLifetime,
        ILogger<GracefulShutdownService> logger)
    {
        this._appLifetime = appLifetime;
        this._logger = logger;
    }

    public Task StartAsync(CancellationToken cancel)
    {
        this._logger.LogInformation($"{DateTime.Now} 服務啟動中...");

        this._backgroundTask = Task.Run(async () => { await this.ExecuteAsync(cancel); }, cancel);

        return Task.CompletedTask;
    }

    public async Task StopAsync(CancellationToken cancel)
    {
        this._logger.LogInformation($"{DateTime.Now} 服務停止中...");

        this._stop = true;
        await this._backgroundTask;
        
        this._logger.LogInformation($"{DateTime.Now} 服務已停止");
    }

    private async Task ExecuteAsync(CancellationToken cancel)
    {
        this._logger.LogInformation($"{DateTime.Now} 服務已啟動!");

        while (!this._stop)
        {
            this._logger.LogInformation($"{DateTime.Now} 1.服務運行中...");
            this._logger.LogInformation($"1.IsCancel={cancel.IsCancellationRequested}");
            await Task.Delay(TimeSpan.FromSeconds(30), cancel);
            this._logger.LogInformation($"2.IsCancel={cancel.IsCancellationRequested}");
            this._logger.LogInformation($"{DateTime.Now} 2.服務運行中...");
        }

        this._logger.LogInformation($"{DateTime.Now} 服務已完美的停止(Graceful Shutdown)");
    }
}

本機跑一下，觀察下，當我送出 Ctrl+C 發現一下就停了並沒有等待工作完成；關閉應用程式也沒有等待工作就直接關閉了。

或者是使用 BackgroundService，它已經把上述的行為封裝起來了，省掉了不少程式碼

class GracefulShutdownService1 : BackgroundService
{
    private readonly ILogger<GracefulShutdownService1> _logger;

    public GracefulShutdownService1(ILogger<GracefulShutdownService1> logger)
    {
        this._logger = logger;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        this._logger.LogInformation($"{DateTime.Now} 服務已啟動!");
        while (!stoppingToken.IsCancellationRequested)
        {
            this._logger.LogInformation($"{DateTime.Now} 1.服務運行中...");
            this._logger.LogInformation($"1.IsCancel={stoppingToken.IsCancellationRequested}");
            await Task.Delay(TimeSpan.FromSeconds(30), stoppingToken);
            this._logger.LogInformation($"2.IsCancel={stoppingToken.IsCancellationRequested}");
            this._logger.LogInformation($"{DateTime.Now} 2.服務運行中...");
        }
        this._logger.LogInformation($"{DateTime.Now} 服務已完美的停止(Graceful Shutdown)");
    }
}