Zzz.Hangfire 1.1.1

Zzz.Hangfire

说明

对Hangfire的循环任务进行封装，对实现了接口的类动态启动循环任务；

使用

启动

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllers();
...

//注入
builder.Services.AddZHangfire(option =>
{
    option.RoutePrefix = "/job";
    option.UserName = "admin";
    option.Password = "admin";
    option.Redis = "127.0.0.1:6379,password=,connectTimeout=3000,connectRetry=1,syncTimeout=10000,DefaultDatabase=3";
    option.Interval = 5;
});

var app = builder.Build();

...

//开启Hangfire
app.UseZHangfire();

app.UseAuthorization();

app.MapControllers();

app.Run();

创建任务

1. 实现IHangfireJob：创建一个取消订单的任务，实现接口。
2. 设置执行计划：加上[ExecutePlan("0/5 * * * * *")]。
3. 编码：实现任务功能。

/// <summary>
/// 取消过期订单
/// </summary>
[ExecutePlan("0/5 * * * * *")]
public class CancelExpiredOrderTask : IHangfireJob
{
    public Task Execute()
    {
        Console.WriteLine("取消过期订单"+DateTime.Now);

        return Task.CompletedTask;
    }
}

指定程序集

如果创建的任务文件不在当前程序集下，比如单独创建一个xxx.Task类库项目，只需要启动参数Assembile即可加载指定程序集的所有任务，否则加载当前程序集下的所有Task

builder.Services.AddZHangfire(option =>
{
    option.RoutePrefix = "/job";
    option.UserName = "admin";
    option.Password = "admin";
    option.Redis = "127.0.0.1:6379,password=,connectTimeout=3000,connectRetry=1,syncTimeout=10000,DefaultDatabase=3";
    option.Interval = 5;
    option.Assembile = "Zzz.ZHangfire.Lib";
});

分组

对任务进行分组，如果Task放在同一个类库项目下，同时又希望多个应用分别执行不同的任务，可以使用分组功能，在执行计划的特性上指定Group即可

builder.Services.AddZHangfire(option =>
{
    option.RoutePrefix = "/job";
    option.UserName = "admin";
    option.Password = "admin";
    option.Redis = "127.0.0.1:6379,password=,connectTimeout=3000,connectRetry=1,syncTimeout=10000,DefaultDatabase=3";
    option.Interval = 5;
    option.Assembile = "Zzz.ZHangfire.Lib";
    option.Group= "order";
});

给执行计划指定分组

/// <summary>
    /// 测试
    /// </summary>
    [ExecutePlan("0/5 * * * * *","order")]
    public class TestTask : IHangfireJob
    {
        public Task Execute()
        {
            Console.WriteLine("Test");

            return Task.CompletedTask;
        }
    }

注意：为防止意外执行任务，Task指定了分组，而配置里为指定分组，会按照配置的默认分组（Default）加载Task； 所以当Task的执行计划（ExecutePlanAttribute）中的分组与启动时的配置指定的分组（option.Group）不一致时，会按照配置上的分组加载