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

来源:https://www.cnblogs.com/meowv/archive/2020/05/27/12961014.html
-Advertisement-
Play Games

上一篇文章(https://www.cnblogs.com/meowv/p/12956696.html)成功使用了Redis緩存數據，大大提高博客的響應性能。 接下來，將完成一個任務調度中心，關於定時任務有多種處理方式，如果你的需求比較簡單，比如就是單純的過多少時間迴圈執行某個操作，可以直接使用.n ...


上一篇文章(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>();使用，運行一下看看效果。

0

可以看到已經成功輸出了，你可以在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 看看。

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的集成，並實現了一個定時任務計劃，有沒有發現很簡單，你學會了嗎？

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 【視頻】工業互聯網線上交流現狀、發展、怎麼建和規劃
    PPT介紹目錄： 工業互聯網的現狀 平臺介紹 技術路線 人力資源 現實問題 成本中心 工業互聯網的發展 兩大推動引擎 用戶需求的改變 片面與極端 由點到面，點面結合 突破點 現實路徑 落腳點 工業互聯網怎麼建 一句話表示-方法論 怎麼成功 體系理念 工業互聯網未來的規劃 iNeuOS介紹 文章： 《 ...
  • ispostback之坑
    IsPostBack:獲取一個值，該值指示頁是第一次呈現還是為了響應回發而載入。 一般的話如果第一次請求是get的話，那麼IsPostBack會為false，如果接下來post請求，則為true；這樣可以區分第一次和其他按鈕請求的情況。 但今天使用jQuery在主頁面的一個超鏈接post調用子頁面的 ...
  • .Net 提交頁面，js修改的Label值會丟掉
    .Net 提交頁面，js修改的Label值會丟掉 版權聲明：本文為博主原創文章，遵循 CC 4.0 BY-SA 版權協議，轉載請附上原文出處鏈接和本聲明。 本文鏈接：https://blog.csdn.net/chenghaibing2008/article/details/9011043 當用js ...
  • C#實現密文解密
    C#實現密文解密 簡介：此方法一般用於對密碼加密後的解密。 代碼： private static string GetPwd(string pwd) { var sRet = string.Empty; for (int i = 0; i < pwd.Length; i++) { sRet = sR ...
  • EF Core 執行SQL語句和存儲過程
    無論ORM有多麼強大，總會出現一些特殊的情況，它無法滿足我們的要求。在這篇文章中，我們介紹幾種執行SQL的方法。 表結構 在具體內容開始之前，我們先簡單說明一下要使用的表結構。 public class Category { public int CategoryID { get; set; } p ...
  • 【半譯】擴展shutdown超時設置以保證IHostedService正常關閉
    我最近發現一個問題，當應用程式關閉時，我們的應用程式沒有正確執行在IHostedService中的StopAsync方法。經過反覆驗證發現，這是由於某些服務對關閉信號做出響應所需的時間太長導致的。在這篇文章中，我將展示出現這個問題的一個示例，並且會討論它為什麼會發生以及如何避免這種情況出現。 作者： ...
  • C# 數據操作系列 - 17 Dapper ——號稱可以與ADO.NET 同台飆車的ORM
    0. 前言 之前四篇介紹了一個國內開發者開發的優秀框架SqlSugar，給我們眼前一亮的感覺。這一篇，我們將試試另一個出鏡率比較高的ORM框架-Dapper。 Dapper是一個輕量級的ORM框架，其以高速、簡單易用為特點。在某些時候，效率甚至可以與ADO.NET 媲美。那麼，吹得天花亂墜，就讓我們 ...
  • [UWP]使用離散式關鍵幀播放動畫
    這篇文章介紹離散式關鍵幀，並使用它做些有趣的動畫。 1. 什麼是離散式關鍵幀 以DoubleAnimationUsingKeyFrames為例，它支持四種Double的關鍵幀，其中EasingDoubleKeyFrame、LinearDoubleKeyFrame和SplineDoubleKeyFra ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類