LINGYUN.Abp.BackgroundJobs.Hangfire

1. Introduction

LINGYUN.Abp.BackgroundJobs.Hangfire is an ABP background job module implemented based on Hangfire. It provides a reliable background job execution framework that supports immediate, delayed, and recurring task execution.

2. Features

Support for immediate task execution
Support for delayed task execution
Support for recurring tasks (using Cron expressions)
Seamless integration with ABP background job system
Job execution status tracking
Job retry mechanism

3. Installation

dotnet add package LINGYUN.Abp.BackgroundJobs.Hangfire

4. Usage

Add AbpBackgroundJobsHangfireModule to your module dependencies:

[DependsOn(typeof(AbpBackgroundJobsHangfireModule))]
public class YourModule : AbpModule
{
}

Configure background jobs:

public override void ConfigureServices(ServiceConfigurationContext context)
{
    Configure<AbpBackgroundJobOptions>(options =>
    {
        options.IsJobExecutionEnabled = true; // Enable job execution
    });
}

Use background jobs:

public class YourService
{
    private readonly IBackgroundJobManager _backgroundJobManager;

    public YourService(IBackgroundJobManager backgroundJobManager)
    {
        _backgroundJobManager = backgroundJobManager;
    }

    public async Task CreateJobAsync()
    {
        // Create immediate job
        await _backgroundJobManager.EnqueueAsync(new YourArgs());

        // Create delayed job
        await _backgroundJobManager.EnqueueAsync(
            new YourArgs(),
            delay: TimeSpan.FromMinutes(5)
        );

        // Create recurring job
        await _backgroundJobManager.EnqueueAsync(
            "0 0 * * *", // Cron expression: Execute at 00:00 every day
            new YourArgs()
        );
    }
}

5. Configuration

5.1 Job Configuration

AbpBackgroundJobOptions.IsJobExecutionEnabled: Whether to enable job execution. Default value: true

6. Dependencies

Volo.Abp.BackgroundJobs
Hangfire.Core
Hangfire.AspNetCore

2.3 KiB Raw Blame History