Worker Service in ASP .NET Core

介紹

提到 ASP.NET Core,咱們多半會想到 ASP.NET MVC、ASP.NET Web API、Razor page 及 Blazor。隨着 .NET Core 3.0 的推出,今天會介紹一個全新推出的功能:Work Service 。咱們能夠在 Visual Studio 2019 中經過預約的項目模版快速建立一個 WorkService項目。web

或者使用 .NET CLI:shell

> dotnet new worker -o myWorkServiceProject

-o 是一個可選標誌,用於指定項目輸出文件夾名稱。關於 Work Service 模版的更多信息能夠參考:WorkService。  bash

示例

首先咱們建立一個 .NET Core 控制檯程序。async

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

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

 

注意事項:ide

  • 從 ASP.NET Core 3.0 起 WebHost 將被更通用的 Host 取代。
  • CreateHostBuilder 建立主機並在 ConfigureServices 中調用 AddHostedService<T> 來配置它。

Worker 類繼承了 BackgroundService 下面貼出代碼:函數

public class Worker : BackgroundService
{
   // ...
 
   protected override async Task ExecuteAsync(CancellationToken stoppingToken)
   {
      // do stuff here
   }
}

 

咱們能夠經過 override ExecuteAsync 來完成本身要作的事情。ui

接下來咱們添加一個日誌組件,用於記錄日誌:this

using Microsoft.Extensions.Logging;

 

public static IHostBuilder CreateHostBuilder(string[] args) =>
 Host.CreateDefaultBuilder(args)
 .UseWindowsService()
 .ConfigureLogging(loggerFactory => loggerFactory.AddEventLog())
 .ConfigureServices(services =>
 {
    services.AddHostedService<Worker>();
 });

 

添加完日誌組件後,咱們能夠在 Worker 類的構造函數中注入日誌記錄器:spa

private readonly ILogger<Worker> _logger;

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

 

運行

注意:咱們須要以管理員模式打開 Powershell 或 cmd 窗口。在運行以前咱們須要在入口添加或確認有對 UseWindowsService() [早期此方法的名稱是:UseServiceBaseLifetime()]的調用:.net

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

可經過給 UseWindowsService 方法傳遞參數設置 Windows 服務。

 

發佈

dotnet publish -o C:\path\to\project\pubfolder

 

將程序發佈到 pubfolder 文件夾中之後,咱們開始經過 sc.exe 建立 Windows 服務。

> C:\Windows\System32\sc create MyServiceName binPath=C:\path\to\project\pubfolder\MyProjectName.exe

 

服務建立完成後,它會出如今Windows 服務列表中,當咱們手動啓動服務時,應該會看到日誌的輸出:

info: WorkerServiceSample.Worker[0]
 Making doc 1 at: 06/09/2019 00:09:52 -04:00
Making your document...
info: WorkerServiceSample.Worker[0]
 Making doc 2 at: 06/09/2019 00:10:05 -04:00
Making your document...
info: Microsoft.Hosting.Lifetime[0]
 Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
 Hosting environment: Development

 注意:在非 Windows 平臺上調用 UseWindowsService 方法也是不會報錯的,非 Windows 平臺會忽略此調用。

 以上就是介紹的所有內容了。若是想用 .NET Core 開發 Windows 服務的,不防試試看。

相關文章
相關標籤/搜索