Hangfire.RecurringJobExtensions使用指南

Hangfire.RecurringJobExtensions使用指南

Hangfire.RecurringJobExtensionsExtensions for Hangfire to build RecurringJob automatically项目地址:https://gitcode.com/gh_mirrors/ha/Hangfire.RecurringJobExtensions

---

一、项目目录结构及介绍

Hangfire.RecurringJobExtensions是基于Hangfire框架的一个扩展库，用于增强定时任务的管理能力。下面是该项目的基本目录结构及其简要说明：

Hangfire.RecurringJobExtensions/
│   README.md                - 项目介绍和快速上手文档。
│   LICENSE                  - 许可证文件。
├── src                      - 源代码目录
│   ├── Hangfire.RecurringJobExtensions  - 主要实现库
│       └── ...                     - 包含类定义和其他源码文件，提供对Recurring Job的额外功能或优化。
├── test                     - 测试目录
│   └── Hangfire.RecurringJobExtensions.Tests - 单元测试和集成测试代码。
├── samples                  - 示例应用，展示如何在实际项目中使用该扩展。
│       └── SampleApp              - 简单的应用示例，包含基本的集成案例。
├── .gitignore               - Git忽略文件列表。
├── packages.config          - NuGet包依赖配置（如果有）。
└── other supporting files   - 其他支持文件如build脚本等。

---

二、项目的启动文件介绍

使用Hangfire.RecurringJobExtensions时，核心是在你的应用程序启动阶段配置Hangfire服务并注册该扩展。这通常涉及到以下几个步骤，尽管具体文件名可能依你的项目架构而异：

配置服务

在ASP.NET Core项目中，这通常发生在Startup.cs文件的ConfigureServices(IServiceCollection services)方法内。你需要添加Hangfire的服务以及这个特定的扩展：

services.AddHangfire(configuration => configuration.SetDataCompatibilityLevel(CompatibilityLevel.Version_170));
services.AddHangfireServer();
// 添加扩展特性
services.AddSingleton<IRecurringJobManager>(new RecurringJobManager());

启动Hangfire Dashboard

同样在Startup.cs中的Configure(IApplicationBuilder app, IWebHostEnvironment env)方法，启用Dashboard：

app.UseHangfireDashboard("/hangfire", new DashboardOptions {
    AppPath = "/",
    Authorization = new[] { new CustomAuthorizationFilter() } // 自定义权限控制
});

---

三、项目的配置文件介绍

在Hangfire.RecurringJobExtensions中，虽然核心配置多通过代码进行，但是你可以利用环境变量或是配置文件(appsettings.json, appsettings.Development.json等)来配置Hangfire的基础设置，例如数据库连接字符串。示例配置如下：

appsettings.json

{
  "Hangfire": {
    "StorageConnection": "UseDevelopmentStorage=true", // 如果使用Azure Storage Queue
    // 或者对于SQL Server:
    // "StorageConnection": "Server=(localdb)\\mssqllocaldb;Database=Hangfire;Trusted_Connection=True;",
    "Dashboard": {
      "Path": "/hangfire", // Dashboard访问路径
      "RequireAuthentication": true // 是否需要身份验证
    }
  }
}

在代码中，你可以通过依赖注入获取这些配置值来初始化Hangfire。注意，对于RecurringJobExtensions的特有配置，大部分情况是在代码里直接指定，比如定义RecurringJob时直接写入：

RecurringJob.AddOrUpdate(() => YourMethodToRun(), Cron.Daily);

这样，你便完成了配置和使用Hangfire.RecurringJobExtensions的关键步骤，确保了定时任务的管理和执行能力得到增强。

Hangfire.RecurringJobExtensionsExtensions for Hangfire to build RecurringJob automatically项目地址:https://gitcode.com/gh_mirrors/ha/Hangfire.RecurringJobExtensions