.NET 8 強大功能 IHostedService 與 BackgroundService 實戰(zhàn)教程
前言
在.NET 8中,IHostedService 和 BackgroundService 兩個核心接口的引入,增強了項目開發(fā)中處理定時任務的能力。這兩個接口不僅簡化了定時任務、后臺處理作業(yè)以及定期維護任務的實現(xiàn)過程,還提升了在ASP.NET Core 或任何基于.NET的宿主應用程序中的集成與管理效率。
IHostedService接口提供了一個基本的框架,允許自定義后臺服務的啟動和停止邏輯。通過實現(xiàn)該接口,可以靈活地控制服務的生命周期,確保任務在應用程序啟動時自動運行,并在應用程序關閉時結束。
而 BackgroundService 類則是對 IHostedService 接口的進一步封裝,它專為需要長時間運行的任務而設計。
通過繼承 BackgroundService并重寫其 ExecuteAsync方法,可以輕松地實現(xiàn)復雜的后臺邏輯,如循環(huán)執(zhí)行的任務、基于時間間隔的操作等。這種設計模式讓代碼的可讀性和可維護性變的更好。
利用這些功能,可以快速構建出高效、可靠的定時任務系統(tǒng),用于執(zhí)行諸如消息推送、數(shù)據(jù)更新、定時發(fā)布等關鍵業(yè)務操作。這些任務可以在不影響應用程序主流程的情況下獨立運行,從而提高了整個系統(tǒng)的性能和穩(wěn)定性。
介紹
.NET 中的后臺服務允許在后臺獨立于主應用程序線程運行任務。這對于需要連續(xù)或定期運行而不阻塞主應用程序流的任務至關重要。
IHostedService
IHostedService 是一個簡單的接口,用于實現(xiàn)后臺服務。當需要實現(xiàn)自定義的托管服務時,可以通過實現(xiàn)這個接口來創(chuàng)建。
該接口定義了兩個方法:StartAsync(CancellationToken cancellationToken) 和 StopAsync(CancellationToken cancellationToken),分別用于啟動和停止服務。
BackgroundService
BackgroundService 是一個抽象類,它繼承自 IHostedService 并提供了更簡潔的方式來編寫后臺服務。它通常用于需要長時間運行的任務,如監(jiān)聽器、工作隊列處理器等。通過重寫 ExecuteAsync(CancellationToken stoppingToken)方法,可以在其中編寫任務的邏輯。ExecuteAsync方法會循環(huán)在后臺執(zhí)行,直到服務停止。
IHostedService 示例
1、注冊服務
Program.cs 中添加配置,.NET 5 及以下在需要在 Startup.cs 注冊服務。
// .NET 8 using ManageCore.Api; var builder = WebApplication.CreateBuilder(args); builder.Services.AddControllers(); builder.Services.AddEndpointsApiExplorer(); builder.Services.AddSwaggerGen(); builder.Services.AddHostedService<DemoHostedService>(); var app = builder.Build();
2、創(chuàng)建服務接口
創(chuàng)建一個類,該類繼承 IHostedService 接口,并實現(xiàn)該接口成員.
在不需要定時執(zhí)行任務的時候,也可以在這里進行應用啟動后的操作,例如創(chuàng)建 RabbitMQ 連接
using Microsoft.Extensions.Hosting; namespace ManageCore.Api { public class DemoHostedService : IHostedService, IDisposable { private Timer? _timer; public Task StartAsync(CancellationToken cancellationToken) { _timer = new Timer(DoWork, null, TimeSpan.Zero, TimeSpan.FromSeconds(5)); return Task.CompletedTask; } private void DoWork(object? state) { Console.WriteLine($"{DateTime.Now:yyyy-MM-dd HH:mm:ss}"); } public Task StopAsync(CancellationToken cancellationToken) { Console.WriteLine("StopAsync"); return Task.CompletedTask; } public void Dispose() { _timer?.Dispose(); } } }
上面的Demo代碼非常簡單,應用在運行后,會去執(zhí)行 StartAsync 函數(shù),應用關閉執(zhí)行 StopAsync,由于這里使用的定時器,所以每過5秒都會執(zhí)行一次 DoWork 函數(shù)。
3、運行效果
4、IHostedService 說明
注意:定時是不等待任務執(zhí)行完成,只要時間一到,就會調用 DoWork 函數(shù),所以適合一些簡單、特定的場景。
以下為官方文檔對 IHostedService 接口 的說明
IHostedService 接口為主機托管的對象定義了兩種方法:
- StartAsync(CancellationToken)
- StopAsync(CancellationToken)
StartAsync(CancellationToken) 包含用于啟動后臺任務的邏輯。 在以下操作之前調用 `StartAsync`:已配置應用的請求處理管道。已啟動服務器且已觸發(fā) IApplicationLifetime.ApplicationStarted。
StartAsync應僅限于短期任務,因為托管服務是按順序運行的,在 StartAsync 運行完成之前不會啟動其他服務。
StopAsync(CancellationToken) 在主機執(zhí)行正常關閉時觸發(fā)。 StopAsync`包含結束后臺任務的邏輯。 實現(xiàn) IDisposable 和終結器(析構函數(shù))以處置任何非托管資源。
默認情況下,取消令牌會有五秒超時,以指示關閉進程不再正常。 在令牌上請求取消時:
- 應中止應用正在執(zhí)行的任何剩余后臺操作。
- StopAsync 中調用的任何方法都應及時返回。
但是,在請求取消后,將不會放棄任務,調用方會等待所有任務完成。
如果應用意外關閉(例如,應用的進程失?。?,則可能不會調用 StopAsync。 因此,在 StopAsync 中執(zhí)行的任何方法或操作都可能不會發(fā)生。
若要延長默認值為 5 秒的關閉超時值,請設置:
- ShutdownTimeout(當使用通用主機時)
- 使用 Web 主機時為關閉超時值主機配置設置
托管服務在應用啟動時激活一次,在應用關閉時正常關閉。 如果在執(zhí)行后臺任務期間引發(fā)錯誤,即使未調用 StopAsync,也應調用 Dispose。
BackgroundService 示例
1、注冊服務
首先,同樣需要在配置中注冊服務接口。
using ManageCore.Api; var builder = WebApplication.CreateBuilder(args); builder.Services.AddControllers(); builder.Services.AddEndpointsApiExplorer(); builder.Services.AddSwaggerGen(); builder.Services.AddScoped<IDemoTaskWorkService, DemoTaskWorkService>();
2、BackgroundService 源碼
查看 BackgroundService 的源碼,幫助我們理解BackgroundService 實現(xiàn)原理。BackgroundService 是 IHostedService的一個簡單實現(xiàn),內部 IHostedService 的 StartAsync 調用了 ExecuteAsync,本質上就是使用了 IHostedService。
public abstract class BackgroundService : IHostedService, IDisposable { private Task _executingTask; private readonly CancellationTokenSource _stoppingCts = new CancellationTokenSource(); /// <summary> /// This method is called when the <see cref="IHostedService"/> starts. The implementation should return a task that represents /// the lifetime of the long running operation(s) being performed. /// /// </summary> /// <param name="stoppingToken">Triggered when <see cref="IHostedService.StopAsync(CancellationToken)"/> is called.</param> /// <returns>A <see cref="Task"/> that represents the long running operations.</returns> protected abstract Task ExecuteAsync(CancellationToken stoppingToken); /// <summary> /// Triggered when the application host is ready to start the service. /// </summary> /// <param name="cancellationToken">Indicates that the start process has been aborted.</param> public virtual Task StartAsync(CancellationToken cancellationToken) { // Store the task we're executing _executingTask = ExecuteAsync(_stoppingCts.Token); // If the task is completed then return it, this will bubble cancellation and failure to the caller if (_executingTask.IsCompleted) { return _executingTask; } // Otherwise it's running return Task.CompletedTask; } /// <summary> /// Triggered when the application host is performing a graceful shutdown. /// </summary> /// <param name="cancellationToken">Indicates that the shutdown process should no longer be graceful.</param> public virtual async Task StopAsync(CancellationToken cancellationToken) { // Stop called without start if (_executingTask == null) { return; } try { // Signal cancellation to the executing method _stoppingCts.Cancel(); } finally { // Wait until the task completes or the stop token triggers await Task.WhenAny(_executingTask, Task.Delay(Timeout.Infinite, cancellationToken)); } } public virtual void Dispose() { _stoppingCts.Cancel(); } }
3、創(chuàng)建服務接口
創(chuàng)建一個服務接口,定義需要實現(xiàn)的任務,以及對應的實現(xiàn),如果需要執(zhí)行異步方法,記得加上 await,不然任務將不會等待執(zhí)行結果,直接進行下一個任務。
namespace ManageCore.Api { public interface IDemoTaskWorkService { /// <summary> /// 測試任務 /// </summary> /// <param name="stoppingToken"></param> /// <returns></returns> Task TaskWorkAsync(CancellationToken stoppingToken); } }
public class DemoTaskWorkService : IDemoTaskWorkService { /// <summary> /// 任務執(zhí)行 /// </summary> /// <param name="stoppingToken"></param> /// <returns></returns> public async Task TaskWorkAsync(CancellationToken stoppingToken) { while (!stoppingToken.IsCancellationRequested) { //執(zhí)行任務 Console.WriteLine($"{DateTime.Now}"); //周期性任務,于上次任務執(zhí)行完成后,等待5秒,執(zhí)行下一次任務 await Task.Delay(500); } } }
創(chuàng)建后臺服務類,繼承基類 BackgroundService,這里需要注意的是,要在 BackgroundService 中使用有作用域的服務,請創(chuàng)建作用域, 默認情況下,不會為托管服務創(chuàng)建作用域,得自己管理服務的生命周期,切記!于構造函數(shù)中注入 IServiceProvider即可。
namespace ManageCore.Api { public class DemoBackgroundService : BackgroundService { private readonly IServiceProvider _services; public DemoBackgroundService(IServiceProvider services) { _services = services; } protected override async Task ExecuteAsync(CancellationToken stoppingToken) { using var scope = _services.CreateScope(); var taskWorkService = scope.ServiceProvider.GetRequiredService<IDemoTaskWorkService>(); await taskWorkService.TaskWorkAsync(stoppingToken); } } }
DemoBackgroundService類也是需要注冊的,注冊方式與 IHostedService 接口的方式一樣
builder.Services.AddHostedService<DemoBackgroundService>();
4、運行效果
5、BackgroundService 說明
BackgroundService 是用于實現(xiàn)長時間運行的 IHostedService 的基類。
調用 ExecuteAsync(CancellationToken) 來運行后臺服務。 實現(xiàn)返回一個 Task,其表示后臺服務的整個生存期。
在 ExecuteAsync 變?yōu)楫惒剑ɡ缤ㄟ^調用 await)之前,不會啟動任何其他服務。 避免在 ExecuteAsync 中執(zhí)行長時間的阻塞初始化工作。
StopAsync(CancellationToken) 中的主機塊等待完成 ExecuteAsync。
調用 IHostedService.StopAsync 時,將觸發(fā)取消令牌。 當激發(fā)取消令牌以便正常關閉服務時,ExecuteAsync 的實現(xiàn)應立即完成。 否則,服務將在關閉超時后不正常關閉。
StartAsync 應僅限于短期任務,因為托管服務是按順序運行的,在 StartAsync 運行完成之前不會啟動其他服務。
長期任務應放置在 ExecuteAsync 中。
IHostedService 和 BackgroundService 區(qū)別
抽象級別
- IHostedService:需要手動實現(xiàn)啟動和停止邏輯。
- BackgroundService:通過提供具有要重寫的單個方法的基類來簡化實現(xiàn)。
使用案例
- IHostedService:適用于需要對服務生命周期進行精細控制的更復雜的方案。
- BackgroundService:非常適合受益于減少樣板代碼的更簡單、長時間運行的任務。
總結
總之.NET 8 中的 IHostedService 和 BackgroundService 提供了強大的工具集,使定時任務、后臺處理以及定期維護等功能的實現(xiàn)變得更加直接、高效和靈活。無論是構建復雜的企業(yè)級應用還是簡單的服務應用,這兩個組件都能提供穩(wěn)定且高效的解決方案。
到此這篇關于.NET 8 強大功能 IHostedService 與 BackgroundService 實戰(zhàn)的文章就介紹到這了,更多相關.NET 8 IHostedService 與 BackgroundService 內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
.NET Core 2.0遷移小技巧之web.config 配置文件示例詳解
這篇文章主要給大家介紹了關于.NET Core 2.0遷移技巧之web.config 配置文件的相關資料,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面跟著小編來一起學習學習吧。2017-08-08ASP.NET(C#) Web Api通過文件流下載文件的實例
這篇文章主要介紹了ASP.NET(C#) Web Api通過文件流下載文件的方法,提供源碼下載,需要的朋友可以參考下。2016-06-06DotNetCore深入了解之HttpClientFactory類詳解
這篇文章主要給大家介紹了關于DotNetCore深入了解之HttpClientFactory類的相關資料,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面來一起學習學習吧2019-03-03