一.简述
Hangfire作为一款高人气且容易上手的分布式后台执行服务,支持多种数据库。在.net core的环境中,由Core自带的DI管理着生命周期,免去了在NF4.X环境中配置always running的麻烦,真正做到开箱即用。
二.安装
Hangfie官方支持是MsSql和redis,除此之外,可供选择的还有PostgreSql和Mongo。
在应用入口项目需要引用Hangfire.AspNetCore和特定持久库,比如使用了MsSql数据库的Hangfire.SqlServer。
而在其他项目(比如bll层的项目),只需引用基础的Hangfire.Core就可以了。
三.Startup配置
1.注入Hnagfire服务
services.AddHangfire(x => x.UseSqlServerStorage("<connection string>"));
2.可选配置
启动Hangfire服务和对应的web面板如下:
app.UseHangfireServer();//启动Hangfire服务
app.UseHangfireDashboard();//启动hangfire面板
细心的观众可能会发现,这两个方法都有可选参数,可以提供更多的配置。
2.1 配置任务属性
var jobOptions = new BackgroundJobServerOptions
{
Queues = new[] { "test","default" },//队列名称,只能为小写
WorkerCount = Environment.ProcessorCount * 5, //并发任务数
ServerName="hangfire1",//服务器名称
};
app.UseHangfireServer(jobOptions);
Queues 要处理的队列列表
对于有多个服务器同时连接到数据库,Hangfire会认为他们是分布式中的一份子。现实中不同服务器往往存在着差异,这个时候就需要合理配置服务器(应用)的处理队列,举两个例子:
1.对于服务器性能差异的处理,有100个A任务和50个B任务需要处理,假设A服务器的性能是B服务器的两倍,如果不配置队列,那么会平分任务给两个服务器。如果我们只让B服务器处理B任务,而A服务器同时处理两种任务,这样B就能减少一些压力。
2.对于服务器能力差异的处理,假设A服务器能处理A和B两种任务,B服务器只能处理B任务(没有处理A任务的方法或对象),如果不配置队列,默认会让B也执行A任务,从而产生错误。反面一想,如果A服务器和B服务器都有共同的接口,B服务器不实现接口的方法,发起一个专属于A服务器队列的任务,而A服务器通过注入实现接口的方法,可以达到传递任务的效果。
WorkerCount 并发任务数,超出并发数将等待之前的任务完成
默认的并发任务数是线程(cpu)的5倍,如果IO密集型任务多而CPU密集型的任务少,可以考虑调高并发任务数。
以上是我用到的,当然还有其他配置参数等着你去开发。
2.2.配置访问权限
在实际生产中,我们可能不希望任何人都可以访问面板,或暂停执行某些任务,这时就需要重写面板的权限了。默认情况下,只有本地访问权限才能使用Hangfire仪表板。所以需要重写控制面板,以便远程访问。
var options = new DashboardOptions
{
Authorization = new[] { new HangfireAuthorizationFilter() }
};
app.UseHangfireDashboard("/hangfire", options);
public class HangfireAuthorizationFilter : IDashboardAuthorizationFilter
{
//这里需要配置权限规则
public bool Authorize(DashboardContext context)
{
return true;
}
}