一文说通Dotnet Core的后台任务
這是一文說通系列的第二篇，里面有些內容會用到第一篇中間件的部分概念。如果需要，可以參看第一篇：一文說通Dotnet Core的中間件
?
一、前言
后臺任務在一些特殊的應用場合，有相當的需求。
比方，我們需要實現一個定時任務、或周期性的任務、或非API輸出的業務響應、或不允許并發的業務處理，像提現、支付回調等，都需要用到后臺任務。
?
通常，我們在實現后臺任務時，有兩種選擇：WebAPI和Console。
下面，我們會用實際的代碼，來理清這兩種工程模式下，后臺任務的開發方式。
二、開發環境&基礎工程
這個Demo的開發環境是：Mac + VS Code + Dotnet Core 3.1.2。
$?dotnet?--info .NET?Core?SDK?(reflecting?any?global.json):Version:???3.1.201Commit:????b1768b4ae7Runtime?Environment:OS?Name:?????Mac?OS?XOS?Version:??10.15OS?Platform:?DarwinRID:?????????osx.10.15-x64Base?Path:???/usr/local/share/dotnet/sdk/3.1.201/Host?(useful?for?support):Version:?3.1.3Commit:??4a9f85e9f8.NET?Core?SDKs?installed:3.1.201?[/usr/local/share/dotnet/sdk].NET?Core?runtimes?installed:Microsoft.AspNetCore.App?3.1.3?[/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App]Microsoft.NETCore.App?3.1.3?[/usr/local/share/dotnet/shared/Microsoft.NETCore.App]?
首先，在這個環境下建立工程：
創建Solution
這次，我們用Webapi創建工程
把工程加到Solution中
基礎工程搭建完成。
三、在WebAPI下實現一個后臺任務
WebAPI下后臺任務需要作為托管服務來實現，而托管服務，需要實現IHostedService接口。
?
首先，我們需要引入一個庫：
%?cd?webapidemo %?dotnet?add?package?Microsoft.Extensions.Hosting引入后，我們就有了IHostedService。
?
下面，我們來做一個IHostedService的派生托管類：
namespace?webapidemo {public?class?DemoService?:?IHostedService{public?DemoService(){}public?Task?StartAsync(CancellationToken?cancellationToken){throw?new?NotImplementedException();}public?Task?StopAsync(CancellationToken?cancellationToken){throw?new?NotImplementedException();}} }IHostedService需要實現兩個方法：StartAsync和StopAsync。其中：
StartAsync：用于啟動后臺任務；
StopAsync：主機Host正常關閉時觸發。
?
如果派生類中有任何非托管資源，那還可以引入IDisposable，并通過實現Dispose來清理非托管資源。
?
這個類生成后，我們將這個類注入到ConfigureServices中，以使這個類在Startup.Configure調用之前被調用：
public?void?ConfigureServices(IServiceCollection?services) {services.AddControllers();services.AddHostedService<DemoService>(); }下面，我們用一個定時器的后臺任務，來加深理解：
namespace?webapidemo {public?class?TimerService?:?IHostedService,?IDisposable{/*?下面這兩個參數是演示需要，非必須?*/private?readonly?ILogger?_logger;private?int?executionCount?=?0;/*?這個是定時器?*/private?Timer?_timer;public?TimerService(ILogger<TimerService>?logger){_logger?=?logger;}public?void?Dispose(){_timer?.Dispose();}private?void?DoWork(object?state){var?count?=?Interlocked.Increment(ref?executionCount);_logger.LogInformation($"Service?proccessing?{count}");}public?Task?StartAsync(CancellationToken?cancellationToken){_logger.LogInformation("Service?starting");_timer?=?new?Timer(DoWork,?null,?TimeSpan.Zero,?TimeSpan.FromSeconds(5));return?Task.CompletedTask;}public?Task?StopAsync(CancellationToken?cancellationToken){_logger.LogInformation("Service?stopping");_timer?.Change(Timeout.Infinite,?0);return?Task.CompletedTask;}} }注入到ConfigureServices中：
public?void?ConfigureServices(IServiceCollection?services) {services.AddControllers();services.AddHostedService<TimerService>(); }就OK了。代碼比較簡單，就不解釋了。
四、WebAPI后臺任務的依賴注入變形
上一節的示例，是一個簡單的形態。
下面，我們按照標準的依賴注入，實現一下這個定時器。
?
依賴注入的簡單樣式，請參見一文說通Dotnet Core的中間件。
?
首先，我們創建一個接口IWorkService：
namespace?webapidemo {public?interface?IWorkService{Task?DoWork();} }再根據IWorkService，建立一個實體類：
namespace?webapidemo {public?class?WorkService?:?IWorkService{private?readonly?ILogger?_logger;private?Timer?_timer;private?int?executionCount?=?0;public?WorkService(ILogger<WorkService>?logger){_logger?=?logger;}public?async?Task?DoWork(){var?count?=?Interlocked.Increment(ref?executionCount);_logger.LogInformation($"Service?proccessing?{count}");}} }這樣就建好了依賴的全部內容。
?
下面，創建托管類：
namespace?webapidemo {public?class?HostedService?:?IHostedService,?IDisposable{private?readonly?ILogger<HostedService>?_logger;public?IServiceProvider?Services?{?get;?}private?Timer?_timer;public?HostedService(IServiceProvider?services,?ILogger<HostedService>?logger){Services?=?services;_logger?=?logger;}public?void?Dispose(){_timer?.Dispose();}private?void?DoWork(object?state){_logger.LogInformation("Service?working");using?(var?scope?=?Services.CreateScope()){var?scopedProcessingService?=scope.ServiceProvider.GetRequiredService<IWorkService>();scopedProcessingService.DoWork().GetAwaiter().GetResult();}}public?Task?StartAsync(CancellationToken?cancellationToken){_logger.LogInformation("Service?starting");_timer?=?new?Timer(DoWork,?null,?TimeSpan.Zero,?TimeSpan.FromSeconds(5));return?Task.CompletedTask;}public?Task?StopAsync(CancellationToken?cancellationToken){_logger.LogInformation("Service?stopping");_timer?.Change(Timeout.Infinite,?0);return?Task.CompletedTask;}} }把托管類注入到ConfigureServices中：
public?void?ConfigureServices(IServiceCollection?services) {services.AddControllers();services.AddHostedService<HostedService>();services.AddSingleton<IWorkService,?WorkService>(); }這樣就完成了。
?
這種模式下，可以根據注入的內容切換應用的執行內容。不過，這種模式需要注意services.AddSingleton、services.AddScoped和services.AddTransient的區別。
五、Console下的后臺任務
Console應用本身就是后臺運行，所以區別于WebAPI，它不需要托管運行，也不需要Microsoft.Extensions.Hosting庫。
我們要做的，就是讓程序運行，就OK。
?
下面是一個簡單的Console模板：
namespace?consoledemo {class?Program{private?static?AutoResetEvent?_exitEvent;static?async?Task?Main(string[]?args){/*?確保程序只有一個實例在運行?*/bool?isRuned;Mutex?mutex?=?new?Mutex(true,?"OnlyRunOneInstance",?out?isRuned);if?(!isRuned)return;await?DoWork();/*?后臺等待?*/_exitEvent?=?new?AutoResetEvent(false);_exitEvent.WaitOne();}private?static?async?Task?DoWork(){throw?new?NotImplementedException();}} }這個模板有兩個關鍵的內容：
單實例運行：通常后臺任務，只需要有一個實例運行。所以，第一個小段，是解決單實例運行的。多次啟動時，除了第一個實例外，其它的實例會自動退出；
后臺等待：看過很多人寫的，在這兒做后臺等待時，用了一個無限的循環。類似于下面的：
這種方式也沒什么太大的問題。不過，這段代碼總是要消耗CPU的計算量，雖然很少，但做為后臺任務，或者說Service，畢竟是一種消耗，而且看著不夠高大上。
?
當然如果我們需要中斷，我們也可以把這個模板改成這樣：
namespace?consoledemo {class?Program{private?static?AutoResetEvent?_exitEvent;static?async?Task?Main(string[]?args){bool?isRuned;Mutex?mutex?=?new?Mutex(true,?"OnlyRunOneInstance",?out?isRuned);if?(!isRuned)return;_exitEvent?=?new?AutoResetEvent(false);await?DoWork(_exitEvent);_exitEvent.WaitOne();}private?static?async?Task?DoWork(AutoResetEvent?_exitEvent){/*?Your?Code?Here?*/_exitEvent.Set();}} }這樣就可以根據需要，來實現中斷程序并退出。
六、Console應用的其它運行方式
上一節介紹的Console，其實是一個應用程序。
在實際應用中，Console程序跑在Linux服務器上，我們可能會有一些其它的要求：
定時運行
Linux上有一個Service，叫cron，是一個用來定時執行程序的服務。
這個服務的設定，需要另一個命令：crontab，位置在/usr/bin下。
具體命令格式這兒不做解釋，網上隨便查。
運行到后臺
命令后邊加個&字符即可：
$?./command?&運行為Service
需要持續運行的應用，如果以Console的形態存在，則設置為Service是最好的方式。
Linux下，設置一個應用為Service很簡單，就這么簡單三步：
第一步：在/etc/systemd/system下面，創建一個service文件，例如command.service：
[Unit] #?Service的描述，隨便寫 Description=Command[Service] RestartSec=2s Type=simple #?執行應用的默認用戶。應用如果沒有特殊要求，最好別用root運行 User=your_user_name Group=your_group_name #?應用的目錄，絕對路徑 WorkingDirectory=your_app_folder #?應用的啟動路徑 ExecStart=your_app_folder/your_app Restart=always[Install] WantedBy=multi-user.target差不多就這么個格式。參數的詳細說明可以去網上查，實際除了設置，就是運行了一個腳本。
第二步：把這個command.service加上運行權限：
#?chmod?+x?./command.service第三步：注冊為Service：
#?systemctl?enable?command.service完成。
為了配合應用，還需要記住兩個命令：啟動和關閉Service
#?#啟動Service #?systemctl?start?command.service #?#關閉Service #?systemctl?stop?command.service七、寫在后邊的話
今天這個文章，是因為前兩天，一個兄弟跑過來問我關于數據總線的實現方式，而想到的一個點。
?
很多時候，大家在寫代碼的時候，會有一種固有的思想：寫WebAPI，就想在這個框架中把所有的內容都實現了。這其實不算是一個很好的想法。WebAPI，在業務層面，就應該只是實現簡單的處理請求，返回結果的工作，而后臺任務跟這個內容截然不同，通常它只做處理，不做返回 --- 事實上也不太好返回，要么客戶端等待時間太長，要么客戶端已經斷掉了。換句話說，用WebAPI實現總線，絕不是一個好的方式。
不過，Console運行為Service，倒是一個總線應用的絕好方式。如果需要按序執行，可以配合MQ服務器，例如RabbitMQ，來實現消息的按序處理。
?
再說代碼。很多需求，本來可以用很簡單的方式實現。模式這個東西，用來面試，用來講課，都是很好的內容，但實際開發中，如果有更簡單更有效的方式，用起來！Coding的工作是實現，而不是秀技術。當然，能否找到簡單有效的方式，這個可能跟實際的技術面有關系。但這并不是一個不能跨越的坎。
多看，多想，每天成長一點點！
?
今天的代碼，在：https://github.com/humornif/Demo-Code/tree/master/0012/demo
（全文完）
點「在看」，讓更多人因你而受益
↘ ?↘ ?↘
總結
以上是生活随笔為你收集整理的一文说通Dotnet Core的后台任务的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： Beetlex.Redis之Stream
- 下一篇： 别了，Docker Swarm ！你好，