MicroCloud.Hangfire
8.0.1.3
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package MicroCloud.Hangfire --version 8.0.1.3
NuGet\Install-Package MicroCloud.Hangfire -Version 8.0.1.3
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="MicroCloud.Hangfire" Version="8.0.1.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MicroCloud.Hangfire --version 8.0.1.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MicroCloud.Hangfire, 8.0.1.3"
#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 MicroCloud.Hangfire as a Cake Addin #addin nuget:?package=MicroCloud.Hangfire&version=8.0.1.3 // Install MicroCloud.Hangfire as a Cake Tool #tool nuget:?package=MicroCloud.Hangfire&version=8.0.1.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
MicroCloud Hangfire 后台任务组件
说明
MicroCloud Hangfire 后台任务组件,封装基于 Hangfire 后台任务的服务端实现。
用法
可按照如下配置方式使用:
- 通过nuget引用
MicroCloud.Hangfire
程序集
Install-Package MicroCloud.Hangfire
- 在
appsettings.json
中 的MicroCloud
节点下添加如下配置节点
{
"Hangfire": {
"ServerName": "MicroCloudHangfire", //服务器名称
"WorkerCount": 20, //并发任务数 --超出并发数。将等待之前任务的完成 (推荐并发线程是cpu 的 5倍)
"StorageType": "Sqlserver", //存储类型:"Sqlserver"、"PostgreSql"、"SQLite"、"MySql"、"Oracle"、"Mongo"、"Redis"、"Memory"
//存储连接字符串:指定的数据库名必须已经存在,可以手动创建空数据库或者使用当前数据库
"StorageConnectionString": "Data Source=127.0.0.1;Initial Catalog=MicroCloudDEV.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=MicroCloud",
"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
- Hangfire (>= 1.8.12)
- Hangfire.MemoryStorage (>= 1.8.0)
- Hangfire.Mongo (>= 1.10.5)
- Hangfire.MySqlStorage (>= 2.0.3)
- Hangfire.Oracle.Core (>= 1.2.17)
- Hangfire.PostgreSql (>= 1.20.8)
- HangFire.Redis.StackExchange (>= 1.9.3)
- Hangfire.SQLite (>= 1.4.2)
- Hangfire.SqlServer (>= 1.8.12)
- MicroCloud.AspNetCore (>= 8.0.1.3)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on MicroCloud.Hangfire:
Package | Downloads |
---|---|
MicroCloud.Pack.Message
MicroCloud 消息模块,封装公告讯息收发及记录管理功能。 |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
8.0.3.1 | 115 | 9/9/2024 |
8.0.2.9 | 119 | 9/5/2024 |
8.0.2.8 | 113 | 8/31/2024 |
8.0.2.7 | 106 | 8/31/2024 |
8.0.2.6 | 124 | 8/21/2024 |
8.0.2.5 | 125 | 8/21/2024 |
8.0.2.4 | 125 | 8/12/2024 |
8.0.2.3 | 118 | 8/8/2024 |
8.0.2.2 | 99 | 7/14/2024 |
8.0.2.1 | 102 | 6/7/2024 |
8.0.1.9 | 111 | 6/6/2024 |
8.0.1.8 | 95 | 6/6/2024 |
8.0.1.7 | 105 | 5/15/2024 |
8.0.1.6 | 93 | 5/15/2024 |
8.0.1.5 | 105 | 5/15/2024 |
8.0.1.4 | 91 | 5/14/2024 |
8.0.1.3 | 106 | 5/10/2024 |
8.0.1.2 | 113 | 5/8/2024 |
8.0.1.1 | 112 | 5/7/2024 |
8.0.0.9 | 111 | 5/1/2024 |
8.0.0.8 | 96 | 5/1/2024 |
8.0.0.7 | 115 | 4/30/2024 |
8.0.0.5 | 119 | 4/19/2024 |
8.0.0.4 | 108 | 4/18/2024 |
8.0.0.3 | 120 | 4/15/2024 |
8.0.0.2 | 121 | 4/12/2024 |
8.0.0.1 | 106 | 4/12/2024 |
7.2.0.8 | 111 | 4/12/2024 |
7.2.0.7 | 109 | 4/12/2024 |
7.2.0.6 | 114 | 4/12/2024 |
7.2.0.5 | 121 | 4/12/2024 |
7.2.0.4 | 119 | 4/11/2024 |
7.2.0.2 | 139 | 4/7/2024 |
7.2.0.1 | 288 | 10/26/2023 |
7.1.2.9 | 133 | 11/7/2023 |
7.1.2.8 | 167 | 10/19/2023 |
7.1.2.7 | 121 | 10/19/2023 |
7.1.2.6 | 162 | 10/18/2023 |
7.1.2.5 | 147 | 9/20/2023 |
7.1.2.4 | 173 | 9/13/2023 |
7.1.2.3 | 172 | 9/13/2023 |
7.1.2.2 | 170 | 9/12/2023 |
7.1.2.1 | 160 | 9/4/2023 |
7.1.1.9 | 195 | 8/31/2023 |
7.1.1.6 | 174 | 8/29/2023 |
7.1.1.5 | 168 | 8/25/2023 |
7.1.1.4 | 167 | 8/25/2023 |
7.1.1.3 | 152 | 8/25/2023 |
7.1.1.2 | 147 | 8/24/2023 |
7.1.1.1 | 169 | 8/24/2023 |
7.0.3.1 | 172 | 8/24/2023 |
7.0.2.6 | 171 | 5/11/2023 |
7.0.1.7 | 180 | 5/9/2023 |
7.0.1.6 | 170 | 5/9/2023 |
7.0.1.4 | 199 | 4/24/2023 |
7.0.1.3 | 184 | 4/19/2023 |
7.0.1.2 | 160 | 4/19/2023 |
7.0.1.1 | 166 | 4/19/2023 |
7.0.0.9 | 190 | 4/18/2023 |
7.0.0.8 | 171 | 4/17/2023 |
7.0.0.7 | 171 | 4/12/2023 |
7.0.0.6 | 187 | 4/8/2023 |
7.0.0.5 | 198 | 4/7/2023 |
7.0.0.4 | 179 | 4/7/2023 |
7.0.0.3 | 173 | 4/7/2023 |