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,再调用依赖注入的IBackgroundJobManagerEnqueue方法给队列添加作业。

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接口,我们还可以选择直接从BackgroundWorkerBasePeriodicBackgroundWorkerBase基类上继承。

  • 如果你从PeriodicBackgroundWorkerBase继承(如这个例子),需要实现DoWork方法来执行你的定期工作。
  • 如果你从BackgroundWorkerBase继承或直接实现IBackgroundWorker,需要重写/实现StartStopWaitToStop方法,StartStop方法应当是非阻塞的,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
来源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/438924.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

加载中_GIS地图在项目中的加载显示

下面我们就来说说如何在应用程序中加载显示GIS地图&#xff0c;首先我们在SuperMap iDesktop 9D(10i)中编辑好我们需要的地图&#xff0c;如下图所示&#xff1a;如上图所示&#xff0c;这是我编辑好的一幅天河区的地图&#xff0c;下面我就以这幅地图为例来说说如何把这样一幅…

ABP入门系列(21)——切换MySQL数据库

1. 引言 Abp支持MySql已经不是什么新鲜事了&#xff0c;但按照官方文档&#xff1a;Entity Framework - MySql Integration来&#xff0c;你未必能成功切换&#xff0c;本文就记录下切换MySql数据库遇到的一些坑&#xff0c;供后人乘凉&#xff01; 2. 环境准备 MySql数据库…

sm4 前后端 加密_sm4加密

前言项目里需要用到sm4加密&#xff0c;在这里记录一下(springboot)。依赖bouncycastleorg.bouncycastlebcmail-jdk15on1.66cn.hutoolhutool-all5.4.1代码直接贴代码&#xff0c;可以根据自己的需要封装相对应的代码逻辑。//需要注意的是&#xff0c;使用KeyGenerator生成密钥种…

ABP开发框架前后端开发系列---(1)框架的总体介绍

ABP是ASP.NET Boilerplate的简称&#xff0c;ABP是一个开源且文档友好的应用程序框架。ABP不仅仅是一个框架&#xff0c;它还提供了一个最徍实践的基于领域驱动设计(DDD)的体系结构模型。学习使用ABP框架也有一段时间了,一直想全面了解下这个框架的整个来龙去脉&#xff0c;并把…

c++ pdflib输出表格_DescrTab2包,输出SCI级别的描述统计表

今天浏览R包&#xff0c;发现一个不错的包——DescrTab2包。看R包介绍&#xff0c;这个包可以绘制出版物质量级别的描述统计表。看起来很不错。下面来学习下。1. R包安装和加载install.packages("DescrTab2") # 安装包library(DescrTab2) # 加载包2. 加载演示数据集l…

linux – syslog,rsyslog和syslog-ng之间有什么区别?

基本上,它们都是相同的,因为它们都允许在中央存储库中记录来自不同类型系统的数据. 但它们是三个不同的项目,每个项目都试图改进前一个项目,具有更高的可靠性和功能性. Syslog项目是第一个项目.它始于1980年.它是Syslog协议的根项目.此时Syslog是一个非常简单的协议.一开始它只…

python syslog 接口_python接口测试之日志功能

之前在简书中看了一篇关于日志功能的文档&#xff0c;供大家参考&#xff1a;https://www.jianshu.com/p/62f7b49b41e7Python通过logging模块提供日志功能&#xff0c;所以直接导入即可import logging1.定义日志收集器&#xff0c;指定收集器的名称&#xff0c;返回logging对象…

架构、框架和设计模式关系

在学习软件工程的时候&#xff0c;第一次接触到了架构这个概念。当初接触的时候对其的理解是非常浅薄的&#xff0c;因为那时候工程经验比较少&#xff0c;对这样一个深层次的概念还是模糊不清楚的。 随着学习的深入&#xff0c;开始接触了设计模式&#xff0c;也就是那本令我爱…

服务器怎么控制忽略样式_使用JavaScript来编写你的CSS样式代码——JSS

介绍JSS是CSS的创作工具&#xff0c;它允许你使用JavaScript以声明&#xff0c;无冲突和可重用的方式描述样式。它可以在浏览器&#xff0c;服务器端或在构建时在Node中编译。JSS与框架无关。它由多个包组成&#xff1a;核心部分&#xff0c;插件以及框架集成等。Githubhttps:/…

Java设计模式、框架、架构、平台之间的关系

1、设计模式 为什么要先说设计模式?因为设计模式在这些概念中是最基本的&#xff0c;而且也比较简单。那么什么是设计模式呢?说的直白点&#xff0c;设计模式就是告诉你针对特定问题如何组织类、对象和接口之间的关系&#xff0c;是前人总结的经验。比如我要在代码中实现一个…

csrf漏洞防御方案_CSRF原理实战及防御手段

注:本文仅供学习参考csrf定义:CSRF跨站点请求伪造(Cross—Site Request Forgery)攻击者盗用了你的身份&#xff0c;以你的名义发送恶意请求&#xff0c;对服务器来说这个请求是完全合法的&#xff0c;但是却完成了攻击者所期望的一个操作&#xff0c;比如以你的名义发送邮件、发…

如何学习(记住)linux命令(常用选项)

作者&#xff1a;林果皞 链接&#xff1a;https://www.zhihu.com/question/21690166/answer/66721478 来源&#xff1a;知乎 著作权归作者所有。商业转载请联系作者获得授权&#xff0c;非商业转载请注明出处。 Unix & Linux 命令行特别之处在于&#xff0c;一些选项的设…

python 3.8 新特性 video_1分钟了解:Python3.8 新特性:仅位置参数

这是Python3.8新特性的第二篇&#xff0c;第一篇介绍了赋值表达式&#xff0c;这篇文章花几分钟了解什么是仅位置参数(Positional-Only Arguments)插播一条&#xff1a;我自己是一名从事了多年开发的Python老程序员&#xff0c;辞职目前在做自己的Python私人定制课程&#xff0…

增效工具_【危中寻机】降本增效生存之道 运用IE基础工具提升制造效率

效率提升的利器工业工程IE作为一门学科诞生于美国&#xff0c;却首先在日本得到了最大程度的践行与推广&#xff0c;成为了丰田生产方式TPS及精益制造LP的核心现场IE中的4大核心(工程分析、动作分析、时间分析、布局分析)仍是所有IE的入门工具&#xff0c;被笔者称为“基础IE”…

linux之fstab文件详解

/etc/fstab是用来存放文件系统的静态信息的文件。位于/etc/目录下&#xff0c;可以用命令less /etc/fstab 来查看&#xff0c;如果要修改的话&#xff0c;则用命令 vi /etc/fstab 来修改。 当系统启动的时候&#xff0c;系统会自动地从这个文件读取信息&#xff0c;并且…

python写空气质量提醒_Python数据可视化:2018年空气质量分析

就在本周,我碰巧看到一个学生抱怨天津的空气,我不禁思考的日子他是如此善良的和完善的。没有真相,就无图下面的图片证据。左边的图片是去年2月份。这样的空气真是少见!右边的是Tucao和我第一次买一个口罩!!!面具是好的,因为在那个时候,我用来运行的两个校园课程设计。基本上,我…

Linux日志安全分析技巧

0x00 前言 我正在整理一个项目&#xff0c;收集和汇总了一些应急响应案例&#xff08;不断更新中&#xff09;。 GitHub 地址&#xff1a;https://github.com/Bypass007/Emergency-Response-Notes 本文主要介绍Linux日志分析的技巧&#xff0c;更多详细信息请访问Github地址…

as将安卓应用打包_Android Studio打包生成apk的方法(超级简单哦)

释放双眼&#xff0c;带上耳机&#xff0c;听听看~&#xff01;打包文件是需要生成APK文件&#xff0c;其他人可以通过APK安装和使用&#xff0c;一般来说&#xff0c;包是指APK生成的发布版本&#xff0c;下文技术狗小编还介绍了Android Studio 超级简单的打包生成apk的方法&a…

Linux系统安全日志详解

日志对于安全来说&#xff0c;非常重要&#xff0c;他记录了系统每天发生的各种各样的事情&#xff0c;你可以通过他来检查错误发生的原因&#xff0c;或者受到攻击时攻击者留下的痕迹。日志主要的功能有&#xff1a;审计和监测。他还可以实时的监测系统状态&#xff0c;监测和…

帆软单点登录_电子表格FineReport教程:[20]CAS单点登录

若报表应用设置了权限&#xff0c;则需要将如下代码&#xff1a;package com.fr;import java.io.IOException;import java.io.PrintStream;import javax.servlet.Filter;import javax.servlet.FilterChain;import javax.servlet.FilterConfig;import javax.servlet.ServletExce…