.NET 中的 Worker Service 入門介紹

2021 年 5 月 6 日
筆記
docker, dotnet

翻譯自 Steve Gordon 2020年3月30日的文章《WHAT ARE .NET WORKER SERVICES?》 ^[1]

隨著 .NET Core 3.0 的發布，ASP.NET 團隊引入了一個新的 Worker Service 項目模板，該模板作為 .NET SDK 的一部分發布。在本文中，我將向您介紹這個新模板，以及使用它開發的一些實際的服務示例。

譯者註：
請先完成以下準備工作，以便於您理解本文。
1、下載並安裝最新的 .NET SDK：//dotnet.microsoft.com/download
2、命令行運行 dotnet new Worker -n "MyService" 命令，創建一個 Worker Service 項目。

什麼是 .NET Core Worker Service？

Worker Service 是使用模板構建的 .NET 項目，該模板提供了一些有用的功能，可以將常規控制台應用程式變得更加強大。Worker Service 運行於宿主(Host)的概念之上，宿主維護應用程式的生命周期。宿主還提供了一些常見的特性，如依賴注入、日誌記錄和配置。

Worker Service 通常是長時間運行的服務，執行一些規律發生的工作負載。

Worker Service 的一些例子

處理來自隊列、服務匯流排或事件流的消息、事件
響應對象、文件存儲中的文件更改
聚合數據存儲中的數據
豐富數據提取管道中的數據
AI/ML 數據集的格式化和清理

還可以開發一個這樣的 Worker Service，該服務從頭到尾執行一個過程，然後關閉。結合調度程式，便可以支援定期的批處理工作負載。例如，調度程式每隔一小時啟動一次服務，完成一些匯總數據的計算，然後關閉。

Worker Service 沒有用戶介面，也不支援直接的用戶交互，它們特別適用於設計微服務架構。在微服務體系結構中，職責通常被劃分為不同的、可單獨部署的、可伸縮的服務。隨著微服務架構的成長和發展，擁有大量的 Worker Service 會變得越來越常見。

Worker Service 模板提供了什麼？

完全可以在不使用 Worker Service 模板的情況下開發長時間運行的 Worker Service。在 .NET Core 的早期版本中我是這樣做的，使用依賴注入容器手動建立宿主，然後啟動我的處理工作負載。

在默認情況下，Worker Service 模板包含了有用的基礎組件，比如依賴注入，這樣我們就可以集中精力在其上構建業務邏輯。它包含了一個管理應用程式生命周期的宿主。

Worker Service 模板本身是相當基礎的，它只包含了三個開箱即用的核心文件。

1. Program.cs

第一個是 Program 類。該類包含 .NET 控制台應用程式所必需的 Main 方法入口點，.NET 運行時期望在啟動 .NET 應用程式時在 Program 類中查找此方法。

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureServices((hostContext, services) =>
            {
                services.AddHostedService<Worker>();
            });
}

在 Program 類中，作為 Worker Service 模板一部分的是 CreateHostBuilder 方法，該方法創建一個 IHostBuilder。IHostBuilder 介面定義了一個類型，該類型使用生成器模式生成 IHost 的實例。此模板通過調用 Host 類中的靜態 CreateDefaultBuilder 方法來創建一個新的 HostBuilder。

然後，它使用生成器來配置 IHost，該 IHost 被用於運行 Worker Service 應用程式。宿主提供了依賴注入容器和日誌記錄等功能，就像我們可以在 ASP.NET Core 應用程式中使用的那樣。事實上，從 .NET Core 3.0 開始，ASP.NET Core Web 應用程式和 .NET Core Worker Service 都運行在同一 IHost 上的。

默認情況下，它包含了一個服務註冊，稍後我會在本文中介紹，暫時不用擔心。

從 Main 方法中調用 CreateDefaultBuilder 方法，將構建並立即運行宿主。當 .NET 運行時調用 Main 方法時，應用程式啟動，宿主將保持運行，監聽標準的關閉訊號（例如按下 CTRL+C 鍵）。

2. appsettings.json

如果您以前使用過 ASP.NET Core，將會非常熟悉 appsettings.json 文件，它是應用程式配置的常見來源之一。宿主被設計為，當啟動應用程式時，使用任意已註冊的配置提供程式從多個來源載入應用程式配置。其中一種提供程式是從 appsettings.json 載入配置，該文件內容由 JSON 組成，其結構包含表示應用程式配置的鍵和值。這些值可以隨意地定義在對相關配置按邏輯分組成的片段（Sections）內。

在 Worker Service 中，啟動時會檢查相同的配置源（包括此 appsettings.json 文件和環境變數），並從不同的源構建最終的配置。默認情況下會載入多種默認的提供程式，因此也會載入多種源。如果需要，您也可以自定義宿主用來載入配置數據的提供程式。

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  }
}

模板中的默認 appsettings 文件中包含日誌記錄庫的配置設置項，默認對 Worker Service 可用。這裡的配置是為某些日誌記錄上下文設置記錄級別的。

3. Worker.cs

Worker 是一個您在默認的 ASP.NET Core 項目模板中見不到的新類。它是託管服務與宿主相結合的魔力所在，提供了 Worker Service 的基礎。

讓我們來看一下它的程式碼：

public class Worker : BackgroundService
{
    private readonly ILogger<Worker> _logger;

    public Worker(ILogger<Worker> logger)
    {
        _logger = logger;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        while (!stoppingToken.IsCancellationRequested)
        {
            _logger.LogInformation("Worker running at: {time}", DateTimeOffset.Now);
            await Task.Delay(1000, stoppingToken);
        }
    }
}

此類從 BackgroundService 抽象基類派生。BackgroundService 類實現了一個名為 IHostedService 的介面。

BackgroundService 包含一個名為 ExecuteAsync 的抽象方法，我們必須在子類中重寫該方法，就像 Worker Service 模板中提供的 Worker 類中所做的那樣。ExecuteAsync 方法返回一個 Task，在 BackgroundService 內部，期望此 Task 是一些長時間運行的工作負載。該 Task 會被啟動並在後台運行。

在內部，宿主將啟動 IHostedService 的所有註冊實現（包括從 BackgroundService 抽象類派生的類型）。請記住，BackgroundService 為我們實現了 IHostedService。

4. 如何註冊託管服務(IHostedService)？

下一個顯而易見的問題是，如何註冊 IHostedService ？如果我們返回到 Program.cs 的程式碼，我們將會找到答案：

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureServices((hostContext, services) =>
        {
            services.AddHostedService<Worker>();
        });

在 ConfigureServices 方法中，可以向依賴注入容器註冊類型。AddHostedService 是為 IServiceCollection 定義的一個擴展方法，它允許我們註冊一個實現了 IHostedService 的類。

該模板中已將 Worker 類註冊為託管服務。

在啟動時，宿主將找到已註冊的 IHostedService 的所有實例，並按順序啟動它們，此時，它們的長時間運行的工作負載會作為後台任務來運行。

為什麼要構建 .NET Core Worker Service？

簡單的答案是——何時以及是否需要它們！如果您需要開發一個微服務，它沒有用戶介面，並執行長時間運行的工作，那麼 Worker Service 很可能是一個好的選擇。

請記住，Worker Service 的底層只是一個控制台應用程式。該控制台應用程式使用宿主將應用程式轉換為運行的服務，直到收到停止的訊號。宿主帶來了您可能已經熟悉的一些特性，比如依賴關係注入。使用和 ASP.NET Core 中可用的相同的日誌記錄和配置擴展，使得開發可記錄日誌資訊且需要一些配置的 Worker Service 變得相當輕鬆。當構建運行在雲上的 Worker Service 時，幾乎總會存在這種需求。例如，您可能需要為與您的 Worker Service 相交互的任何外部服務提供配置（比如一個隊列 URL）。

Worker Service 可用於從現有的 ASP.NET Core 應用程式提取職責，設計新的基於 .NET Core 的微服務。

總結

在本文中，我介紹了 Worker Service 項目模板，以及它的一些潛在用例。我們探索了使用 Worker Service 模板創建的新項目中所包含的三個默認文件。

Worker Service 模板包含哪些文件？

Program.cs：控制台應用程式的入口點，創建並運行宿主以管理應用程式生命周期並生成一個長期運行的服務。
appsettings.json：一個提供應用程式配置值的 JSON 文件。
Worker.cs：派生自 BackgroundService 基類，用於定義作為後台任務執行的長時間運行的工作負載。

Worker Service 是什麼？

不需要用戶交互的應用程式。
使用宿主來維護控制台應用程式的生命周期，直到宿主收到關閉的訊號。將控制台應用程式轉換為長時間運行的服務。
包含和 ASP.NET Core 相同的功能，如依賴注入、日誌記錄和配置。
執行定期和長時間運行的工作負載。

作者： Steve Gordon
譯者：技術譯民
出品：技術譯站
鏈接：英文原文

//www.stevejgordon.co.uk/what-are-dotnet-worker-services WHAT ARE .NET WORKER SERVICES? ↩︎

Tags: docker dotnet