Hangfire.Mongo 使用手册

1. 项目目录结构及介绍

Hangfire.Mongo 是一个为 Hangfire 提供 MongoDB 支持的库，允许开发者将 Hangfire 的作业信息存储在 MongoDB 数据库中。以下是项目的基本目录结构及其简介：

• src: 主代码存放区域。
  • 这里包含了实现 MongoDB 存储的核心类和逻辑。
• editorconfig: 定义代码风格的配置文件。
• gitignore: Git 忽略文件列表，指定哪些文件或目录不应被纳入版本控制。
• ChangeLog.md: 版本更新日志，记录每个版本的主要变动。
• LICENSE: 许可证文件，声明了该项目遵循的 MIT 开源许可协议。
• README.md: 项目简介，快速入门指南和其他重要信息。
• src/Hangfire.Mongo: 核心库源码，包括存储策略、迁移策略等关键组件。

2. 项目的启动文件介绍

在实际应用中，无需直接操作此开源项目的启动文件，因为它是作为依赖引入到你的应用程序中的。但是，在你的 ASP.NET Core 应用程序中，你需要在 Startup.cs 或等效配置类中集成 Hangfire.Mongo。以下是如何配置的示例：

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

    // 添加 Hangfire 服务，并配置使用 MongoDB 存储
    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
            }));

    // 添加后台处理服务器
    services.AddHangfireServer(options =>
    {
        options.ServerName = "Hangfire_Mongo_Server";
    });
}

在 .Configure() 方法中，还需添加以下内容以启用 Hangfire Dashboard 和确保所有必要服务已被注册：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    ...
    // 启用 Hangfire Dashboard
    app.UseHangfireDashboard();
    
    // 确保背景任务服务器运行
    app.UseHangfireServer();
    ...
}

3. 项目的配置文件介绍

Hangfire.Mongo 的配置主要通过代码来完成，而不直接依赖于外部配置文件如.json或.xml。然而，你可以通过环境变量、命令行参数或应用程序设置（例如，在ASP.NET Core中的appsettings.json）间接影响配置过程。例如，数据库连接字符串可以通过环境变量或配置文件间接提供给应用程序。

如果需要在MongoDB的连接字符串或其他配置项上灵活配置，可以通过读取这些配置来源的方式进行调整，如下所示：

// 假设这是从配置文件获取的MongoDB连接字符串
var connectionString = Configuration.GetConnectionString("HangfireMongoDB");

services.AddHangfire(configuration => configuration.UseMongoStorage(connectionString));

请注意，尽管配置不直接通过传统配置文件管理，但借助.NET Core的配置系统，你可以轻松地将其与其他应用程序设置一同管理和注入。