在上一篇[.net core下驗(yàn)證碼及二維碼登錄的實(shí)現(xiàn)]主要介紹了驗(yàn)證碼及二維碼的實(shí)現(xiàn),本篇主要介紹下在 .net core下如何實(shí)現(xiàn)定時(shí)任務(wù)
Hangfire介紹
Hangfire作為一款高人氣且容易上手的分布式后臺(tái)執(zhí)行服務(wù),支持多種數(shù)據(jù)庫。在 .net core的環(huán)境中,由Core自帶的DI管理著生命周期,免去了在NF4.X環(huán)境中配置always running的麻煩,真正做到開箱即用。
官方文檔點(diǎn)這里
相較于quartz.net相比,最大的優(yōu)點(diǎn)是有個(gè)自帶的監(jiān)控界面,比較方便。但有一點(diǎn),Hangfire只支持分鐘級(jí)別的定時(shí)任務(wù),如果想用秒級(jí)別的定時(shí)任務(wù),那可能Hangfire就不滿足你的需求了。
Hangfire基礎(chǔ)
基于隊(duì)列的任務(wù)處理(Fire-and-forget jobs)
基于隊(duì)列的任務(wù)處理是Hangfire中最常用的,客戶端使用BackgroundJob類的靜態(tài)方法Enqueue來調(diào)用,傳入指定的方法(或是匿名函數(shù)),Job Queue等參數(shù).(類似MQ)
var jobId = BackgroundJob.Enqueue(
() => Console.WriteLine("Fire-and-forget!"));
在任務(wù)被持久化到數(shù)據(jù)庫之后,Hangfire服務(wù)端立即從數(shù)據(jù)庫獲取相關(guān)任務(wù)并裝載到相應(yīng)的Job Queue下,在沒有異常的情況下僅處理一次,若發(fā)生異常,提供重試機(jī)制,異常及重試信息都會(huì)被記錄到數(shù)據(jù)庫中,通過Hangfire控制面板可以查看到這些信息。
延遲任務(wù)執(zhí)行(Delayed jobs)
延遲(計(jì)劃)任務(wù)跟隊(duì)列任務(wù)相似,客戶端調(diào)用時(shí)需要指定在一定時(shí)間間隔后調(diào)用:
var jobId = BackgroundJob.Schedule(
() => Console.WriteLine("Delayed!"),
TimeSpan.FromDays(7));
定時(shí)任務(wù)執(zhí)行(Recurring jobs)
定時(shí)(循環(huán))任務(wù)代表可以重復(fù)性執(zhí)行多次,支持CRON表達(dá)式:
RecurringJob.AddOrUpdate(
() => Console.WriteLine("Recurring!"),
Cron.Daily);
延續(xù)性任務(wù)執(zhí)行(Continuations)
延續(xù)性任務(wù)類似于.NET中的Task,可以在第一個(gè)任務(wù)執(zhí)行完之后緊接著再次執(zhí)行另外的任務(wù):
BackgroundJob.ContinueWith(
jobId,
() => Console.WriteLine("Continuation!"));
代碼實(shí)現(xiàn)
在我的項(xiàng)目中,實(shí)際只用到了定時(shí)任務(wù)(用于跑一些報(bào)表,郵件預(yù)警之類的需求),其他的業(yè)務(wù)場(chǎng)景感覺還是MQ更加適合。
下面來看看 .net core下具體的代碼實(shí)現(xiàn):
首先需要引用組件Hangfire.dll
及Hangfire.MySqlStorage.dll
,我使用的是Mysql。
在Startup.cs
中的ConfigureServices
中初始化數(shù)據(jù)庫:
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();
services.AddHangfire(x => x.UseStorage(new MySqlStorage(CONNECTION_STRING)));
}
在Configure
啟動(dòng)你的Hangfire服務(wù):
var jobOptions = new BackgroundJobServerOptions
{
//Queues = new[] { "test", "default" },//隊(duì)列名稱,只能為小寫
WorkerCount = Environment.ProcessorCount * 5, //并發(fā)任務(wù)數(shù)
ServerName = "hangfire1",//服務(wù)器名稱
};
app.UseHangfireServer(jobOptions);//啟動(dòng)Hangfire服務(wù)
同時(shí)你可以在Configure
下啟動(dòng)你的監(jiān)控應(yīng)用:
var options = new DashboardOptions
{
Authorization = new[] { new HangfireAuthorizationFilter() }
};
app.UseHangfireDashboard("/job_dashboard", options);
這樣啟動(dòng)后就可以看到你的監(jiān)控后臺(tái)了,輸入地址/job_dashboard
一些小改動(dòng)
由于項(xiàng)目可能經(jīng)常會(huì)重新部署,所以在項(xiàng)目啟動(dòng)時(shí)我會(huì)默認(rèn)重新啟動(dòng)定時(shí)任務(wù):
在Startup.cs
直接啟動(dòng)JobService.Register()
:
public static async void Register()
{
var jobKeys =await JobMonitorServices.GetAllJobKey();
if (!jobKeys.Any())
return;
//暫時(shí)只開一個(gè)queue,后期可擴(kuò)展
foreach(var keyModel in jobKeys)
{
var key = keyModel.Key.Split(':')[1];
RecurringJob.AddOrUpdate(key, () => JobMonitorServices.Execute(key), keyModel.Value);
}
}
至于GetAllJobKey
方法,是我直接從數(shù)據(jù)庫里取的:
public static async Task<List<HashModel>> GetAllJobKey()
{
string sql = $@"SELECT distinct `Key`,`Field`,`Value` FROM Hash WHERE Field='Cron';";
using (var conn = DatabaseManager.GetConnection(DatabaseManager.JOB_DBName))
{
await conn.OpenAsync();
return (await conn.QueryAsync<HashModel>(sql)).ToList() ;
}
}
這樣的話我可以同時(shí)暴露出對(duì)應(yīng)的新增修改job接口了,這樣方便我們直接通過服務(wù)去新增job,或者修改job的觸發(fā)時(shí)間:
/// <summary>
/// 新增or更新Job
/// </summary>
/// <param name="entity"></param>
/// <returns></returns>
[HttpPost]
public IActionResult Post([FromBody]JobKeyRequestModel entity)
{
var result = JobMonitorServices.CheckEnableJobKey(entity);
if (result.Result)
RecurringJob.AddOrUpdate(entity.Key, () => JobMonitorServices.Execute(entity.Key), entity.Cron,TimeZoneInfo.Local);
return AssertNotFound(result);
}
總結(jié)
Hangfire對(duì)于小項(xiàng)目來說用起來還是比較方便的,但對(duì)于精度要求和性能要求比較高的項(xiàng)目來說,還需要考量下。畢竟沒有壓測(cè)過,不知道性能怎么樣。