基于 abp vNext 和 .NET Core 開發博客項目 - 集成Hangfire實現定時任務處理
轉載于：https://github.com/Meowv/Blog
接下來，將完成一個任務調度中心，關于定時任務有多種處理方式，如果你的需求比較簡單，比如就是單純的過多少時間循環執行某個操作，可以直接使用.net core中內置的實現方式，新建一個類繼承BackgroundService，實現ExecuteAsync()既可。

看一個例子，我們每過一秒輸出一句HelloWorld，并寫入日志中。

在.BackgroundJobs中新建一個Jobs文件夾，添加HelloWorldJob.cs，并且繼承自BackgroundService。

//HelloWorldJob.cs
using log4net;
using Microsoft.Extensions.Hosting;
using System;
using System.Threading;
using System.Threading.Tasks;

namespace Meowv.Blog.BackgroundJobs.Jobs
{
public class HelloWorldJob : BackgroundService
{
private readonly ILog _log;

public HelloWorldJob(){_log = LogManager.GetLogger(typeof(HelloWorldJob));}protected override async Task ExecuteAsync(CancellationToken stoppingToken){while (!stoppingToken.IsCancellationRequested){var msg = $"CurrentTime:{ DateTime.Now}, Hello World!";Console.WriteLine(msg);_log.Info(msg);await Task.Delay(1000, stoppingToken);}} }

}
然后在.HttpApi.Hosting層模塊類中的ConfigureServices()注入context.Services.AddTransient<IHostedService, HelloWorldJob>();使用，運行一下看看效果。

圖片

可以看到已經成功輸出了，你可以在ExecuteAsync()中做你的事件處理邏輯。這應該是最簡單后臺定時任務處理了，比較單一。

在abp框架中，官方給我們提供了許多后臺工作的集成方式，有興趣的可以自行研究一下，文檔地址：https://docs.abp.io/zh-Hans/abp/latest/Background-Jobs

在本項目中，我將使用 Hangfire 來完成定時任務處理，為什么選擇它呢？因為簡單，開箱即用。下面進入正題，可以先將 HelloWorldJob 停掉。

在.BackgroundJobs中添加nuget包：Volo.Abp.BackgroundJobs.HangFire、Hangfire.MySql.Core、Hangfire.Dashboard.BasicAuthorization、Volo.Abp.AspNetCore，然后添加項目引用：.Domain。

在根目錄新建模塊類：MeowvBlogBackgroundJobsModule.cs，繼承AbpModule，依賴AbpBackgroundJobsHangfireModule。

//MeowvBlogBackgroundJobsModule.cs
using Hangfire;
using Hangfire.MySql.Core;
using Meowv.Blog.Domain.Configurations;
using Meowv.Blog.Domain.Shared;
using Volo.Abp;
using Volo.Abp.BackgroundJobs.Hangfire;
using Volo.Abp.Modularity;

namespace Meowv.Blog.BackgroundJobs
{
[DependsOn(typeof(AbpBackgroundJobsHangfireModule))]
public class MeowvBlogBackgroundJobsModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.Services.AddHangfire(config =>
{
config.UseStorage(
new MySqlStorage(AppSettings.ConnectionStrings,
new MySqlStorageOptions
{
TablePrefix = MeowvBlogConsts.DbTablePrefix + “hangfire”
}));
});
}

public override void OnApplicationInitialization(ApplicationInitializationContext context){var app = context.GetApplicationBuilder();app.UseHangfireServer();app.UseHangfireDashboard();} }

}
在ConfigureServices()中添加配置，因為之前選用了MySQL，所以這里引用了Hangfire.MySql.Core這個包，相對于的其它數據庫可以在nuget上尋找。

在new MySqlStorage()中配置連接字符串，new MySqlStorageOptions()中配置表前綴，Hangfire會在第一次運行時，自動為我們創建表。

然后在OnApplicationInitialization()中進行使用，app.UseHangfireServer()必須調用，如果你不需要界面顯示可以不用app.UseHangfireDashboard();

最后不要忘記，在.HttpApi.Hosting層模塊類中依賴定時任務模塊MeowvBlogBackgroundJobsModule。

現在運行一下項目，打開地址：…/hangfire 看看。

圖片

數據庫默認已經為我們創建了hangfire所需的表。

圖片

有一個地方要注意，就是在連接字符串中需要開啟用戶變量，修改一下appsettings.json中的連接字符串，在末尾添加：Allow User Variables=True。

同時在app.UseHangfireDashboard()中，還支持很多配置項，現在我們這個定時任務是公開的，如果我們不想要外人訪問，可以開啟BasicAuth。

現在配置文件中配置Hangfire的登錄賬號和密碼。

…
“Hangfire”: {
“Login”: “meowv”,
“Password”: “123456”
}
…
…
///
/// Hangfire
///
public static class Hangfire
{
public static string Login => _config[“Hangfire:Login”];

public static string Password => _config["Hangfire:Password"];

}
…
開啟方式也很簡單，之前已經引用了Hangfire.Dashboard.BasicAuthorization這個包，直接看代碼。

app.UseHangfireDashboard(options: new DashboardOptions
{
Authorization = new[]
{
new BasicAuthAuthorizationFilter(new BasicAuthAuthorizationFilterOptions
{
RequireSsl = false,
SslRedirect = false,
LoginCaseSensitive = true,
Users = new []
{
new BasicAuthAuthorizationUser
{
Login = AppSettings.Hangfire.Login,
PasswordClear = AppSettings.Hangfire.Password
}
}
})
},
DashboardTitle = “任務調度中心”
});
app.UseHangfireDashboard()中可以自定義訪問路徑，我們這里沒有傳，就是用默認值。自定義界面的標題Title等等。更多參數可以自己看DashboardOptions，結合情況來使用，編譯運行看看效果。

圖片

現在就需要輸入我們配置的賬號密碼才可以進入Hangfire界面了。

這樣我們就集成好了Hangfire，并且還有了一個可視化的界面，接下來我們同樣實現一個簡單的定時任務看看效果。

在Jobs文件夾添加一個接口：IBackgroundJob，讓他繼承ITransientDependency，實現依賴注入，同時定義一個方法ExecuteAsync()。

//IBackgroundJob.cs
using System.Threading.Tasks;
using Volo.Abp.DependencyInjection;

namespace Meowv.Blog.BackgroundJobs.Jobs
{
public interface IBackgroundJob : ITransientDependency
{
///
/// 執行任務
///
///
Task ExecuteAsync();
}
}
在Jobs文件夾新建文件夾Hangfire，添加HangfireTestJob.cs，繼承IBackgroundJob實現ExecuteAsync()方法。

//HangfireTestJob.cs
using System;
using System.Threading.Tasks;

namespace Meowv.Blog.BackgroundJobs.Jobs.Hangfire
{
public class HangfireTestJob : IBackgroundJob
{
public async Task ExecuteAsync()
{
Console.WriteLine(“定時任務測試”);

await Task.CompletedTask;} }

}
這樣就完成了定時任務的邏輯，我們怎么來調用呢？新建一個擴展方法MeowvBlogBackgroundJobsExtensions.cs。

//MeowvBlogBackgroundJobsExtensions.cs
using Hangfire;
using Meowv.Blog.BackgroundJobs.Jobs.Hangfire;
using Microsoft.Extensions.DependencyInjection;
using System;

namespace Meowv.Blog.BackgroundJobs
{
public static class MeowvBlogBackgroundJobsExtensions
{
public static void UseHangfireTest(this IServiceProvider service)
{
var job = service.GetService();

RecurringJob.AddOrUpdate("定時任務測試", () => job.ExecuteAsync(), CronType.Minute());} }

}
這里使用IServiceProvider解析服務，獲取到我們的實列，所以我們可以在模塊類中的OnApplicationInitialization(…)中直接調用此擴展方法。

RecurringJob.AddOrUpdate()是定期作業按指定的計劃觸發任務，同時還有Enqueue、Schedule、ContinueJobWith等等，可以看一下Hangfire官方文檔：https://docs.hangfire.io/en/latest/

CronType是自定義的一個靜態類，他幫我們自動生成了Cron表達式，這里表示一分鐘執行一次，關于不懂Cron的同學，可以去自學一下，也許看看下面代碼就懂了，也有許多Cron表達式在線生成的工具。

Example of job definition:

.---------------- minute (0 - 59)

| .------------- hour (0 - 23)

| | .---------- day of month (1 - 31)

| | | .------- month (1 - 12) OR jan,feb,mar,apr …

| | | | .---- day of week (0 - 6) (Sunday=0 or 7) OR sun,mon,tue,wed,thu,fri,sat

| | | | |

*/30 * * * * /bin/python /qix/spider/spider.py #每30分鐘執行一次
直接在根目錄添加MeowvBlogCronType.cs。

//MeowvBlogCronType.cs
using Hangfire;
using System;

namespace Meowv.Blog.BackgroundJobs
{
///
/// Cron類型
///
public static class CronType
{
///
/// 周期性為分鐘的任務
///
/// 執行周期的間隔，默認為每分鐘一次
///
public static string Minute(int interval = 1)
{
return “1 0/” + interval.ToString() + " * * * ? ";
}

/// <summary>/// 周期性為小時的任務/// </summary>/// <param name="minute">第幾分鐘開始，默認為第一分鐘</param>/// <param name="interval">執行周期的間隔，默認為每小時一次</param>/// <returns></returns>public static string Hour(int minute = 1, int interval = 1){return "1 " + minute + " 0/" + interval.ToString() + " * * ? ";}/// <summary>/// 周期性為天的任務/// </summary>/// <param name="hour">第幾小時開始，默認從1點開始</param>/// <param name="minute">第幾分鐘開始，默認從第1分鐘開始</param>/// <param name="interval">執行周期的間隔，默認為每天一次</param>/// <returns></returns>public static string Day(int hour = 1, int minute = 1, int interval = 1){return "1 " + minute.ToString() + " " + hour.ToString() + " 1/" + interval.ToString() + " * ? ";}/// <summary>/// 周期性為周的任務/// </summary>/// <param name="dayOfWeek">星期幾開始，默認從星期一點開始</param>/// <param name="hour">第幾小時開始，默認從1點開始</param>/// <param name="minute">第幾分鐘開始，默認從第1分鐘開始</param>/// <returns></returns>public static string Week(DayOfWeek dayOfWeek = DayOfWeek.Monday, int hour = 1, int minute = 1){return Cron.Weekly(dayOfWeek, hour, minute);}/// <summary>/// 周期性為月的任務/// </summary>/// <param name="day">幾號開始，默認從一號開始</param>/// <param name="hour">第幾小時開始，默認從1點開始</param>/// <param name="minute">第幾分鐘開始，默認從第1分鐘開始</param>/// <returns></returns>public static string Month(int day = 1, int hour = 1, int minute = 1){return Cron.Monthly(day, hour, minute);}/// <summary>/// 周期性為年的任務/// </summary>/// <param name="month">幾月開始，默認從一月開始</param>/// <param name="day">幾號開始，默認從一號開始</param>/// <param name="hour">第幾小時開始，默認從1點開始</param>/// <param name="minute">第幾分鐘開始，默認從第1分鐘開始</param>/// <returns></returns>public static string Year(int month = 1, int day = 1, int hour = 1, int minute = 1){return Cron.Yearly(month, day, hour, minute);} }

}
接著就可以調用定時任務了。

//MeowvBlogBackgroundJobsModule.cs
…
public override void OnApplicationInitialization(ApplicationInitializationContext context)
{
var app = context.GetApplicationBuilder();
…
var service = context.ServiceProvider;

service.UseHangfireTest();

}
…
通過context.ServiceProvider可以獲取到IServiceProvider，然后直接調用擴展方法，是不是超級簡單，現在編譯運行項目看效果。

圖片

關于任務是否真的運行成功，我們可以從輸出看出。

圖片

完美，本篇完成了Hangfire的集成，并實現了一個定時任務計劃，有沒有發現很簡單，你學會了嗎？😁😁😁

開源地址：https://github.com/Meowv/Blog/tree/blog_tutorial

總結

以上是生活随笔為你收集整理的基于 abp vNext 和 .NET Core 开发博客项目 - 集成Hangfire实现定时任务处理的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。