EaCloud.Hangfire
8.0.1.7
dotnet add package EaCloud.Hangfire --version 8.0.1.7
NuGet\Install-Package EaCloud.Hangfire -Version 8.0.1.7
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="EaCloud.Hangfire" Version="8.0.1.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add EaCloud.Hangfire --version 8.0.1.7
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: EaCloud.Hangfire, 8.0.1.7"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install EaCloud.Hangfire as a Cake Addin #addin nuget:?package=EaCloud.Hangfire&version=8.0.1.7 // Install EaCloud.Hangfire as a Cake Tool #tool nuget:?package=EaCloud.Hangfire&version=8.0.1.7
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
EaCloud Hangfire 后台任务组件
说明
EaCloud Hangfire 后台任务组件,封装基于 Hangfire 后台任务的服务端实现。
用法
可按照如下配置方式使用:
- 通过nuget引用
EaCloud.Hangfire
程序集
Install-Package EaCloud.Hangfire
- 在
appsettings.json
中 的EaCloud
节点下添加如下配置节点
{
"Hangfire": {
"Title": "EaCloud任务管理", //显示在仪表板上的标题
"ServerName": "EaCloudHangfire", //服务器名称
"WorkerCount": 20, //并发任务数 --超出并发数。将等待之前任务的完成 (推荐并发线程是cpu 的 5倍)
"StorageType": "Sqlserver", //存储类型:"Sqlserver"、"PostgreSql"、"SQLite"、"MySql"、"Oracle"、"Mongo"、"Redis"、"Memory"
//存储连接字符串:指定的数据库名必须已经存在,可以手动创建空数据库或者使用当前数据库
"StorageConnectionString": "Data Source=127.0.0.1;Initial Catalog=EaCloudDEV.Hangfire;User ID=sa;Password=p@ssw0rd;Pooling=true;Min Pool Size=1;Max Pool Size=60;Integrated Security=false;Connect Timeout=60;Application Name=EaCloud",
"DashboardUrl": "/hangfire", //仪表盘URL路径
"AuthorizationType": "Basic", //授权访问类型:"Anonymous"、"Basic"
//Hangfire基本身份验证的选项,当 AuthorizationType = "Basic" 时生效。
"BasicOptions": {
"SslRedirect": false, //SSL重定向
"RequireSsl": false, //需要SSL连接才能访问Hangfire Dashboard
"LoginCaseSensitive": false, //登录检查是否区分大小写
//访问Hangfire仪表板的用户列表
"Users": [
{
//登录名
"UserId": "用户身份标识",
//登录密码
"Password": "访问密码"
}
]
},
"Enabled": true //是否启用
}
}
- 若存储类型设为数据库类型(
Sqlserver
、PostgreSql
、SQLite
、MySql
、Oracle
、Mongo
),则需要按照连接串去新建Hangfire用的空数据库(只要库就可以,表会自动生成)。 - 启动web项目后,访问
http(s)://ip:port/(DashboardUrl)
即可打开Hangfire仪表盘界面。 - 后端使用Hangfire代码示例
5.1. 项目中新建
XXXHangfireJobRunner
实现类并添加[Dependency(ServiceLifetime.Singleton)]
单例服务特性,继承IHangfireJobRunner
接口在Start
方法中添加Hangfire任务逻辑
#region "Hangfire作业运行器"
/// <summary>
/// Hangfire作业运行器
/// </summary>
[Dependency(ServiceLifetime.Singleton)]
public class HangfireJobRunner : IHangfireJobRunner
{
/// <summary>
/// 启动作业运行器
/// </summary>
public void Start()
{
//队列任务
BackgroundJob.Enqueue(() => Console.WriteLine($@"队列任务"));
//延时任务
var jobId = BackgroundJob.Schedule(() => Console.WriteLine($@"延时任务"), TimeSpan.FromMinutes(1));
//延续性任务执行
BackgroundJob.ContinueJobWith(jobId, () => Console.WriteLine($@"延续性任务执行"));
//定时任务
RecurringJob.AddOrUpdate("JobId1", () => Console.WriteLine($@"定时任务:每年的4月12号15点52分任意秒执行 没加时区 小时+8"), "* 52 15 12 4 *"); //每年的4月12号15点52分任意秒执行 没加时区 小时+8
RecurringJob.AddOrUpdate("JobId2", () => Console.WriteLine($@"定时任务:每分钟执行一次"), Cron.Minutely); //每分钟执行一次。
RecurringJob.AddOrUpdate("JobId3", () => Console.WriteLine($@"定时任务:每天18点36分 当前时区"), Cron.Daily(18, 36), new RecurringJobOptions { TimeZone = TimeZoneInfo.Local }); //每天18点36分 当前时区
//本机示例
RecurringJob.AddOrUpdate<TestHangfireJob>("TestHangfireJob_Test", m => m.Test(), Cron.Minutely, new RecurringJobOptions { TimeZone = TimeZoneInfo.Local });
RecurringJob.AddOrUpdate<TestHangfireJob>("TestHangfireJob_TestAsync", m => m.TestAsync(), Cron.Minutely, new RecurringJobOptions { TimeZone = TimeZoneInfo.Local });
}
}
#endregion
5.2. 若需要使用注入模式使用,参考上述代码本机示例
新建XXXHangfireJob
,定义如下结构代码
#region "测试Hangfire作业"
/// <summary>
/// 测试Hangfire作业
/// </summary>
public class XXXHangfireJob
{
#region "字段"
#region "私有只读-身份认证上下文"
/// <summary>
/// 私有只读-身份认证上下文
/// </summary>
private readonly IIdentityContract _identityContract;
#endregion
#region "私有只读-服务提供者"
/// <summary>
/// 私有只读-服务提供者
/// </summary>
private readonly IServiceProvider _provider;
#endregion
#endregion
#region "属性"
#region "获取 日志对象"
/// <summary>
/// 获取 日志对象
/// </summary>
protected ILogger Logger => _provider.GetLogger(GetType());
#endregion
#endregion
#region "构造函数"
#region "初始化一个测试Hangfire作业的新实例"
/// <summary>
/// 初始化一个测试Hangfire作业 <see cref="XXXHangfireJob"/> 的新实例
/// </summary>
/// <param name="identityContract">身份认证上下文</param>
/// <param name="provider">服务提供者</param>
public XXXHangfireJob(IIdentityContract identityContract, IServiceProvider provider)
{
_identityContract = identityContract;
_provider = provider;
}
#endregion
#endregion
#region "方法"
#region "同步测试方法"
/// <summary>
/// 同步测试方法
/// </summary>
/// <returns></returns>
public void Test()
{
//TODO:Your Coding...
Logger.LogDebug(I18N.T("HangfireTest", "Hangfire Test:{0}", false, DateTime.Now.ToString()));
}
#endregion
#region "异步测试方法"
/// <summary>
/// 异步测试方法
/// </summary>
/// <returns></returns>
public async Task TestAsync()
{
//TODO:Your Coding...
Logger.LogDebug(I18N.T("HangfireTestAsync", "Hangfire TestAsync:{0}", false, DateTime.Now.ToString()));
await Task.CompletedTask;
}
#endregion
#endregion
}
#endregion
- 要禁用Hangfire,设置
Enabled: false
。
交流
QQ群号:863605868 | 微信号:SeonHu |
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- EaCloud.AspNetCore (>= 8.0.1.7)
- Hangfire (>= 1.8.14)
- Hangfire.HttpJob (>= 3.8.5)
- Hangfire.HttpJob.Agent (>= 1.5.1)
- Hangfire.HttpJob.Client (>= 1.2.9)
- Hangfire.MemoryStorage (>= 1.8.1.1)
- Hangfire.Mongo (>= 1.10.9)
- Hangfire.MySqlStorage (>= 2.0.3)
- Hangfire.Oracle.Core (>= 1.2.17)
- Hangfire.PostgreSql (>= 1.20.9)
- HangFire.Redis.StackExchange (>= 1.9.3)
- Hangfire.SQLite (>= 1.4.2)
- Hangfire.SqlServer (>= 1.8.14)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on EaCloud.Hangfire:
Package | Downloads |
---|---|
EaCloud.Pack.Message
EaCloud 消息模块,封装公告讯息收发及记录管理功能。 |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
8.0.1.7 | 114 | 10/9/2024 |
8.0.1.6 | 107 | 9/29/2024 |
8.0.1.5 | 128 | 9/13/2024 |
8.0.1.4 | 141 | 8/10/2024 |
8.0.1.3 | 122 | 8/7/2024 |
8.0.1.2 | 117 | 8/7/2024 |
8.0.1.1 | 122 | 8/7/2024 |
8.0.0.9 | 110 | 8/7/2024 |
8.0.0.8 | 72 | 8/5/2024 |
8.0.0.7 | 71 | 8/2/2024 |
8.0.0.6 | 88 | 8/1/2024 |
8.0.0.5 | 77 | 8/1/2024 |
8.0.0.4 | 55 | 7/31/2024 |
8.0.0.3 | 91 | 7/30/2024 |
8.0.0.2 | 105 | 7/25/2024 |
8.0.0.1 | 113 | 7/24/2024 |
7.0.9.4 | 121 | 7/19/2024 |
7.0.9.3 | 143 | 7/11/2024 |
7.0.9.2 | 138 | 7/6/2024 |
7.0.9.1 | 135 | 7/3/2024 |
7.0.8.9 | 151 | 6/28/2024 |
7.0.8.8 | 140 | 6/26/2024 |
7.0.8.7 | 140 | 6/22/2024 |
7.0.8.6 | 146 | 6/14/2024 |
7.0.8.5 | 140 | 5/31/2024 |
7.0.8.4 | 152 | 5/21/2024 |
7.0.8.3 | 162 | 5/21/2024 |
7.0.8.2 | 134 | 5/20/2024 |
7.0.8.1 | 164 | 5/20/2024 |
7.0.7.9 | 145 | 5/15/2024 |
7.0.7.8 | 140 | 5/10/2024 |
7.0.7.7 | 127 | 5/9/2024 |
7.0.7.6 | 126 | 5/9/2024 |
7.0.7.5 | 191 | 5/7/2024 |
7.0.7.4 | 149 | 4/28/2024 |
7.0.7.3 | 166 | 4/26/2024 |
7.0.7.2 | 158 | 4/21/2024 |
7.0.7.1 | 145 | 4/19/2024 |
7.0.6.9 | 154 | 4/15/2024 |
7.0.6.8 | 147 | 4/11/2024 |
7.0.6.7 | 143 | 4/11/2024 |
7.0.6.6 | 181 | 4/7/2024 |
7.0.6.5 | 153 | 4/7/2024 |
7.0.6.4 | 164 | 4/7/2024 |
7.0.6.3 | 158 | 4/7/2024 |
7.0.6.2 | 152 | 4/3/2024 |
7.0.6.1 | 160 | 4/3/2024 |
7.0.5.9 | 169 | 3/27/2024 |
7.0.5.8 | 151 | 3/23/2024 |
7.0.5.7 | 174 | 3/17/2024 |
7.0.5.6 | 175 | 3/17/2024 |
7.0.5.5 | 179 | 3/16/2024 |
7.0.5.4 | 197 | 3/13/2024 |
7.0.5.3 | 165 | 3/13/2024 |
7.0.5.2 | 182 | 3/6/2024 |
7.0.5.1 | 182 | 2/21/2024 |
7.0.4.9 | 170 | 2/21/2024 |
7.0.4.8 | 170 | 2/18/2024 |
7.0.4.7 | 163 | 2/5/2024 |
7.0.4.6 | 176 | 2/1/2024 |
7.0.4.5 | 163 | 1/26/2024 |
7.0.4.4 | 180 | 1/22/2024 |
7.0.4.3 | 172 | 1/17/2024 |
7.0.4.2 | 137 | 1/16/2024 |
7.0.4.1 | 163 | 1/16/2024 |
7.0.3.9 | 164 | 1/15/2024 |
7.0.3.8 | 194 | 1/3/2024 |
7.0.3.7 | 190 | 12/28/2023 |
7.0.3.6 | 149 | 12/27/2023 |
7.0.3.5 | 177 | 12/22/2023 |
7.0.3.4 | 191 | 12/22/2023 |
7.0.3.3 | 204 | 12/13/2023 |
7.0.3.2 | 157 | 12/13/2023 |
7.0.3.1 | 193 | 12/12/2023 |
7.0.2.9 | 209 | 11/26/2023 |
7.0.2.8 | 216 | 11/26/2023 |
7.0.2.7 | 215 | 9/26/2023 |
7.0.2.6 | 189 | 9/25/2023 |
7.0.2.5 | 188 | 9/15/2023 |
7.0.2.4 | 212 | 7/27/2023 |
7.0.2.3 | 227 | 7/22/2023 |
7.0.2.2 | 241 | 7/22/2023 |
7.0.2.1 | 225 | 7/21/2023 |
7.0.1.9 | 206 | 7/21/2023 |
7.0.1.8 | 218 | 7/20/2023 |
7.0.1.7 | 212 | 7/20/2023 |
7.0.1.6 | 269 | 7/4/2023 |
7.0.1.5 | 226 | 6/16/2023 |
7.0.1.4 | 228 | 6/13/2023 |
7.0.1.3 | 264 | 6/8/2023 |
7.0.1.2 | 260 | 6/2/2023 |
7.0.1.1 | 261 | 5/11/2023 |
7.0.0.9 | 258 | 5/10/2023 |
7.0.0.8 | 285 | 5/10/2023 |
7.0.0.7 | 311 | 4/19/2023 |
7.0.0.6 | 311 | 4/18/2023 |
7.0.0.5 | 370 | 3/27/2023 |
7.0.0.4 | 346 | 3/23/2023 |
7.0.0.3 | 392 | 1/31/2023 |
7.0.0.2 | 409 | 1/30/2023 |
7.0.0.1 | 371 | 12/24/2022 |
6.0.2.5 | 539 | 11/16/2022 |
6.0.2.4 | 555 | 11/10/2022 |
6.0.2.3 | 697 | 10/11/2022 |
6.0.2.2 | 738 | 9/23/2022 |
6.0.2.1 | 765 | 8/14/2022 |
6.0.1.9 | 783 | 8/13/2022 |
6.0.1.8 | 813 | 6/6/2022 |
6.0.1.7 | 804 | 5/26/2022 |
6.0.1.6 | 847 | 5/11/2022 |
6.0.1.5 | 872 | 5/10/2022 |
6.0.1.4 | 956 | 4/8/2022 |
6.0.1.3 | 970 | 4/2/2022 |
6.0.1.2 | 982 | 4/2/2022 |
6.0.1.1 | 1,012 | 3/18/2022 |
6.0.0.9 | 967 | 3/5/2022 |
6.0.0.8 | 965 | 2/19/2022 |
6.0.0.7 | 947 | 2/15/2022 |
6.0.0.6 | 971 | 2/14/2022 |
6.0.0.5 | 1,065 | 1/28/2022 |
6.0.0.4 | 1,135 | 1/13/2022 |
6.0.0.3 | 1,113 | 1/12/2022 |
6.0.0.2 | 1,370 | 12/21/2021 |
6.0.0.1 | 1,546 | 12/13/2021 |
5.0.3.7 | 1,942 | 10/16/2021 |
5.0.3.6 | 1,088 | 10/14/2021 |
5.0.3.5 | 1,071 | 10/13/2021 |
5.0.3.4 | 1,233 | 10/8/2021 |
5.0.3.3 | 1,173 | 9/17/2021 |
5.0.3.2 | 1,291 | 9/16/2021 |
5.0.3.1 | 1,187 | 9/15/2021 |
5.0.2.9 | 1,229 | 9/15/2021 |
5.0.2.8 | 1,337 | 8/31/2021 |
5.0.2.7 | 1,298 | 8/28/2021 |
5.0.2.6 | 1,245 | 8/22/2021 |
5.0.2.5 | 1,177 | 8/13/2021 |
5.0.2.4 | 1,154 | 8/13/2021 |
5.0.2.3 | 1,112 | 7/8/2021 |
5.0.2.2 | 1,040 | 7/1/2021 |
5.0.2.1 | 1,163 | 6/16/2021 |
5.0.1.9 | 1,050 | 5/12/2021 |
5.0.1.8 | 958 | 5/9/2021 |
5.0.1.7 | 1,102 | 5/7/2021 |
5.0.1.6 | 1,101 | 4/17/2021 |
5.0.1.5 | 1,038 | 4/16/2021 |
5.0.1.4 | 1,028 | 4/15/2021 |
5.0.1.3 | 1,032 | 4/15/2021 |
5.0.1.2 | 1,084 | 4/12/2021 |