Hangfire.Mongo 使用教程

1. 项目介绍

Hangfire.Mongo 是一个为 Hangfire 提供 MongoDB 存储支持的开源项目。Hangfire 是一个用于在 .NET 应用程序中执行后台任务的库，而 Hangfire.Mongo 则允许你将这些任务的信息存储在 MongoDB 中，而不是默认的 SQL Server 数据库。

主要功能

• MongoDB 存储支持：将 Hangfire 的任务信息存储在 MongoDB 中。
• 迁移策略：支持多种数据库迁移策略，确保在版本更新时数据的安全性。
• 自定义集合前缀：允许用户自定义 MongoDB 集合的前缀。

2. 项目快速启动

安装

首先，通过 NuGet 安装 Hangfire.Mongo 包：

Install-Package Hangfire.Mongo

配置

在 ASP.NET Core 项目中配置 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
        }));

    // 添加 Hangfire 服务器
    services.AddHangfireServer(serverOptions =>
    {
        serverOptions.ServerName = "Hangfire.Mongo Server";
    });
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseHangfireDashboard();
    app.UseHangfireServer();
}

使用

在控制器或服务中创建后台任务：

public class MyService
{
    public void CreateBackgroundJob()
    {
        BackgroundJob.Enqueue(() => Console.WriteLine("Hello, Hangfire!"));
    }
}

3. 应用案例和最佳实践

应用案例

• 后台任务处理：在电子商务网站中，使用 Hangfire 处理订单确认、库存更新等后台任务。
• 数据同步：在多系统集成中，使用 Hangfire 定期同步数据。

最佳实践

• 数据库连接字符串：确保 MongoDB 连接字符串的安全性，避免硬编码。
• 迁移策略：在生产环境中，使用 MigrateMongoMigrationStrategy 进行数据库迁移，确保数据安全。
• 监控与日志：使用 Hangfire 的 Dashboard 监控任务执行情况，并配置日志记录。

4. 典型生态项目

• Hangfire：核心任务调度库，支持多种后台任务处理。
• Hangfire.AspNetCore：为 ASP.NET Core 提供 Hangfire 支持。
• MongoDB.Driver：MongoDB 官方的 .NET 驱动，用于与 MongoDB 数据库进行交互。

通过以上步骤，你可以快速上手并使用 Hangfire.Mongo 在 .NET 应用程序中处理后台任务。