Hangfire单实例重复作业

作者:编程家 分类: 编程代码 时间:2025-11-16

Hangfire单实例重复作业

Hangfire是一个用于在ASP.NET和.NET Core应用程序中处理后台作业的开源库。它提供了一个简单而强大的方式来安排和执行作业,无论是一次性还是重复的。在某些情况下,我们可能需要确保重复作业只在应用程序的多个实例中的一个实例上执行。本文将介绍如何在Hangfire中实现单实例重复作业,并提供一个案例代码。

背景

在某些应用程序中,我们可能需要执行一些需要保证只在一个实例上运行的作业。例如,我们可能有一个需要每隔一段时间向数据库中写入数据的作业,但我们只希望其中一个实例来执行这个作业,以避免重复写入相同的数据。

实现方法

在Hangfire中实现单实例重复作业的方法很简单。我们可以使用Hangfire的分布式锁机制来确保只有一个实例可以运行作业。下面是一个简单的示例代码,演示了如何使用Hangfire实现单实例重复作业。

csharp

public class SingletonJob

{

[AutomaticRetry(Attempts = 0)]

public void Run()

{

if (!Hangfire.JobStorage.Current.GetConnection().AcquireDistributedLock("singleton-lock", TimeSpan.FromSeconds(1)))

{

// 如果无法获取锁,则退出

return;

}

try

{

// 在这里执行作业的代码

// ...

}

finally

{

Hangfire.JobStorage.Current.GetConnection().RemoveFromQueue("default", Hangfire.JobStorage.Current.GetConnection().GetJobId(typeof(SingletonJob), "Run"));

Hangfire.JobStorage.Current.GetConnection().ReleaseDistributedLock("singleton-lock");

}

}

}

在上面的代码中,我们首先使用`AcquireDistributedLock`方法来尝试获取一个名为"singleton-lock"的分布式锁,超时时间为1秒。如果无法获取锁,则表示有其他实例正在执行作业,我们可以选择退出。如果成功获取到锁,则可以执行作业的代码。在`finally`块中,我们通过`RemoveFromQueue`方法将作业从默认队列中移除,并使用`ReleaseDistributedLock`方法释放锁。

案例代码

在这个案例中,我们将实现一个每隔一分钟执行的定时作业,并确保只有一个实例可以运行。

csharp

public class Startup

{

public void ConfigureServices(IServiceCollection services)

{

// 配置Hangfire

services.AddHangfire(configuration => configuration.UseSqlServerStorage("connection-string"));

}

public void Configure(IApplicationBuilder app, IBackgroundJobClient backgroundJobs)

{

// 使用Hangfire面板

app.UseHangfireDashboard();

// 创建定时作业

RecurringJob.AddOrUpdate(x => x.Run(), Cron.MinuteInterval(1));

// 启动Hangfire服务

app.UseHangfireServer();

}

}

在上面的代码中,我们首先在`ConfigureServices`方法中配置了Hangfire,并使用SQL Server作为持久化存储。然后,在`Configure`方法中,我们使用`UseHangfireDashboard`方法启用了Hangfire的面板,使我们可以通过浏览器访问Hangfire的管理界面。接下来,我们使用`AddOrUpdate`方法创建了一个每隔一分钟执行的定时作业,并指定了作业的类型为`SingletonJob`,调用的方法为`Run`。最后,我们使用`UseHangfireServer`方法启动了Hangfire的后台服务,以便执行作业。

通过使用Hangfire的分布式锁机制,我们可以轻松地实现单实例重复作业。这对于一些需要确保作业只在一个实例上运行的应用程序非常有用。在本文中,我们介绍了Hangfire的单实例重复作业的实现方法,并提供了一个案例代码来演示其用法。希望本文能帮助你更好地理解和使用Hangfire的单实例重复作业功能。