系列文章
- 基于 abp vNext 和 .NET Core 開發博客專案 - 使用 abp cli 搭建專案
- 基于 abp vNext 和 .NET Core 開發博客專案 - 給專案瘦身，讓它跑起來
- 基于 abp vNext 和 .NET Core 開發博客專案 - 完善與美化，Swagger登場
- 基于 abp vNext 和 .NET Core 開發博客專案 - 資料訪問和代碼優先
- 基于 abp vNext 和 .NET Core 開發博客專案 - 自定義倉儲之增刪改查
- 基于 abp vNext 和 .NET Core 開發博客專案 - 統一規范API，包裝回傳模型
- 基于 abp vNext 和 .NET Core 開發博客專案 - 再說Swagger，分組、描述、小綠鎖
- 基于 abp vNext 和 .NET Core 開發博客專案 - 接入GitHub，用JWT保護你的API
- 基于 abp vNext 和 .NET Core 開發博客專案 - 例外處理和日志記錄
- 基于 abp vNext 和 .NET Core 開發博客專案 - 使用Redis快取資料
- 基于 abp vNext 和 .NET Core 開發博客專案 - 集成Hangfire實作定時任務處理
- 基于 abp vNext 和 .NET Core 開發博客專案 - 用AutoMapper搞定物件映射
- 基于 abp vNext 和 .NET Core 開發博客專案 - 定時任務最佳實戰（一）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 定時任務最佳實戰（二）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 定時任務最佳實戰（三）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 博客介面實戰篇（一）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 博客介面實戰篇（二）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 博客介面實戰篇（三）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 博客介面實戰篇（四）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 博客介面實戰篇（五）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（一）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（二）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（三）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（四）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（五）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（六）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（七）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（八）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（九）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 終結篇之發布專案
上一篇文章(https://www.cnblogs.com/meowv/p/12956696.html)成功使用了Redis快取資料，大大提高博客的回應性能，
接下來，將完成一個任務調度中心，關于定時任務有多種處理方式，如果你的需求比較簡單，比如就是單純的過多少時間回圈執行某個操作，可以直接使用.net core中內置的實作方式，新建一個類繼承BackgroundService，實作ExecuteAsync()既可，
看一個例子，我們每過一秒輸出一句HelloWorld，并寫入日志中，
在.BackgroundJobs中新建一個Jobs檔案夾，添加HelloWorldJob.cs，并且繼承自BackgroundService，
//HelloWorldJob.cs
using log4net;
using Microsoft.Extensions.Hosting;
using System;
using System.Threading;
using System.Threading.Tasks;
namespace Meowv.Blog.BackgroundJobs.Jobs
{
public class HelloWorldJob : BackgroundService
{
private readonly ILog _log;
public HelloWorldJob()
{
_log = LogManager.GetLogger(typeof(HelloWorldJob));
}
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
while (!stoppingToken.IsCancellationRequested)
{
var msg = $"CurrentTime:{ DateTime.Now}, Hello World!";
Console.WriteLine(msg);
_log.Info(msg);
await Task.Delay(1000, stoppingToken);
}
}
}
}
然后在.HttpApi.Hosting層模塊類中的ConfigureServices()注入context.Services.AddTransient<IHostedService, HelloWorldJob>();使用，運行一下看看效果，
可以看到已經成功輸出了，你可以在ExecuteAsync()中做你的事件處理邏輯，這應該是最簡單后臺定時任務處理了，比較單一，
在abp框架中，官方給我們提供了許多后臺作業的集成方式，有興趣的可以自行研究一下，檔案地址：https://docs.abp.io/zh-Hans/abp/latest/Background-Jobs
在本專案中，我將使用 Hangfire 來完成定時任務處理，為什么選擇它呢？因為簡單，開箱即用，下面進入正題，可以先將 HelloWorldJob 停掉，
在.BackgroundJobs中添加nuget包：Volo.Abp.BackgroundJobs.HangFire、Hangfire.MySql.Core、Hangfire.Dashboard.BasicAuthorization、Volo.Abp.AspNetCore，然后添加專案參考：.Domain，
在根目錄新建模塊類：MeowvBlogBackgroundJobsModule.cs，繼承AbpModule，依賴AbpBackgroundJobsHangfireModule，
//MeowvBlogBackgroundJobsModule.cs
using Hangfire;
using Hangfire.MySql.Core;
using Meowv.Blog.Domain.Configurations;
using Meowv.Blog.Domain.Shared;
using Volo.Abp;
using Volo.Abp.BackgroundJobs.Hangfire;
using Volo.Abp.Modularity;
namespace Meowv.Blog.BackgroundJobs
{
[DependsOn(typeof(AbpBackgroundJobsHangfireModule))]
public class MeowvBlogBackgroundJobsModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.Services.AddHangfire(config =>
{
config.UseStorage(
new MySqlStorage(AppSettings.ConnectionStrings,
new MySqlStorageOptions
{
TablePrefix = MeowvBlogConsts.DbTablePrefix + "hangfire"
}));
});
}
public override void OnApplicationInitialization(ApplicationInitializationContext context)
{
var app = context.GetApplicationBuilder();
app.UseHangfireServer();
app.UseHangfireDashboard();
}
}
}
在ConfigureServices()中添加配置，因為之前選用了MySQL，所以這里參考了Hangfire.MySql.Core這個包，相對于的其它資料庫可以在nuget上尋找，
在new MySqlStorage()中配置連接字串，new MySqlStorageOptions()中配置表前綴，Hangfire會在第一次運行時，自動為我們創建表，
然后在OnApplicationInitialization()中進行使用，app.UseHangfireServer()必須呼叫，如果你不需要界面顯示可以不用app.UseHangfireDashboard();
最后不要忘記，在.HttpApi.Hosting層模塊類中依賴定時任務模塊MeowvBlogBackgroundJobsModule，
現在運行一下專案，打開地址：.../hangfire 看看，
資料庫默認已經為我們創建了hangfire所需的表，
有一個地方要注意，就是在連接字串中需要開啟用戶變數，修改一下appsettings.json中的連接字串，在末尾添加：Allow User Variables=True，
同時在app.UseHangfireDashboard()中，還支持很多配置項，現在我們這個定時任務是公開的，如果我們不想要外人訪問，可以開啟BasicAuth，
現在組態檔中配置Hangfire的登錄賬號和密碼，
...
"Hangfire": {
"Login": "meowv",
"Password": "123456"
}
...
...
/// <summary>
/// Hangfire
/// </summary>
public static class Hangfire
{
public static string Login => _config["Hangfire:Login"];
public static string Password => _config["Hangfire:Password"];
}
...
開啟方式也很簡單，之前已經參考了Hangfire.Dashboard.BasicAuthorization這個包，直接看代碼，
app.UseHangfireDashboard(options: new DashboardOptions
{
Authorization = new[]
{
new BasicAuthAuthorizationFilter(new BasicAuthAuthorizationFilterOptions
{
RequireSsl = false,
SslRedirect = false,
LoginCaseSensitive = true,
Users = new []
{
new BasicAuthAuthorizationUser
{
Login = AppSettings.Hangfire.Login,
PasswordClear = AppSettings.Hangfire.Password
}
}
})
},
DashboardTitle = "任務調度中心"
});
app.UseHangfireDashboard()中可以自定義訪問路徑，我們這里沒有傳，就是用默認值，自定義界面的標題Title等等，更多引數可以自己看DashboardOptions，結合情況來使用，編譯運行看看效果，
現在就需要輸入我們配置的賬號密碼才可以進入Hangfire界面了，
這樣我們就集成好了Hangfire，并且還有了一個可視化的界面，接下來我們同樣實作一個簡單的定時任務看看效果，
在Jobs檔案夾添加一個介面：IBackgroundJob，讓他繼承ITransientDependency，實作依賴注入，同時定義一個方法ExecuteAsync()，
//IBackgroundJob.cs
using System.Threading.Tasks;
using Volo.Abp.DependencyInjection;
namespace Meowv.Blog.BackgroundJobs.Jobs
{
public interface IBackgroundJob : ITransientDependency
{
/// <summary>
/// 執行任務
/// </summary>
/// <returns></returns>
Task ExecuteAsync();
}
}
在Jobs檔案夾新建檔案夾Hangfire，添加HangfireTestJob.cs，繼承IBackgroundJob實作ExecuteAsync()方法，
//HangfireTestJob.cs
using System;
using System.Threading.Tasks;
namespace Meowv.Blog.BackgroundJobs.Jobs.Hangfire
{
public class HangfireTestJob : IBackgroundJob
{
public async Task ExecuteAsync()
{
Console.WriteLine("定時任務測驗");
await Task.CompletedTask;
}
}
}
這樣就完成了定時任務的邏輯，我們怎么來呼叫呢？新建一個擴展方法MeowvBlogBackgroundJobsExtensions.cs，
//MeowvBlogBackgroundJobsExtensions.cs
using Hangfire;
using Meowv.Blog.BackgroundJobs.Jobs.Hangfire;
using Microsoft.Extensions.DependencyInjection;
using System;
namespace Meowv.Blog.BackgroundJobs
{
public static class MeowvBlogBackgroundJobsExtensions
{
public static void UseHangfireTest(this IServiceProvider service)
{
var job = service.GetService<HangfireTestJob>();
RecurringJob.AddOrUpdate("定時任務測驗", () => job.ExecuteAsync(), CronType.Minute());
}
}
}
這里使用IServiceProvider決議服務，獲取到我們的實列，所以我們可以在模塊類中的OnApplicationInitialization(...)中直接呼叫此擴展方法，
RecurringJob.AddOrUpdate()是定期作業按指定的計劃觸發任務，同時還有Enqueue、Schedule、ContinueJobWith等等，可以看一下Hangfire官方檔案：https://docs.hangfire.io/en/latest/
CronType是自定義的一個靜態類，他幫我們自動生成了Cron運算式，這里表示一分鐘執行一次，關于不懂Cron的同學，可以去自學一下，也許看看下面代碼就懂了，也有許多Cron運算式在線生成的工具，
# Example of job definition:
# .---------------- minute (0 - 59)
# | .------------- hour (0 - 23)
# | | .---------- day of month (1 - 31)
# | | | .------- month (1 - 12) OR jan,feb,mar,apr ...
# | | | | .---- day of week (0 - 6) (Sunday=0 or 7) OR sun,mon,tue,wed,thu,fri,sat
# | | | | |
*/30 * * * * /bin/python /qix/spider/spider.py #每30分鐘執行一次
直接在根目錄添加MeowvBlogCronType.cs，
//MeowvBlogCronType.cs
using Hangfire;
using System;
namespace Meowv.Blog.BackgroundJobs
{
/// <summary>
/// Cron型別
/// </summary>
public static class CronType
{
/// <summary>
/// 周期性為分鐘的任務
/// </summary>
/// <param name="interval">執行周期的間隔，默認為每分鐘一次</param>
/// <returns></returns>
public static string Minute(int interval = 1)
{
return "1 0/" + interval.ToString() + " * * * ? ";
}
/// <summary>
/// 周期性為小時的任務
/// </summary>
/// <param name="minute">第幾分鐘開始，默認為第一分鐘</param>
/// <param name="interval">執行周期的間隔，默認為每小時一次</param>
/// <returns></returns>
public static string Hour(int minute = 1, int interval = 1)
{
return "1 " + minute + " 0/" + interval.ToString() + " * * ? ";
}
/// <summary>
/// 周期性為天的任務
/// </summary>
/// <param name="hour">第幾小時開始，默認從1點開始</param>
/// <param name="minute">第幾分鐘開始，默認從第1分鐘開始</param>
/// <param name="interval">執行周期的間隔，默認為每天一次</param>
/// <returns></returns>
public static string Day(int hour = 1, int minute = 1, int interval = 1)
{
return "1 " + minute.ToString() + " " + hour.ToString() + " 1/" + interval.ToString() + " * ? ";
}
/// <summary>
/// 周期性為周的任務
/// </summary>
/// <param name="dayOfWeek">星期幾開始，默認從星期一點開始</param>
/// <param name="hour">第幾小時開始，默認從1點開始</param>
/// <param name="minute">第幾分鐘開始，默認從第1分鐘開始</param>
/// <returns></returns>
public static string Week(DayOfWeek dayOfWeek = DayOfWeek.Monday, int hour = 1, int minute = 1)
{
return Cron.Weekly(dayOfWeek, hour, minute);
}
/// <summary>
/// 周期性為月的任務
/// </summary>
/// <param name="day">幾號開始，默認從一號開始</param>
/// <param name="hour">第幾小時開始，默認從1點開始</param>
/// <param name="minute">第幾分鐘開始，默認從第1分鐘開始</param>
/// <returns></returns>
public static string Month(int day = 1, int hour = 1, int minute = 1)
{
return Cron.Monthly(day, hour, minute);
}
/// <summary>
/// 周期性為年的任務
/// </summary>
/// <param name="month">幾月開始，默認從一月開始</param>
/// <param name="day">幾號開始，默認從一號開始</param>
/// <param name="hour">第幾小時開始，默認從1點開始</param>
/// <param name="minute">第幾分鐘開始，默認從第1分鐘開始</param>
/// <returns></returns>
public static string Year(int month = 1, int day = 1, int hour = 1, int minute = 1)
{
return Cron.Yearly(month, day, hour, minute);
}
}
}
接著就可以呼叫定時任務了，
//MeowvBlogBackgroundJobsModule.cs
...
public override void OnApplicationInitialization(ApplicationInitializationContext context)
{
var app = context.GetApplicationBuilder();
...
var service = context.ServiceProvider;
service.UseHangfireTest();
}
...
通過context.ServiceProvider可以獲取到IServiceProvider，然后直接呼叫擴展方法，是不是超級簡單，現在編譯運行專案看效果，
可以看到已經有一個周期性的任務躺在那，每過一分鐘都將執行一次，執行完成后如下圖，可以很清楚的知道我們的任務當前狀態，
關于任務是否真的運行成功，我們可以從輸出看出，
完美，本篇完成了Hangfire的集成，并實作了一個定時任務計劃，有沒有發現很簡單，你學會了嗎？??????
開源地址：https://github.com/Meowv/Blog/tree/blog_tutorial
轉載請註明出處，本文鏈接：https://www.uj5u.com/net/24114.html
標籤：.NET Core
上一篇：.Net Core實作區塊鏈初探
下一篇：視頻上傳遇到了些問題