.Net 6使用Hangfire（一）

本文仅描述.net 6环境下如何安装和使用Hangfire进行后台作业任务调度。

1、首先安装需要的Nuget包：

Hangfire.AspNetCore、

如果有持久化需求的话，还需要安装其它包，hangfire支持存储在SQLserver、redis、memory中，

本文演示使用的是SQLserver数据库，需要先在数据库中创建名为HangfireTest的数据库，然后配置连接字符串

 

2、注入Hangfire相关的服务

 public static IServiceCollection ConfigHangfire(this IServiceCollection services, IConfiguration configuration)
    {
      //注册Hangfir配置
      services.AddHangfire(config =>
      {
        config.UseSerilogLogProvider();   //设置使用serilog来记录相关日志 可以更换其他
        config.SetDataCompatibilityLevel(CompatibilityLevel.Version_180);
        config.UseSimpleAssemblyNameTypeSerializer();
        config.UseRecommendedSerializerSettings();
        config.UseFilter(new LogHangfireFailureAttribute());  //使用过滤器，当失败重试次数达到最大时记录日志
        config.UseFilter(new LogHangfirePerformAttribute());  //使用过滤器，当作业执行时触发
        //config.UseMemoryStorage();  //使用本地内存来存储相关数据，也可更换redis和SQL
        config.UseSqlServerStorage(configuration.GetConnectionString("HangfireConnection"))
        .WithJobExpirationTimeout(TimeSpan.FromDays(1));  //设置使用SQL数据库来存储数据，并且设置过期时间（默认最少为24小时） 必须跟在UseXXXStorage后使用
      });
      // Add the processing server as IHostedService
      services.AddHangfireServer();
      //注册自定义的后台作业
      services.AddTransient<IHangfireJob, HelloHangfireJob>();

      return services;
    }

 public static IApplicationBuilder UseHangfire(this IApplicationBuilder app, IWebHostEnvironment environment)
    {
      //判断是否开发环境
      if (environment.IsDevelopment())
      {
        //启用hangfire仪表盘管理功能
        app.UseHangfireDashboard("/hangfire", new DashboardOptions
        {
          DashboardTitle = "Hangfire Dashboard Manage", //页面标题
          AppPath = "http://localhost:5249/swagger",
          //IsReadOnlyFunc = context => true  //设置控制面板仅用于预览
        });
      }
      //var jobId = BackgroundJob.Enqueue(() => Debug.WriteLine("fire-and-forgot job start"));
      //BackgroundJob.ContinueJobWith(jobId, () => Debug.WriteLine("continue job start"));

      //注册后台启动的作业
      using (var scope = app.ApplicationServices.CreateScope())
      {
        var helloHangfireJob = scope.ServiceProvider.GetRequiredService<IHangfireJob>();
        BackgroundJob.Schedule(() => helloHangfireJob.RunSendEmailJob(), TimeSpan.FromMinutes(1));
        RecurringJob.AddOrUpdate("closeUnPayOrder", () => helloHangfireJob.RunCloseUnpayOrder(), Cron.Minutely(), new RecurringJobOptions
        {
          //TimeZone = TimeZoneInfo.Local
        });
      }
      return app;
    }

        //注册HangFire相关服务
        builder.Services.ConfigHangfire(builder.Configuration);

        //启用hangfire中间件
        app.UseHangfire(app.Environment);

3、使用

  public interface IHangfireJob
  {
    public Task RunSendEmailJob();

    public Task RunCloseUnpayOrder();
  }

  public class HelloHangfireJob : IHangfireJob
  {
    private readonly IEmailHelper _emailHelper;

    public HelloHangfireJob(IEmailHelper emailHelper)
    {
      _emailHelper = emailHelper;
    }

    [LogHangfireFailure]
    public Task RunCloseUnpayOrder()
    {
      //从数据库获取未支付已过期的订单数据
      Console.WriteLine($"{DateTime.Now} 处理未支付已过期的订单");

      return Task.CompletedTask;
    }

    [LogHangfireFailure]
    [LogHangfirePerform]
    public async Task RunSendEmailJob()
    {
      await _emailHelper.Send(new EmailData("96@qq.com", "zjj", "templateCode", new List<string> { "zjj@gmail.com" }, "测试发送邮件", "测试测试", EmailType.QQ));
    }
  }

    [HttpGet]
    public ApiResult TestHangfire()
    {
      var jobId = BackgroundJob.Enqueue(() => Debug.WriteLine("fire-and-forgot job start"));
      BackgroundJob.ContinueJobWith(jobId, () => Debug.WriteLine("continue job start"));
      BackgroundJob.Schedule(() => Debug.WriteLine("delay job start"), TimeSpan.FromMinutes(1));
      return new Success();
    }

 运行效果演示：

浏览器中查看仪表盘页面：

 查看数据库表，可以看到有数据了

 

引用资料：

Configuration — Hangfire Documentation