Hangfire.Mongo 使用教程

Hangfire.Mongo Mongo DB support for Hangfire 项目地址: https://gitcode.com/gh_mirrors/ha/Hangfire.Mongo

1. 项目介绍

Hangfire.Mongo 是一个为 Hangfire 提供 MongoDB 存储支持的开源项目。Hangfire 是一个用于在 .NET 应用程序中执行后台任务的库，而 Hangfire.Mongo 则允许你将这些任务的信息存储在 MongoDB 中。通过使用 Hangfire.Mongo，你可以利用 MongoDB 的强大功能来管理和持久化后台任务数据。

2. 项目快速启动

安装

首先，你需要通过 NuGet 安装 Hangfire.Mongo 包。打开 NuGet 包管理器控制台并运行以下命令：

PM> Install-Package Hangfire.Mongo

配置

ASP.NET Core

在 Startup.cs 文件中配置 Hangfire 使用 MongoDB 存储：

public void ConfigureServices(IServiceCollection services)
{
    var mongoUrlBuilder = new MongoUrlBuilder("mongodb://localhost/jobs");
    var mongoClient = new MongoClient(mongoUrlBuilder.ToMongoUrl());

    // 添加 Hangfire 服务
    services.AddHangfire(configuration => configuration
        .SetDataCompatibilityLevel(CompatibilityLevel.Version_180)
        .UseSimpleAssemblyNameTypeSerializer()
        .UseRecommendedSerializerSettings()
        .UseMongoStorage(mongoClient, mongoUrlBuilder.DatabaseName, new MongoStorageOptions
        {
            MigrationOptions = new MongoMigrationOptions
            {
                MigrationStrategy = new MigrateMongoMigrationStrategy(),
                BackupStrategy = new CollectionMongoBackupStrategy()
            },
            Prefix = "hangfire.mongo",
            CheckConnection = true
        }));

    // 添加处理服务器作为 IHostedService
    services.AddHangfireServer(serverOptions =>
    {
        serverOptions.ServerName = "Hangfire.Mongo server 1";
    });
}

ASP.NET

在 Global.asax.cs 文件中配置 Hangfire 使用 MongoDB 存储：

var options = new MongoStorageOptions
{
    MigrationOptions = new MongoMigrationOptions
    {
        MigrationStrategy = new DropMongoMigrationStrategy(),
        BackupStrategy = new NoneMongoBackupStrategy()
    }
};

GlobalConfiguration.Configuration.UseMongoStorage("mongodb://localhost/jobs", options);
app.UseHangfireServer();
app.UseHangfireDashboard();

控制台应用

在控制台应用中配置 Hangfire 使用 MongoDB 存储：

var options = new MongoStorageOptions
{
    MigrationOptions = new MongoMigrationOptions
    {
        MigrationStrategy = new DropMongoMigrationStrategy(),
        BackupStrategy = new NoneMongoBackupStrategy()
    }
};

var mongoStorage = new MongoStorage(
    MongoClientSettings.FromConnectionString("mongodb://localhost"),
    "jobs", // 数据库名称
    options);

using (new BackgroundJobServer(mongoStorage))
{
    // 你的代码
}

3. 应用案例和最佳实践

应用案例

Hangfire.Mongo 适用于需要将后台任务数据存储在 MongoDB 中的场景。例如：

电子商务平台：在电子商务平台中，可以使用 Hangfire.Mongo 来处理订单处理、库存更新等后台任务。
社交媒体应用：在社交媒体应用中，可以使用 Hangfire.Mongo 来处理用户通知、内容推荐等后台任务。

最佳实践

数据迁移：在升级 Hangfire.Mongo 版本时，务必注意数据迁移策略。建议在生产环境中使用 Migrate 策略，并在测试环境中充分测试。
备份策略：在执行数据迁移前，建议配置备份策略以防止数据丢失。
性能优化：根据应用场景调整 QueuePollInterval 和 InvisibilityTimeout 等参数，以优化性能。

4. 典型生态项目

Hangfire.Mongo 作为 Hangfire 的扩展，可以与其他 Hangfire 生态项目结合使用，例如：

Hangfire.Pro：提供高级功能和扩展，如分布式锁、批处理等。
Hangfire.Dashboard.Authorization：为 Hangfire 的 Dashboard 提供授权功能。
Hangfire.Redis.StackExchange：提供 Redis 存储支持，适用于需要高性能存储的场景。

通过结合这些生态项目，可以进一步扩展 Hangfire.Mongo 的功能，满足更复杂的业务需求。

Hangfire.Mongo Mongo DB support for Hangfire 项目地址: https://gitcode.com/gh_mirrors/ha/Hangfire.Mongo