建站
咨詢
售后
建站咨詢
新聞中心
在.NET開發(fā)生態(tài)中，我們以前開發(fā)定時(shí)任務(wù)都是用的Quartz.NET完成的。在這篇文章里，記錄一下另一個(gè)很強(qiáng)大的定時(shí)任務(wù)框架的使用方法：Hangfire。兩個(gè)框架各自都有特色和優(yōu)勢(shì)，可以根據(jù)參考文章里張隊(duì)的那篇文章對(duì)兩個(gè)框架的對(duì)比來進(jìn)行選擇。
創(chuàng)新互聯(lián)專注為客戶提供全方位的互聯(lián)網(wǎng)綜合服務(wù)，包含不限于成都網(wǎng)站設(shè)計(jì)、網(wǎng)站制作、南充網(wǎng)絡(luò)推廣、成都微信小程序、南充網(wǎng)絡(luò)營銷、南充企業(yè)策劃、南充品牌公關(guān)、搜索引擎seo、人物專訪、企業(yè)宣傳片、企業(yè)代運(yùn)營等，從售前售中售后，我們都將竭誠為您服務(wù)，您的肯定，是我們最大的嘉獎(jiǎng)；創(chuàng)新互聯(lián)為所有大學(xué)生創(chuàng)業(yè)者提供南充建站搭建服務(wù)，24小時(shí)服務(wù)熱線：028-86922220，官方網(wǎng)址：www.cdcxhl.com
引入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ù)庫演示，在實(shí)際使用中，會(huì)配置對(duì)應(yīng)數(shù)據(jù)庫連接，要保證該數(shù)據(jù)庫要存在
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í)行，最簡單的配置方法是這樣的：
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, 通過指定上一個(gè)任務(wù)的Id來跟在上一個(gè)任務(wù)后執(zhí)行
BackgroundJob.ContinueJobWith(jobId, () => Console.WriteLine("Hello world from Hangfire using continuous job!"));
Scehdule Job
這種類型的任務(wù)是用于在未來某個(gè)特定的時(shí)間點(diǎn)被激活運(yùn)行的任務(wù)，也被叫做Delayed Job：
// 指定5天后執(zhí)行
BackgroundJob.Schedule(() => Console.WriteLine("Hello world from Hangfire using scheduled job!"), TimeSpan.FromDays(5));
Recurring Job
這種類型的任務(wù)應(yīng)該是我們最常使用的類型，使用Cron表達(dá)式來設(shè)定一個(gè)執(zhí)行周期時(shí)間，每到設(shè)定時(shí)間就被激活執(zhí)行一次。對(duì)于這種相對(duì)常見的場景，我們可以演示一下使用單獨(dú)的類來封裝任務(wù)邏輯：
IJob.cs
namespace HelloHangfire;
public interface IJob
{
public Task RunJob();
}
Job.cs
using Serilog;
namespace HelloHangfire;
public class Job : IJob
{
public async Task 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來注冊(cè)任務(wù)：
builder.Services.AddTransient();
// ...
var app = builder.Build();
// ...
var JobService = app.Services.GetRequiredService();
// 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
通過配置的dashboard來查看所有的job運(yùn)行的狀況：
長時(shí)間運(yùn)行任務(wù)的并發(fā)控制？？？
從上面的控制臺(tá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í)行。但是這樣也無法避免由于執(zhí)行時(shí)間過長導(dǎo)致的周期間隔不起作用的問題，比如我們希望不管在任務(wù)執(zhí)行多久的情況下，前后兩次激活都有一個(gè)固定的間隔時(shí)間，這樣的實(shí)現(xiàn)方法我還沒有試出來。有知道怎么做的小伙伴麻煩說一下經(jīng)驗(yàn)。
Job Filter記錄Job的全部事件
有的時(shí)候我們希望記錄Job運(yùn)行生命周期內(nèi)的所有事件，可以參考官方文檔：Using job filters來實(shí)現(xiàn)該需求。
參考文章
關(guān)于Hangfire更加詳細(xì)和生產(chǎn)環(huán)境的使用，張隊(duì)寫過一篇文章：Hangfire項(xiàng)目實(shí)踐分享。
當(dāng)前文章：【.NET生態(tài)系列】使用Hangfire+.NET 6實(shí)現(xiàn)定時(shí)任務(wù)管理
鏈接地址：http://fisionsoft.com.cn/article/dsoidop.html
