ABP入门系列（20）——使用后台作业和工作者
1.引言
說到后臺作業，你可能條件反射的想到BackgroundWorker，但后臺作業并非是后臺任務，后臺作業用一種隊列且持久穩固的方式安排一些待執行后臺任務。
- 為執行長時間運行的任務而用戶無需等待，以提高用戶體驗。
- 為創建可重試且持久穩固的任務來保證一個代碼將會被成功運行，以提高系統的穩定性。
那什么又是后臺工作者呢？
后臺工作者則是簡單運行在應用程序后臺的獨立線程，它用于定期執行一些任務。
- 一個后臺工作者可以定期清除臨時表、重建索引。
- 一個后臺工作者可以定期清除日志。
2. 實現機制
后臺作業
后臺作業的實現機制
后臺作業的核心接口為IBackgroundJobManager。Abp對其提供了默認實現BackgroundJobManager，當然我們也可以選擇已經集成的其它后臺作業提供器替代（比如HangFire、Quartz）。以下是它的實現機制：
- 它是一個簡單的作業隊列，以FIFO（先進先出）方式單線程作業，它使用IBackgroundJobStore來持久化作業，Abp默認使用InMemoryBackgroundJobStore在內存中持久化后臺作業，我們也可使用Module-Zero實現的BackgroundJobStore將后臺作業持久化到數據庫。
- 它一直重試作業執行直到作業成功運行（只記錄日志不拋出異常）或超時（默認超時期限為2天）。
- 在作業成功運行后，它從存儲（數據庫）里刪除這個作業，如果超時了，就把這個作業設置為“被拋棄的”，后續將不再處理。
- 重試時間逐漸遞增，第一次重試，等待1分鐘，第二次重試，等待2分鐘，第三次重試，等待4分鐘，如此類推。
- 后臺作業是在固定的間隔按優先級（升序）排序，然后再按重試次數排序（升序）。
后臺工作者
后臺工作者的實現機制
后臺工作者是運行在應用程序后臺定期執行任務的。 Abp提供了IBackgroundWorkerManager接口，默認使用的是定時器Timer來實現定期執行任務的。當應用關閉時，IBackgroundWorkerManager將停止并釋放所有已注冊的工作者。
3.使用后臺作業
管理員負責任務的進度跟蹤，當打開任務列表時，可以發送通知提醒未完成任務的用戶。
3.1. 定義后臺作業參數
后臺作業的參數主要用于參數傳遞，因為后臺作業需要提供重試機制，所以我們應該保存參數信息，而最好的辦法就是直接序列化和反序列化來使用。另外我們應該保持參數的簡單，避免直接使用實體或其他非序列化對象。
?
[Serializable] public class SendNotificationJobArgs {public long TargetUserId { get; set; }public string NotificationTitle { get; set; }public MessageNotificationData NotificationData { get; set; }public NotificationSeverity NotificationSeverity { get; set; } }3.2. 定義作業
繼承BackgroundJob<TArgs>類或直接實現IBackgroundJob<TArgs>接口來創建一個后臺作業。
?
public class SendNotificationJob : BackgroundJob<SendNotificationJobArgs>, ITransientDependency {private readonly IRepository<User,long> _userRepository;private readonly INotificationPublisher _notificationPublisher;public SendNotificationJob(IRepository<User, long> userRepository, INotificationPublisher notificationPublisher){_userRepository = userRepository;_notificationPublisher = notificationPublisher;}public override void Execute(SendNotificationJobArgs args){var targetUser = _userRepository.Get(args.TargetUserId);_notificationPublisher.Publish(args.NotificationTitle, args.NotificationData, null,args.NotificationSeverity, new[] {targetUser.ToUserIdentifier()});} }可以看到我們使用依賴注入注入了IRepository<User,long>和INotificationPublisher。其中僅需實現Execute方法來定義后臺作業的邏輯。
3.3.定義應用服務
為了方便調用，定義一個發送通知的應用服務：
?
public interface INotificationAppService : IApplicationService {void NotificationUsersWhoHaveOpenTask(); } public class NotificationAppService : LearningMpaAbpAppServiceBase, INotificationAppService {private readonly IRepository<Task> _taskRepository;private readonly IBackgroundJobManager _backgroundJobManager;public NotificationAppService(IRepository<Task> taskRepository, IBackgroundJobManager backgroundJobManager){_taskRepository = taskRepository;_backgroundJobManager = backgroundJobManager;}public void NotificationUsersWhoHaveOpenTask(){var openTasks = _taskRepository.GetAll().Where(t => t.State == TaskState.Open);foreach (var openTask in openTasks){var sendNotificationArgs = new SendNotificationJobArgs(){NotificationTitle = "You have an open task",NotificationSeverity = NotificationSeverity.Info,NotificationData = new MessageNotificationData(openTask.Title),TargetUserId = openTask.AssignedPersonId.Value};_backgroundJobManager.Enqueue<SendNotificationJob, SendNotificationJobArgs>(sendNotificationArgs);}} }我們通過獲取所有未完成的任務，然后循環遍歷構造發送通知參數SendNotificationJobArgs，再調用依賴注入的IBackgroundJobManager的Enqueue方法給隊列添加作業。
3.4. 測試效果
我們在任務清單列表上添加一個按鈕來觸發后臺作業，實現效果如下圖：
后臺作業通知效果
3.5. 持久化后臺作業到數據庫
上面我們也說明了Abp定義了IBackgroundJobStore來持久化后臺作業，Abp默認使用InMemoryBackgroundJobStore在內存中持久化后臺作業。
我們看下源碼就明白了：
?
//AbpKernelModule.cs //默認注入的是 InMemoryBackgroundJobStoreif (Configuration.BackgroundJobs.IsJobExecutionEnabled){IocManager.RegisterIfNot<IBackgroundJobStore, InMemoryBackgroundJobStore>(DependencyLifeStyle.Singleton);}else{IocManager.RegisterIfNot<IBackgroundJobStore, NullBackgroundJobStore>(DependencyLifeStyle.Singleton);}我們可以使用Module-Zero實現的BackgroundJobStore將后臺作業持久化到數據庫。定位到應用服務層，修改應用服務層的module，將BackgroundJobStore注冊到依賴注入容器即可：
?
//LearningMpaAbpApplicationModule.cs public override void PreInitialize() {//使用module-zero實現的后臺作業存儲持久化后臺作業到數據庫IocManager.Register<IBackgroundJobStore,BackgroundJobStore>(); }再執行后臺作業，就可以從數據庫表AbpBackgroundJobs中查詢到所有未完成的作業。
保存到數據庫的后臺作業
?
其中JobArgs就是存儲的序列化的后臺作業參數：
{"TargetUserId":4,"NotificationTitle":"You have an open task","NotificationData":{"Message":"使用Abp框架搭建Mpa網站","Type":"Abp.Notifications.MessageNotificationData","Properties":{"Message":"使用Abp框架搭建Mpa網站"}},"NotificationSeverity":0}
4. 使用后臺工作者
將超過30天未登錄的用戶設置為“消極”的。
4.1. 創建后臺工作者
為創建一個后臺工作者，我們應當實現IBackgroundWorker接口，我們還可以選擇直接從BackgroundWorkerBase或PeriodicBackgroundWorkerBase基類上繼承。
- 如果你從PeriodicBackgroundWorkerBase繼承（如這個例子），需要實現DoWork方法來執行你的定期工作。
- 如果你從BackgroundWorkerBase繼承或直接實現IBackgroundWorker，需要重寫/實現Start、Stop和WaitToStop方法，Start和Stop方法應當是非阻塞的，WaitToStop方法需要等待工作者完成它當前的工作。
?
public class MakeInactiveUsersPassiveWorker : PeriodicBackgroundWorkerBase, ISingletonDependency {private readonly IRepository<User, long> _userRepository;public MakeInactiveUsersPassiveWorker(AbpTimer timer, IRepository<User, long> userRepository): base(timer){_userRepository = userRepository;Timer.Period = 5000; //5 seconds (good for tests, but normally will be more)}[UnitOfWork]protected override void DoWork(){using (CurrentUnitOfWork.DisableFilter(AbpDataFilters.MayHaveTenant)){var oneMonthAgo = Clock.Now.Subtract(TimeSpan.FromDays(30));var inactiveUsers = _userRepository.GetAllList(u =>u.IsActive &&((u.LastLoginTime < oneMonthAgo && u.LastLoginTime != null) || (u.CreationTime < oneMonthAgo && u.LastLoginTime == null)));foreach (var inactiveUser in inactiveUsers){inactiveUser.IsActive = false;Logger.Info(inactiveUser + " made passive since he/she did not login in last 30 days.");}CurrentUnitOfWork.SaveChanges();}} }4.2.注冊后臺工作者
在完成創建后臺工作者后，需要把它添加到IBackgroundWorkerManager，通常在模塊的PostInitialize方法里注冊即可，但不是一定要這樣，你可以在任何地方注入IBackgroundWorkerManager，然后在運行時添加工作者。
?
//LearningMpaAbpApplicationModule.cspublic override void PostInitialize(){//注冊后臺工作者標記消極用戶var workManager = IocManager.Resolve<IBackgroundWorkerManager>();workManager.Add(IocManager.Resolve<MakeInactiveUsersPassiveWorker>());}5.最后
后臺作業和工作者正常工作的前提是你的應用保持運行。但一個Web應用長時間沒有收到訪問請求，它默認地會被關閉，所以，如果你的宿主后臺作業運行在你的web應用里（這是默認行為），你應當確保你的web應用被配置成一直運行。
而如何做到這點呢，一個非常簡單的辦法是：從一個外部應用里定期訪問你的Web應用，從而你可以一直檢查你的web應用是否一直運行著。
參考資料：
Background Jobs and Workers
作者：圣杰
鏈接：https://www.jianshu.com/p/d20027bd76d5
來源：簡書
著作權歸作者所有。商業轉載請聯系作者獲得授權，非商業轉載請注明出處。
總結
以上是生活随笔為你收集整理的ABP入门系列（20）——使用后台作业和工作者的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 大额信用卡有什么好处
- 下一篇： 申请信用卡怎么快速下卡