基於 abp vNext 和 .NET Core 開發博客項目 - 集成Hangfire實現定時任務處理

時間  2020-06-06
標籤 基於 abp vnext core 開發 博客 項目 集成 hangfire 實現 定時 任務 處理 简体版
原文   原文鏈接

上一篇文章(http://www.javashuo.com/article/p-oakdvnxb-dw.html)成功使用了Redis緩存數據，大大提升博客的響應性能。html

接下來，將完成一個任務調度中心，關於定時任務有多種處理方式，若是你的需求比較簡單，好比就是單純的過多少時間循環執行某個操做，能夠直接使用.net core中內置的實現方式，新建一個類繼承BackgroundService，實現ExecuteAsync()既可。python

看一個例子，咱們每過一秒輸出一句HelloWorld，並寫入日誌中。git

在.BackgroundJobs中新建一個Jobs文件夾，添加HelloWorldJob.cs，而且繼承自BackgroundService。github

//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>();使用，運行一下看看效果。數據庫

0

能夠看到已經成功輸出了，你能夠在ExecuteAsync()中作你的事件處理邏輯。這應該是最簡單後臺定時任務處理了，比較單一。json

在abp框架中，官方給咱們提供了許多後臺工做的集成方式，有興趣的能夠自行研究一下，文檔地址：https://docs.abp.io/zh-Hans/abp/latest/Background-Jobs緩存

在本項目中，我將使用 Hangfire 來完成定時任務處理，爲何選擇它呢？由於簡單，開箱即用。下面進入正題，能夠先將 HelloWorldJob 停掉。app

在.BackgroundJobs中添加nuget包：Volo.Abp.BackgroundJobs.HangFire、Hangfire.MySql.Core、Hangfire.Dashboard.BasicAuthorization、Volo.Abp.AspNetCore，而後添加項目引用：.Domain。框架

在根目錄新建模塊類：MeowvBlogBackgroundJobsModule.cs，繼承AbpModule，依賴AbpBackgroundJobsHangfireModule。async

//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 看看。

2

數據庫默認已經爲咱們建立了hangfire所需的表。

3

有一個地方要注意，就是在鏈接字符串中須要開啓用戶變量，修改一下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，結合狀況來使用，編譯運行看看效果。

4

如今就須要輸入咱們配置的帳號密碼才能夠進入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，而後直接調用擴展方法，是否是超級簡單，如今編譯運行項目看效果。

5

能夠看到已經有一個週期性的任務躺在那，每過一分鐘都將執行一次，執行完成後以下圖，能夠很清楚的知道咱們的任務當前狀態。

6

關於任務是否真的運行成功，咱們能夠從輸出看出。

7

完美，本篇完成了Hangfire的集成，並實現了一個定時任務計劃，有沒有發現很簡單，你學會了嗎？😁😁😁

開源地址：https://github.com/Meowv/Blog/tree/blog_tutorial

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程