使用Hangfire+.NET?6實(shí)現(xiàn)定時(shí)任務(wù)管理(推薦)
在.NET開(kāi)發(fā)生態(tài)中,我們以前開(kāi)發(fā)定時(shí)任務(wù)都是用的Quartz.NET完成的。在這篇文章里,記錄一下另一個(gè)很強(qiáng)大的定時(shí)任務(wù)框架的使用方法:Hangfire。兩個(gè)框架各自都有特色和優(yōu)勢(shì),可以根據(jù)參考文章里張隊(duì)的那篇文章對(duì)兩個(gè)框架的對(duì)比來(lái)進(jìn)行選擇。
引入Nuget包和配置
引入Hangfire相關(guān)的Nuget包:
Hangfire.AspNetCore Hangfire.MemoryStorage Hangfire.Dashboard.Basic.Authentication
并對(duì)Hangfire進(jìn)行服務(wù)配置:
builder.Services.AddHangfire(c => { // 使用內(nèi)存數(shù)據(jù)庫(kù)演示,在實(shí)際使用中,會(huì)配置對(duì)應(yīng)數(shù)據(jù)庫(kù)連接,要保證該數(shù)據(jù)庫(kù)要存在 c.UseMemoryStorage(); }); // Hangfire全局配置 GlobalConfiguration.Configuration .UseColouredConsoleLogProvider() .UseSerilogLogProvider() .UseMemoryStorage() .WithJobExpirationTimeout(TimeSpan.FromDays(7)); // Hangfire服務(wù)器配置 builder.Services.AddHangfireServer(options => { options.HeartbeatInterval = TimeSpan.FromSeconds(10); });
使用Hangfire中間件:
// 添加Hangfire Dashboard app.UseHangfireDashboard(); app.UseAuthorization(); app.MapControllers(); // 配置Hangfire Dashboard路徑和權(quán)限控制 app.MapHangfireDashboard("/hangfire", new DashboardOptions { AppPath = null, DashboardTitle = "Hangfire Dashboard Test", Authorization = new [] { new HangfireCustomBasicAuthenticationFilter { User = app.Configuration.GetSection("HangfireCredentials:UserName").Value, Pass = app.Configuration.GetSection("HangfireCredentials:Password").Value } } });
對(duì)應(yīng)的配置如下:
appsettings.json
"HangfireCredentials": { "UserName": "admin", "Password": "admin@123" }
編寫Job
Hangfire免費(fèi)版本支持以下類型的定時(shí)任務(wù):
- 周期性定時(shí)任務(wù):
Recurring Job
- 執(zhí)行單次任務(wù):
Fire and Forget
- 連續(xù)順序執(zhí)行任務(wù):
Continouus Job
- 定時(shí)單次任務(wù):
Schedule Job
Fire and Forget
這種類型的任務(wù)一般是在應(yīng)用程序啟動(dòng)的時(shí)候執(zhí)行一次結(jié)束后不再重復(fù)執(zhí)行,最簡(jiǎn)單的配置方法是這樣的:
using Hangfire; BackgroundJob.Enqueue(() => Console.WriteLine("Hello world from Hangfire with Fire and Forget job!"));
Continuous Job
這種類型的任務(wù)一般是進(jìn)行順序型的任務(wù)執(zhí)行調(diào)度,比如先完成任務(wù)A,結(jié)束后執(zhí)行任務(wù)B:
var jobId = BackgroundJob.Enqueue(() => Console.WriteLine("Hello world from Hangfire with Fire and Forget job!")); // Continuous Job, 通過(guò)指定上一個(gè)任務(wù)的Id來(lái)跟在上一個(gè)任務(wù)后執(zhí)行 BackgroundJob.ContinueJobWith(jobId, () => Console.WriteLine("Hello world from Hangfire using continuous job!"));
Scehdule Job
這種類型的任務(wù)是用于在未來(lái)某個(gè)特定的時(shí)間點(diǎn)被激活運(yùn)行的任務(wù),也被叫做Delayed Job
:
var jobId = BackgroundJob.Enqueue(() => Console.WriteLine("Hello world from Hangfire with Fire and Forget job!")); // Continuous Job, 通過(guò)指定上一個(gè)任務(wù)的Id來(lái)跟在上一個(gè)任務(wù)后執(zhí)行 BackgroundJob.ContinueJobWith(jobId, () => Console.WriteLine("Hello world from Hangfire using continuous job!"));
Recurring Job
這種類型的任務(wù)應(yīng)該是我們最常使用的類型,使用Cron表達(dá)式來(lái)設(shè)定一個(gè)執(zhí)行周期時(shí)間,每到設(shè)定時(shí)間就被激活執(zhí)行一次。對(duì)于這種相對(duì)常見(jiàn)的場(chǎng)景,我們可以演示一下使用單獨(dú)的類來(lái)封裝任務(wù)邏輯:
IJob.cs
namespace HelloHangfire; public interface IJob { public Task<bool> RunJob(); }
Job.cs
using Serilog; namespace HelloHangfire; public class Job : IJob { public async Task<bool> RunJob() { Log.Information($"start time: {DateTime.Now}"); // 模擬任務(wù)執(zhí)行 await Task.Delay(1000); Log.Information("Hello world from Hangfire in Recurring mode!"); Log.Information($"stop time: {DateTime.Now}"); return true; } }
在Program.cs
中使用Cron來(lái)注冊(cè)任務(wù):
builder.Services.AddTransient<IJob, Job>(); // ... var app = builder.Build(); // ... var JobService = app.Services.GetRequiredService<IJob>(); // Recurring job RecurringJob.AddOrUpdate("Run every minute", () => JobService.RunJob(), "* * * * *");
Run
控制臺(tái)輸出:
info: Hangfire.BackgroundJobServer[0]
Starting Hangfire Server using job storage: 'Hangfire.MemoryStorage.MemoryStorage'
info: Hangfire.BackgroundJobServer[0]
Using the following options for Hangfire Server:
Worker count: 20
Listening queues: 'default'
Shutdown timeout: 00:00:15
Schedule polling interval: 00:00:15
info: Hangfire.Server.BackgroundServerProcess[0]
Server b8d0de54-caee-4c5e-86f5-e79a47fad51f successfully announced in 11.1236 ms
info: Hangfire.Server.BackgroundServerProcess[0]
Server b8d0de54-caee-4c5e-86f5-e79a47fad51f is starting the registered dispatchers: ServerWatchdog, ServerJobCancellationWatcher, ExpirationManager, CountersAggregator, Worker, DelayedJobScheduler, RecurringJobScheduler...
info: Hangfire.Server.BackgroundServerProcess[0]
Server b8d0de54-caee-4c5e-86f5-e79a47fad51f all the dispatchers started
Hello world from Hangfire with Fire and Forget job!
Hello world from Hangfire using continuous job!
info: Microsoft.Hosting.Lifetime[14]
Now listening on: https://localhost:7295
info: Microsoft.Hosting.Lifetime[14]
Now listening on: http://localhost:5121
info: Microsoft.Hosting.Lifetime[0]
Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
Content root path: /Users/yu.li1/Projects/asinta/Net6Demo/HelloHangfire/HelloHangfire/
[16:56:14 INF] start time: 02/25/2022 16:56:14
[16:57:14 INF] start time: 02/25/2022 16:57:14
[16:57:34 INF] Hello world from Hangfire in Recurring mode!
[16:57:34 INF] stop time: 02/25/2022 16:57:34
通過(guò)配置的dashboard來(lái)查看所有的job運(yùn)行的狀況:
長(zhǎng)時(shí)間運(yùn)行任務(wù)的并發(fā)控制???
從上面的控制臺(tái)日志可以看出來(lái),使用Hangfire進(jìn)行周期性任務(wù)觸發(fā)的時(shí)候,如果執(zhí)行時(shí)間大于執(zhí)行的間隔周期,會(huì)產(chǎn)生任務(wù)的并發(fā)。如果我們不希望任務(wù)并發(fā),可以在配置并發(fā)數(shù)量的時(shí)候配置成1,或者在任務(wù)內(nèi)部去判斷當(dāng)前是否有相同的任務(wù)正在執(zhí)行,如果有則停止繼續(xù)執(zhí)行。但是這樣也無(wú)法避免由于執(zhí)行時(shí)間過(guò)長(zhǎng)導(dǎo)致的周期間隔不起作用的問(wèn)題,比如我們希望不管在任務(wù)執(zhí)行多久的情況下,前后兩次激活都有一個(gè)固定的間隔時(shí)間,這樣的實(shí)現(xiàn)方法我還沒(méi)有試出來(lái)。有知道怎么做的小伙伴麻煩說(shuō)一下經(jīng)驗(yàn)。
Job Filter記錄Job的全部事件
有的時(shí)候我們希望記錄Job運(yùn)行生命周期內(nèi)的所有事件,可以參考官方文檔:Using job filters來(lái)實(shí)現(xiàn)該需求。
參考文章
關(guān)于Hangfire更加詳細(xì)和生產(chǎn)環(huán)境的使用,張隊(duì)寫過(guò)一篇文章:Hangfire項(xiàng)目實(shí)踐分享。
到此這篇關(guān)于使用Hangfire+.NET 6實(shí)現(xiàn)定時(shí)任務(wù)管理的文章就介紹到這了,更多相關(guān).NET 定時(shí)任務(wù)管理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
.net6?使用Senparc開(kāi)發(fā)小程序配置過(guò)程
這篇文章主要介紹了.net6?使用Senparc開(kāi)發(fā)小程序配置,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-07-07asp.net 頁(yè)面間傳值與跳轉(zhuǎn)的區(qū)別
通過(guò)Server.Transfer("b.aspx") 與Response.Redirect("b.aspx")的區(qū)別2010-04-04asp.net DataTable相關(guān)操作集錦(篩選,取前N條數(shù)據(jù),去重復(fù)行,獲取指定列數(shù)據(jù)等)
這篇文章主要介紹了asp.net DataTable相關(guān)操作,包括篩選,取前N條數(shù)據(jù),去重復(fù)行,獲取指定列數(shù)據(jù)等.基本涵蓋了DataTable的常見(jiàn)操作技巧,需要的朋友可以參考下2016-06-06在Global.asax文件里實(shí)現(xiàn)通用防SQL注入漏洞程序(適應(yīng)于post/get請(qǐng)求)
可使用Global.asax中的Application_BeginRequest(object sender, EventArgs e)事件來(lái)實(shí)現(xiàn)表單或者URL提交數(shù)據(jù)的獲取,獲取后傳給SQLInjectionHelper類ValidUrlData方法來(lái)完成檢查2013-01-01ASP.net(C#)從其他網(wǎng)站抓取內(nèi)容并截取有用信息的實(shí)現(xiàn)代碼
ASP.net(C#)從其他網(wǎng)站抓取內(nèi)容并截取有用信息的實(shí)現(xiàn)代碼,需要的朋友可以參考下。2011-09-09理解ASP.NET Core 依賴注入(Dependency Injection)
把有依賴關(guān)系的類放到容器中,解析出這些類的實(shí)例,就是依賴注入。目的是實(shí)現(xiàn)類的解耦。本文主要介紹了ASP.NET Core 依賴注入(Dependency Injection),需要了解具體內(nèi)容的可以仔細(xì)閱讀這篇文章,希望對(duì)你有所幫助2021-09-09asp.net XMLHttpRequest實(shí)現(xiàn)用戶注冊(cè)前的驗(yàn)證
用戶注冊(cè)前的驗(yàn)證,提高用戶體驗(yàn)。2009-10-10利用委托把用戶控件的值顯示于網(wǎng)頁(yè)案例應(yīng)用
用戶控件(UserControl)是集成一個(gè)功能,需要處理好的數(shù)據(jù),然后存數(shù)據(jù)庫(kù)中并顯示于網(wǎng)頁(yè)上,讓用戶能檢測(cè)到處理的數(shù)據(jù)情況,接下來(lái)將介紹利用委托把用戶控件的值顯示于網(wǎng)頁(yè)上,感興趣的朋友可以了解下2013-02-02