基于 abp vNext 和 .NET Core 开发博客项目 - 集成Hangfire实现定时任务处理 (2)

开启方式也很简单，之前已经引用了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 { /// <summary> /// 执行任务 /// </summary> /// <returns></returns> 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<HangfireTestJob>(); 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 { /// <summary> /// Cron类型 /// </summary> public static class CronType { /// <summary> /// 周期性为分钟的任务 /// </summary> /// <param>执行周期的间隔，默认为每分钟一次</param> /// <returns></returns> public static string Minute(int interval = 1) { return "1 0/" + interval.ToString() + " * * * ? "; } /// <summary> /// 周期性为小时的任务 /// </summary> /// <param>第几分钟开始，默认为第一分钟</param> /// <param>执行周期的间隔，默认为每小时一次</param> /// <returns></returns> public static string Hour(int minute = 1, int interval = 1) { return "1 " + minute + " 0/" + interval.ToString() + " * * ? "; } /// <summary> /// 周期性为天的任务 /// </summary> /// <param>第几小时开始，默认从1点开始</param> /// <param>第几分钟开始，默认从第1分钟开始</param> /// <param>执行周期的间隔，默认为每天一次</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>星期几开始，默认从星期一点开始</param> /// <param>第几小时开始，默认从1点开始</param> /// <param>第几分钟开始，默认从第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>几号开始，默认从一号开始</param> /// <param>第几小时开始，默认从1点开始</param> /// <param>第几分钟开始，默认从第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>几月开始，默认从一月开始</param> /// <param>几号开始，默认从一号开始</param> /// <param>第几小时开始，默认从1点开始</param> /// <param>第几分钟开始，默认从第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); } } }