.net 中worker service的使用入門

譯者注：
請先完成以下準(zhǔn)備工作，以便于您理解本文。
1、下載并安裝最新的 .net sdk：https://dotnet.microsoft.com/download
2、命令行運行dotnet new worker -n "myservice"命令，創(chuàng)建一個 worker service 項目。

什么是 .net core worker service？

worker service 是使用模板構(gòu)建的 .net 項目，該模板提供了一些有用的功能，可以將常規(guī)控制臺應(yīng)用程序變得更加強大。worker service 運行于宿主(host)的概念之上，宿主維護應(yīng)用程序的生命周期。宿主還提供了一些常見的特性，如依賴注入、日志記錄和配置。

worker service 通常是長時間運行的服務(wù)，執(zhí)行一些規(guī)律發(fā)生的工作負(fù)載。

§worker service 的一些例子

• 處理來自隊列、服務(wù)總線或事件流的消息、事件
• 響應(yīng)對象、文件存儲中的文件更改
• 聚合數(shù)據(jù)存儲中的數(shù)據(jù)
• 豐富數(shù)據(jù)提取管道中的數(shù)據(jù)
• ai/ml 數(shù)據(jù)集的格式化和清理

還可以開發(fā)一個這樣的 worker service，該服務(wù)從頭到尾執(zhí)行一個過程，然后關(guān)閉。結(jié)合調(diào)度程序，便可以支持定期的批處理工作負(fù)載。例如，調(diào)度程序每隔一小時啟動一次服務(wù)，完成一些匯總數(shù)據(jù)的計算，然后關(guān)閉。

worker service 沒有用戶界面，也不支持直接的用戶交互，它們特別適用于設(shè)計微服務(wù)架構(gòu)。在微服務(wù)體系結(jié)構(gòu)中，職責(zé)通常被劃分為不同的、可單獨部署的、可伸縮的服務(wù)。隨著微服務(wù)架構(gòu)的成長和發(fā)展，擁有大量的 worker service 會變得越來越常見。

worker service 模板提供了什么？

完全可以在不使用 worker service 模板的情況下開發(fā)長時間運行的 worker service。在 .net core 的早期版本中我是這樣做的，使用依賴注入容器手動建立宿主，然后啟動我的處理工作負(fù)載。

在默認(rèn)情況下，worker service 模板包含了有用的基礎(chǔ)組件，比如依賴注入，這樣我們就可以集中精力在其上構(gòu)建業(yè)務(wù)邏輯。它包含了一個管理應(yīng)用程序生命周期的宿主。

worker service 模板本身是相當(dāng)基礎(chǔ)的，它只包含了三個開箱即用的核心文件。

§1. program.cs

第一個是program類。該類包含 .net 控制臺應(yīng)用程序所必需的main方法入口點，.net 運行時期望在啟動 .net 應(yīng)用程序時在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方法，該方法創(chuàng)建一個ihostbuilder。ihostbuilder接口定義了一個類型，該類型使用生成器模式生成ihost的實例。此模板通過調(diào)用host類中的靜態(tài)createdefaultbuilder方法來創(chuàng)建一個新的hostbuilder。

然后，它使用生成器來配置ihost，該ihost被用于運行 worker service 應(yīng)用程序。宿主提供了依賴注入容器和日志記錄等功能，就像我們可以在 asp.net core 應(yīng)用程序中使用的那樣。事實上，從 .net core 3.0 開始，asp.net core web 應(yīng)用程序和 .net core worker service 都運行在同一ihost上的。

默認(rèn)情況下，它包含了一個服務(wù)注冊，稍后我會在本文中介紹，暫時不用擔(dān)心。

從main方法中調(diào)用createdefaultbuilder方法，將構(gòu)建并立即運行宿主。當(dāng) .net 運行時調(diào)用main方法時，應(yīng)用程序啟動，宿主將保持運行，監(jiān)聽標(biāo)準(zhǔn)的關(guān)閉信號（例如按下ctrl+c鍵）。

§2. appsettings.json

如果您以前使用過 asp.net core，將會非常熟悉appsettings.json文件，它是應(yīng)用程序配置的常見來源之一。宿主被設(shè)計為，當(dāng)啟動應(yīng)用程序時，使用任意已注冊的配置提供程序從多個來源加載應(yīng)用程序配置。其中一種提供程序是從appsettings.json加載配置，該文件內(nèi)容由 json 組成，其結(jié)構(gòu)包含表示應(yīng)用程序配置的鍵和值。這些值可以隨意地定義在對相關(guān)配置按邏輯分組成的片段（sections）內(nèi)。

在 worker service 中，啟動時會檢查相同的配置源（包括此appsettings.json文件和環(huán)境變量），并從不同的源構(gòu)建最終的配置。默認(rèn)情況下會加載多種默認(rèn)的提供程序，因此也會加載多種源。如果需要，您也可以自定義宿主用來加載配置數(shù)據(jù)的提供程序。

{
"logging": {
  "loglevel": {
    "default": "information",
    "microsoft": "warning",
    "microsoft.hosting.lifetime": "information"
  }
}
}

模板中的默認(rèn)appsettings文件中包含日志記錄庫的配置設(shè)置項，默認(rèn)對 worker service 可用。這里的配置是為某些日志記錄上下文設(shè)置記錄級別的。

§3. worker.cs

worker是一個您在默認(rèn)的 asp.net core 項目模板中見不到的新類。它是托管服務(wù)與宿主相結(jié)合的魔力所在，提供了 worker service 的基礎(chǔ)。

讓我們來看一下它的代碼：

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類實現(xiàn)了一個名為ihostedservice的接口。

backgroundservice包含一個名為executeasync的抽象方法，我們必須在子類中重寫該方法，就像 worker service 模板中提供的worker類中所做的那樣。executeasync方法返回一個task，在backgroundservice內(nèi)部，期望此task是一些長時間運行的工作負(fù)載。該task會被啟動并在后臺運行。

在內(nèi)部，宿主將啟動ihostedservice的所有注冊實現(xiàn)（包括從backgroundservice抽象類派生的類型）。請記住，backgroundservice為我們實現(xiàn)了ihostedservice。

§4. 如何注冊托管服務(wù)(ihostedservice)？

下一個顯而易見的問題是，如何注冊ihostedservice？如果我們返回到program.cs的代碼，我們將會找到答案：

public static ihostbuilder createhostbuilder(string[] args) =>
  host.createdefaultbuilder(args)
      .configureservices((hostcontext, services) =>
      {
          services.addhostedservice<worker>();
      });

在configureservices方法中，可以向依賴注入容器注冊類型。addhostedservice是為iservicecollection定義的一個擴展方法，它允許我們注冊一個實現(xiàn)了ihostedservice的類。

該模板中已將worker類注冊為托管服務(wù)。

在啟動時，宿主將找到已注冊的ihostedservice的所有實例，并按順序啟動它們，此時，它們的長時間運行的工作負(fù)載會作為后臺任務(wù)來運行。

為什么要構(gòu)建 .net core worker service？

簡單的答案是――何時以及是否需要它們！如果您需要開發(fā)一個微服務(wù)，它沒有用戶界面，并執(zhí)行長時間運行的工作，那么 worker service 很可能是一個好的選擇。

請記住，worker service 的底層只是一個控制臺應(yīng)用程序。該控制臺應(yīng)用程序使用宿主將應(yīng)用程序轉(zhuǎn)換為運行的服務(wù)，直到收到停止的信號。宿主帶來了您可能已經(jīng)熟悉的一些特性，比如依賴關(guān)系注入。使用和 asp.net core 中可用的相同的日志記錄和配置擴展，使得開發(fā)可記錄日志信息且需要一些配置的 worker service 變得相當(dāng)輕松。當(dāng)構(gòu)建運行在云上的 worker service 時，幾乎總會存在這種需求。例如，您可能需要為與您的 worker service 相交互的任何外部服務(wù)提供配置（比如一個隊列 url）。

worker service 可用于從現(xiàn)有的 asp.net core 應(yīng)用程序提取職責(zé)，設(shè)計新的基于 .net core 的微服務(wù)。

總結(jié)

在本文中，我介紹了 worker service 項目模板，以及它的一些潛在用例。我們探索了使用 worker service 模板創(chuàng)建的新項目中所包含的三個默認(rèn)文件。

§worker service 模板包含哪些文件？

• program.cs：控制臺應(yīng)用程序的入口點，創(chuàng)建并運行宿主以管理應(yīng)用程序生命周期并生成一個長期運行的服務(wù)。
• appsettings.json：一個提供應(yīng)用程序配置值的 json 文件。
• worker.cs：派生自backgroundservice基類，用于定義作為后臺任務(wù)執(zhí)行的長時間運行的工作負(fù)載。

§worker service 是什么？

• 不需要用戶交互的應(yīng)用程序。
• 使用宿主來維護控制臺應(yīng)用程序的生命周期，直到宿主收到關(guān)閉的信號。將控制臺應(yīng)用程序轉(zhuǎn)換為長時間運行的服務(wù)。
• 包含和 asp.net core 相同的功能，如依賴注入、日志記錄和配置。
• 執(zhí)行定期和長時間運行的工作負(fù)載。

以上就是.net 中worker service的使用入門的詳細(xì)內(nèi)容，更多關(guān)于.net 中worker service的使用的資料請關(guān)注碩編程其它相關(guān)文章！