搭建基于Redis的Hangfire定时器
Hangfire的定时配置信息会自动生成在指定到数据库内,包括关系型数据库或非关系型数据库内。目前为止,它在Redis、Oracle上面,可以支持最短15秒的定时周期,其他数据库是分钟级别到。以下使用Hangfire+Redis来实现定时任务。
首先创建新的类库项目 Wsk.Core.Hangfire,然后在Wsk.Core.Package包项目下引用hangfire有关的组件,包括 Hangfire、Hangfire.Core、Hangfire.Redis、Hangfire.Redis.StaskExchange
在Wsk.Core.Hangfire项目下,新增Hangfire连接Redis的配置实体类:
在配置文件新增基于redis的hangfire的数据库连接:
我的配置源码:
"Hangfire": { "Config": { "ConnectionString": "127.0.0.1:6379,password=wesky123,connectTimeout=1000,connectRetry=1,syncTimeout=10000", "Db": 3 // 设置Hangfire使用的Redis的DB区 } }
新建HangfireHelper类,并且新增一个用于读取配置hangfire信息的方法,用来把读取的数据,存储在先前创建的实体类上:
在原先的实体类新增一个JobStorage类型的变量,用来存储hangfire连接redis的storage:
实体类源码:
public class HangfireConnectionOption { /// <summary> /// Redis连接字符串 /// </summary> public static string connectionString { get; set; } /// <summary> /// redis的DB区,默认0 /// </summary> public static int db { get; set; } = 0; public static JobStorage hangfireStorage; }
在HangfireHelper类里面,新增连接redis的方法,并且把连接的对象赋值到上面新增实体类的变量上:
Helper类源码:
public class HangfireHelper: IHangfireHelper { private readonly ILogger<HangfireHelper> _logger; public HangfireHelper(ILogger<HangfireHelper> logger) { _logger = logger; } public void ReadHangfireConfig() { try { HangfireConnectionOption.connectionString = AppHelper.ReadAppSettings(new string[] { "Hangfire", "Config", "ConnectionString" }); HangfireConnectionOption.db = Convert.ToInt32(AppHelper.ReadAppSettings(new string[] { "Hangfire", "Config", "Db" })); } catch (Exception ex) { _logger.LogError($"读取hangfire配置信息出错:{ex.Message}"); } } public void HangfireStorage() { // 默认使用Redis进行Hangfire定时调度任务 HangfireConnectionOption.hangfireStorage = new RedisStorage(HangfireConnectionOption.connectionString, new RedisStorageOptions { Db = HangfireConnectionOption.db, // REDIS 的 DB区 FetchTimeout = TimeSpan.FromMilliseconds(10), // 间隔多久读取一次,最低为15秒,所以此处设置低于15秒也是会默认为15秒 }); } }
然后开放该类对应的接口:
然后为了方便,我把hangfire类库项目全部通过autofac进行依赖注入注册:
然后,在Hosted启动项里面,新增Hangfire有关的配置信息的加载:
然后,在WskService里面,添加Hanfire的注册和连接:
在Wsk.Core.Hangfire类库项目下,新建一个过滤器MyHangfireFilter,用于允许远程访问Hangfire的可视化面板:
过滤器源码:
public class MyHangfireFilter : IDashboardAuthorizationFilter { public bool Authorize(DashboardContext context) { var httpContext = context.GetHttpContext(); return true; // 允许远程无限制访问 } }
最后,在Startup启动类的Configure方法的最下边,添加Hangfire的一些配置,以及加入上面的过滤器配置,用于可以跨服务器远程访问并且无需密码;并且设置可视化面板为可读,用于不提供手动触发,如果需要尝试手动触发的,可以自己改为false:
现在写一个定时任务做个试验,新建类HangfireJobs,并且提供一个无参方法FirstJob以及对应接口:
在Startup的cnfigure方法最下方(配置hangfire以后),添加刚刚到定时任务,并设置了一个cron表达式,用来设置定时一秒执行一次的效果:
configure方法有关代码:
app.UseHangfireServer(); app.UseHangfireDashboard("/hangfire", new DashboardOptions { IgnoreAntiforgeryToken = true, DashboardTitle = "Hangfire监控页面", Authorization = new[] { new MyHangfireFilter() }, IsReadOnlyFunc = (DashboardContext context) => true // 设置为只读 }); RecurringJob.AddOrUpdate<IHangfireJobs>("MyFirstJob", x => x.FirstJob(), "0/1 * * * * ? ");
启动以后到结果:
可以看到,即使设置的是1秒,但是实际上是15秒才执行一次。我们打开可视化面看查看:
输入启动或发布的程序所在的ip:port/配置的看板,可在如下代码进行更改:
可视化页面如下所示:
页面功能,还请各位大佬亲自去探索,我就不一一介绍了。
最后,咱们看下hangfire自动写入到redis的一些配置信息:
可以看到,redis连接选择的BD是3,hangfire也自动把一系列配置信息写到redis里面来了。而且程序上面的配置信息,我们也可以看见。