【半譯】擴充套件shutdown超時設定以保證IHostedService正常關閉
阿新 • • 發佈：2020-05-27
我最近發現一個問題，當應用程式關閉時，我們的應用程式沒有正確執行在`IHostedService`中的`StopAsync`方法。經過反覆驗證發現，這是由於某些服務對關閉訊號做出響應所需的時間太長導致的。在這篇文章中，我將展示出現這個問題的一個示例，並且會討論它為什麼會發生以及如何避免這種情況出現。
> 作者：依樂祝
>
> 首發地址：https://www.cnblogs.com/yilezhu/p/12952977.html
>
> 英文地址：https://andrewlock.net/extending-the-shutdown-timeout-setting-to-ensure-graceful-ihostedservice-shutdown/
## 使用IHostedService執行後臺服務
ASP.NET Core 2.0引入[了`IHostedService`用於執行後臺任務的介面](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/host/hosted-services?view=aspnetcore-2.2&tabs=visual-studio)。該[介面包含兩種方法](https://github.com/dotnet/runtime/blob/f007634b02c4484f60ead75a893eb7f89f615ccf/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IHostedService.cs)：
```csharp
public interface IHostedService
{
Task StartAsync(CancellationToken cancellationToken);
Task StopAsync(CancellationToken cancellationToken);
}
```
`StartAsync`在應用程式啟動時被呼叫。在ASP.NET核心2.X發生這種情況[只是*之後*](https://github.com/aspnet/AspNetCore/blob/v2.1.12/src/Hosting/Hosting/src/Internal/WebHost.cs#L153)在應用程式啟動處理請求，而在ASP.NET核心3.x中託管服務開始[只是*之前*](https://github.com/aspnet/AspNetCore/blob/v3.0.0-preview9.19424.4/src/Hosting/Hosting/src/Internal/WebHost.cs#L154)在應用程式啟動處理請求。
`StopAsync`當應用程式收到shutdown（`SIGTERM`）訊號時（例如，您CTRL+C在控制檯視窗中按入，或者應用程式被主機系統停止時），將呼叫。這樣，您就可以關閉所有開啟的連線，處置資源，並通常根據需要清理類。
實際上，實現此介面實際上有一些微妙之處，這意味著您通常希望[從helper類`BackgroundService`](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/host/hosted-services?view=aspnetcore-3.1&tabs=visual-studio#backgroundservice-base-class)派生。
> 如果您想了解更多，Steve Gordon會開設有關Pluralsight的課程“ [構建ASP.NET Core託管服務和.NET Core Worker Services](https://pluralsight.pxf.io/vdn6j) ”。
## 關閉`IHostedService`實施的問題
我最近看到的問題是`OperationCanceledException`在應用程式關閉時引發的問題：
```bash
Unhandled exception. System.OperationCanceledException: The operation was canceled.
at System.Threading.CancellationToken.ThrowOperationCanceledException()
at Microsoft.Extensions.Hosting.Internal.Host.StopAsync(CancellationToken cancellationToken)
```
我將這個問題的根源追溯到一個特定的`IHostedService`實現。我們將`IHostedService`s作為每個[Kafka消費者](https://github.com/confluentinc/confluent-kafka-dotnet)的主機。具體操作並不重要-關鍵在於關閉`IHostedService`相對較慢：取消訂閱可能需要幾秒鐘。
> 問題的一部分是Kafka庫（和基礎`librdkafka`庫）使用同步阻塞`Consume`呼叫而不是非同步可取消呼叫的方式。解決這個問題的方法不是很好。
理解此問題的簡便方法是一個示例。
## 演示問題
解決此問題的最簡單方法是建立一個包含兩個`IHostedService`實現的應用程式：
- `NormalHostedService` 在啟動和關閉時記錄日誌，然後立即返回。
- `SlowHostedService` 記錄啟動和停止的時間，但要花10秒才能完成關閉
這兩個類的實現如下所示。的`NormalHostedService`很簡單：
```csharp
public class NormalHostedService : IHostedService
{
readonly ILogger _logger;
public NormalHostedService(ILogger logger)
{
_logger = logger;
}
public Task StartAsync(CancellationToken cancellationToken)
{
_logger.LogInformation("NormalHostedService started");
return Task.CompletedTask;
}
public Task StopAsync(CancellationToken cancellationToken)
{
_logger.LogInformation("NormalHostedService stopped");
return Task.CompletedTask;
}
}
```
在`SlowHostedService`幾乎是相同的，但它有一個`Task.Delay`是需要10秒，以模擬一個緩慢的關機
```csharp
public class SlowHostedService : IHostedService
{
readonly ILogger _logger;
public SlowHostedService(ILogger logger)
{
_logger = logger;
}
public Task StartAsync(CancellationToken cancellationToken)
{
_logger.LogInformation("SlowHostedService started");
return Task.CompletedTask;
}
public async Task StopAsync(CancellationToken cancellationToken)
{
_logger.LogInformation("SlowHostedService stopping...");
await Task.Delay(10_000);
_logger.LogInformation("SlowHostedService stopped");
}
}
```
> 的`IHostedService`就是我曾在實踐中只用了1秒關機，但我們有很多人，所以整體效果是一樣的上面！
該服務中註冊的順序`ConfigureServices`是非常重要的在這種情況下-來證明這個問題，我們需要`SlowHostedService`被關閉*第一*。服務以相反的順序關閉，這意味著我們需要*最後*註冊它：
```csharp
public void ConfigureServices(IServiceCollection services)
{
services.AddHostedService();
services.AddHostedService();
}
```
當我們執行該應用程式時，您將像往常一樣看到啟動日誌：
```bash
info: ExampleApp.NormalHostedService[0]
NormalHostedService started
info: ExampleApp.SlowHostedService[0]
SlowHostedService started
...
info: Microsoft.Hosting.Lifetime[0]
Application started. Press Ctrl+C to shut down.
```
但是，如果按CTRL+C關閉該應用程式，則會出現問題。在`SlowHostedService`完成關閉，但隨後一個`OperationCanceledException`被丟擲：
```bash
info: Microsoft.Hosting.Lifetime[0]
Application is shutting down...
info: ExampleApp.SlowHostedService[0]
SlowHostedService stopping...
info: ExampleApp.SlowHostedService[0]
SlowHostedService stopped
Unhandled exception. System.OperationCanceledException: The operation was canceled.
at System.Threading.CancellationToken.ThrowOperationCanceledException()
at Microsoft.Extensions.Hosting.Internal.Host.StopAsync(CancellationToken cancellationToken)
at Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.WaitForShutdownAsync(IHost host, CancellationToken token)
at Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.RunAsync(IHost host, CancellationToken token)
at Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.RunAsync(IHost host, CancellationToken token)
at Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.Run(IHost host)
at ExampleApp.Program.Main(String[] args) in C:\repos\andrewlock\blog-examples\SlowShutdown\Program.cs:line 16
```
該`NormalHostedService.StopAsync()`方法從不呼叫。如果該服務需要進行一些清理，那麼您會遇到問題。例如，也許您需要從Consul處優雅地登出該服務，或者取消訂閱Kafka主題-現在不會發生。
那麼這是怎麼回事？超時從哪裡來？
## 原因：HostOptions.ShutDownTimeout
您可以在應用程式關閉時執行[的框架`Host`實現](https://github.com/dotnet/runtime/blob/db2375097e40394ef270f9e0cb56baa9ab392ad2/src/libraries/Microsoft.Extensions.Hosting/src/Internal/Host.cs#L64-L107)中找到有問題的[程式碼](https://github.com/dotnet/runtime/blob/db2375097e40394ef270f9e0cb56baa9ab392ad2/src/libraries/Microsoft.Extensions.Hosting/src/Internal/Host.cs#L64-L107)。簡化的版本如下所示：
```csharp
internal class Host: IHost, IAsyncDisposable
{
private readonly HostOptions _options;
private IEnumerable _hostedServices;
public async Task StopAsync(CancellationToken cancellationToken = default)
{
// Create a cancellation token source that fires after ShutdownTimeout seconds
using (var cts = new CancellationTokenSource(_options.ShutdownTimeout))
using (var linkedCts = CancellationTokenSource.CreateLinkedTokenSource(cts.Token, cancellationToken))
{
// Create a token, which is cancelled if the timer expires
var token = linkedCts.Token;
// Run StopAsync on each registered hosted service
foreach (var hostedService in _hostedServices.Reverse())
{
// stop calling StopAsync if timer expires
token.ThrowIfCancellationRequested();
try
{
await hostedService.StopAsync(token).ConfigureAwait(false);
}
catch (Exception ex)
{
exceptions.Add(ex);
}
}
}
// .. other stopping code
}
}
```
這裡的關鍵點`CancellationTokenSource`是配置為`HostOptions.ShutdownTimeout`之後觸發的。[預設情況下，這會在5秒後觸發](https://github.com/dotnet/runtime/blob/f007634b02c4484f60ead75a893eb7f89f615ccf/src/libraries/Microsoft.Extensions.Hosting/src/HostOptions.cs)。這意味著5秒後將放棄託管服務關閉- `IHostedService`必須在此超時內關閉所有託管服務。
```csharp
public class HostOptions
{
public TimeSpan ShutdownTimeout { get; set; } = TimeSpan.FromSeconds(5);
}
```
在`foreach`迴圈的第一次迭代中，`SlowHostedService.Stopasync()`執行，需要10秒鐘才能執行。在第二次迭代中，超過了5s超時，因此`token.ThrowIfCancellationRequested();`丟擲`OperationConcelledException`。這將退出控制流，並且`NormalHostedService.Stopasync()`永遠不會執行。
有一個簡單的解決方案-增加`shutdown`超時時間！
## 解決方法：增加shutdown超時時間
`HostOptions`預設情況下未在任何地方顯式配置它，因此您需要在`ConfigureSerices`方法中手動對其進行配置。例如，以下配置將超時增加到15s：
```csharp
public void ConfigureServices(IServiceCollection services)
{
services.AddHostedService();
services.AddHostedService();
// Configure the shutdown to 15s
services.Configure(
opts => opts.ShutdownTimeout = TimeSpan.FromSeconds(15));
}
```
或者，您也可以從配置中載入超時時間。例如，如果將以下內容新增到*appsettings.json*：
```json
{
"HostOptions": {
"ShutdownTimeout": "00:00:15"
}
// other config
}
```
然後，您可以將`HostOptions`配置部分繫結到`HostOptions`物件：
```csharp
public class Startup
{
public IConfiguration Configuration { get; }
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public void ConfigureServices(IServiceCollection services)
{
services.AddHostedService();
services.AddHostedService();
// bind the config to host options
services.Configure(Configuration.GetSection("HostOptions"));
}
}
```
這會將序列化的`TimeSpan`值繫結`00:00:15`到該`HostOptions`值，並將超時間設定為15s。使用該配置，現在當我們停止應用程式時，所有服務都將正確關閉：
```bash
nfo: Microsoft.Hosting.Lifetime[0]
Application is shutting down...
info: SlowShutdown.SlowShutdownHostedService[0]
SlowShutdownHostedService stopping...
info: SlowShutdown.SlowShutdownHostedService[0]
SlowShutdownHostedService stopped
info: SlowShutdown.NormalHostedService[0]
NormalHostedService stopped
```
現在，您的應用程式將等待15秒，以使所有託管服務在退出之前完成關閉！
## 摘要
在這篇文章中，我討論了一個最近發現的問題，該問題是當應用程式關閉時，我們的應用程式未在`IHostedService`實現中的`StopAsync`中執行該方法。這是由於某些後臺服務對關閉訊號做出響應所需的時間太長，並且超過了關閉超時時間。文中我演示了單個服務需要10秒才能關閉服務來重現問題，但實際上，只要所有服務的*總*關閉時間超過預設5秒，就會發生此問題。
該問題的解決方案是`HostOptions.ShutdownTimeout`使用標準ASP.NET Core `IOptions`配置系統將配置值擴充套件為超過5s 。