基于 ASP.NET Core 6 整合 Hangfire 实现项目案例

一、简介

Hangfire 是一个开源的 .NET 库，用于在 ASP.NET 应用程序中执行后台任务。它允许开发人员轻松地将长时间运行的任务、定时任务和其他后台处理从主线程中分离出来，以提高应用程序的响应速度和性能。

二、Hangfire 的原理

Hangfire 使用持久化存储（如 SQL Server、Redis 等）来管理和调度后台任务。任务被序列化并存储在数据库中，然后由一个或多个工作进程（workers）从队列中提取并执行。这种设计确保了任务的可靠性，即使在应用程序崩溃或重启的情况下，任务也不会丢失。

三、项目实践

        这是一个一个基于 SQL Server 作为持久化存储的 Hangfire 示例项目。这个项目将展示如何实现四种类型的任务：Fire-and-forget、Delayed、Recurring 和 Continuations

        1、首先，创建一个新的 .NET Core 6 Web API 项目：

dotnet new webapi -n HangfireSqlServerDemo
cd HangfireSqlServerDemo

        2. 添加必要的 NuGet 包

使用 NuGet 包管理器添加 Hangfire、Hangfire.AspNetCore 和 Hangfire.SqlServer 包：

dotnet add package Hangfire
dotnet add package Hangfire.AspNetCore
dotnet add package Hangfire.SqlServer

 3. 配置 SQL Server 数据库和 Hangfire日志

在 appsettings.json 中配置 SQL Server 连接字符串：

{
  "Logging": {
  "LogLevel": {
    "Default": "Information",
    "Microsoft.AspNetCore": "Warning",
    "Hangfire.AspNetCore": "Information"
  }
},
"AllowedHosts": "*",
"ConnectionStrings": {
  "DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=HangfireDemoDb;Trusted_Connection=True;MultipleActiveResultSets=true"
}
}

        4、使用本地mssqllocaldb，创建 HangfireDemoDb数据库

项目运行之后，会在 HangfireDemoDb数据库生成一些用与Hangfire任务的表，以下是 Hangfire 在 SQL Server 中创建的主要表及其用途：

1. [HangFire].[AggregatedCounter]

• 用途：用于存储聚合计数器的数据。

• 数据：包含计数器的键和值，通常用于统计目的。

2. [HangFire].[Counter]

• 用途：用于存储临时计数器的数据。

• 数据：包含计数器的键和值，类似于 AggregatedCounter，但这些数据是短期的。

3. [HangFire].[Hash]

• 用途：用于存储哈希数据。

• 数据：包含键值对，通常用于存储任务的元数据或其他配置信息。

4. [HangFire].[Job]

• 用途：用于存储任务的基本信息。

• 数据：包含任务的 ID、状态、参数、创建时间、上次执行时间等。

5. [HangFire].[JobParameter]

• 用途：用于存储任务的参数。

• 数据：包含任务 ID 和参数的键值对。

6. [HangFire].[JobQueue]

• 用途：用于存储待处理任务的队列。

• 数据：包含任务 ID 和队列名称。

7. [HangFire].[List]

• 用途：用于存储列表数据。

• 数据：包含键和值，通常用于存储任务的相关信息，如标签等。

8. [HangFire].[Lock]

• 用途：用于存储分布式锁的信息。

• 数据：包含锁的资源名称和过期时间，用于防止多个工作进程同时处理同一个任务。

9. [HangFire].[Schema]

• 用途：用于存储数据库架构版本的信息。

• 数据：包含当前的架构版本号。

10. [HangFire].[Server]

• 用途：用于存储 Hangfire 服务器的信息。

• 数据：包含服务器 ID、名称、心跳时间等信息。

11. [HangFire].[Set]

• 用途：用于存储集合数据。

• 数据：包含键和值，通常用于存储任务的标签或其他集合类型的数据。

12. [HangFire].[State]

• 用途：用于存储任务的状态信息。

• 数据：包含任务 ID、状态名称、创建时间和状态数据。

        5. 配置 Hangfire 使用 SQL Server

在 Program.cs 文件中配置 Hangfire 使用 SQL Server：

using Hangfire;
using Hangfire.SqlServer;
using HangfireSqlServerDemo.Data;
using Microsoft.EntityFrameworkCore;
using Microsoft.OpenApi.Models;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "HangfireSqlServerDemo", Version = "v1" });
});

// Configure Entity Framework and SQL Server
builder.Services.AddDbContext<ApplicationDbContext>(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("DefaultConnection")));

// Configure Hangfire services
builder.Services.AddHangfire(config =>
{
    config.UseSqlServerStorage(builder.Configuration.GetConnectionString("DefaultConnection"), new SqlServerStorageOptions
    {
        CommandBatchMaxTimeout = TimeSpan.FromMinutes(5),
        SlidingInvisibilityTimeout = TimeSpan.FromMinutes(5),
        QueuePollInterval = TimeSpan.Zero,
        UseRecommendedIsolationLevel = true,
        DisableGlobalLocks = true,
        JobExpirationCheckInterval = TimeSpan.FromHours(1), // 每小时检查一次过期任务
        JobExpirationTimeout = TimeSpan.FromDays(7) // 任务完成后保留7天
    });
});
builder.Services.AddHangfireServer();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "HangfireSqlServerDemo v1"));
}

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();

// Configure Hangfire Dashboard
app.UseHangfireDashboard();

app.Run();

 UseSqlServerStorage 方法的参数解释：

1. CommandBatchMaxTimeout:

   • 作用: 设置命令批处理的最大超时时间。
   • 意义: 当多个命令被批量处理时，这个参数定义了这些命令可以花费的最长时间。如果超过这个时间，批处理将会失败。

2. SlidingInvisibilityTimeout:

   • 作用: 设置滑动不可见性超时时间。
   • 意义: 当一个工作线程从队列中获取一个任务时，这个任务在一段时间内对其他工作线程是不可见的。这段时间称为滑动不可见性超时时间。这个参数确保任务不会被多个工作线程同时处理。

3. QueuePollInterval:

   • 作用: 设置队列轮询间隔时间。
   • 意义: 定义工作线程检查新任务的频率。设置为 TimeSpan.Zero 表示立即轮询，即没有延迟。

4. UseRecommendedIsolationLevel:

   • 作用: 指定是否使用推荐的隔离级别。
   • 意义: 推荐的隔离级别通常是 ReadCommitted，它可以防止脏读。设置为 true 可以提高数据一致性。

5. DisableGlobalLocks:

   • 作用: 禁用全局锁。
   • 意义: 全局锁用于防止多个服务器实例同时处理相同的任务。禁用全局锁可以提高性能，但可能会导致并发问题。

6. JobExpirationCheckInterval:

   • 作用: 设置任务过期检查的间隔时间。
   • 意义: 定义 Hangfire 检查和删除过期任务的频率。在这个例子中，每小时检查一次。

7. JobExpirationTimeout:

   • 作用: 设置任务完成后的保留时间。
   • 意义: 定义任务完成后在数据库中保留的时间。在这个例子中，任务完成后会保留 7 天，然后才会被删除。

四、运行项目

运行项目并访问 Swagger UI (https://localhost:8084/swagger/index.html) 来测试不同类型的后台任务。

你还可以访问 Hangfire Dashboard (https://localhost:8084/hangfire) 来查看和管理后台任务。

五、总结

这个示例项目展示了如何在 .NET Core 6 中整合 Hangfire，并实现了四种类型的后台任务：Fire-and-forget、Delayed、Recurring 和 Continuations。通过这种方式，你可以轻松地将长时间运行的任务从主线程中分离出来，提高应用程序的响应速度和性能。