ABP源码分析九：后台工作任务

文主要说明ABP中后台工作者模块（BackgroundWorker）的实现方式，和后台工作模块（BackgroundJob）。ABP通过BackgroundWorkerManager来管理BackgroundJobManager，然后通过BackgroundJobManager来管理BackgroundJob。BackgroundJob就代表一个真正的后台任务。

这两个模块是在ABPKernelModule的PostInitialize完成初始化的。

后台工作者模块

首先浏览下后台工作者模块所涉及到的接口和类。其中BackgroundJobManager属于后台工作模块。其继承自后台工作者模块中的PeriodicBackgroundWorkerBase。

逐个分析这些类和接口

IRunnable/RunnableBase: 定义了启动/终止一个任务的方法的接口和基本实现。共三个方法：start, stop, waittostop. start和stop这两个方法很容易理解，就是启动和终止一个任务。后文再解释waittostop方法。

IBackgroundWorker：没有添加任何新方法，这个接口仅用于标识其对应的实现是一个后台工作任务类，用于在后台执行一些任务。

BackgroundWorkerBase：实现IBackgroundWorker的一个抽象类，同时添加了UOW,Setting 和本地化的一些辅助方法。

IBackgroundWorkerManager/BackgroundWorkerManager: 用于管理后台工作任务 - IBackgroundWorker实例（添加IBackgroundWorker实例到管理器，启动，终止和注销后台任务）。设计一个***Manager接口和类是ABP中设计各个功能块的惯用思路，起到了对外隐藏实现细节的作用，可以认为是Facade设计模式的运用。

PeriodicBackgroundWorkerBase：通过封装AbpTimer实现定时启动执行任务的功能。这个类型定义个一个抽象方法DoWork. AbpTimer最终会定时执行这个方法。

AbpTimer是整个ABP框架实现后台工作的核心类，其实现原理就是通过一个CLR中的timer定时启动执行任务。这里有两个要点值得留意：

第一，用timer有一个弊端，就是当timer间隔时间内，任务如果没执行完，timer就会新建一个线程，从头开始执行这个任务，而上一个线程仍然继续执行，这样就会导致系统中产生的线程过多，一会儿系统的资源就耗尽了。ABP的解决思路是在执行真正的业务方法之前，通过将timer的duetime设为无限大，从而timer就失效了。业务方法执行完以后在恢复timer的设置。

第二，如何知道一个Timer真正结束了呢？也就是说如何知道一个Timer要执行的任务已经完成（这里定义为A效果），同时timer已失效(这里定义为B效果)？ABP通过stop方法实现B，通过WaitToStop实现A效果。WaitToStop会一直阻塞调用他的线程直到_performingTasks变成false,也就是说Timer要执行的任务已经完成（任务完成时会将_performingTasks设为False，并且释放锁）。

---

后台工作模块

首先浏览下涉及到的接口和类。

BackgroundJobInfo： 用于持久化job信息的实体类，对应于数据库中的表AbpBackgroundJobs。这个实体类有以下属性。一个job对应一个要执行的任务。他又两个很关键的属性JobArgs和JobType。其JobType就是接下来要介绍的IBackgroundJob实例的类型。IBackgroundJobManager最终就是根据这个JobType通过反射恢复出IBackgroundJob实例的。JobArgs就是传入IBackgroundJob实例的Execute方法的实参(这里会被序列化后在赋值给BackgroundJobInfo)。

IBackgroundJob/BackgroundJob:定义一个后台工作任务的接口/和基本实现。具体的后台任务类可从BackgroundJob继承，这是定义最终需要被执行的逻辑的地方。

IBackgroundJobConfiguration/BackgroundJobConfiguration: 配置是否激活后台工作任务功能。

BackgroundJobPriority：后台job的优先级

IBackgroundJobStore/InMemoryBackgroundJobStore: 用于持久化后台任务BackgroundJobInfo。可以实现这个接口将后台任务BackgroundJobInfo存储到数据库。或者你可以使用module-zero，它已经实现了IBackgroundJobStore。如果你正在使用第三方的工作管理者（像Hangfire），那么不需要实现IBackgroundJobStore。

IBackgroundJobManager/BackgroundJobManager, IBackgroundJobManager默认是由BackgroundJobManager实现的。它可以被其他的后台工作提供者替代（Hangfire）。 BackgroundJobManager之所以能在后台执行任务，是因为其继承了PeriodicBackgroundWorkerBase基类，并重写了DoWork方法。

BackgroundJobManager：是PeriodicBackgroundWorkerBase一个派生类，其具体实现了DoWork方法：从BackgroundJobStore（可以自定义实现从数据库中读取）取最多1000个BackgroundJobInfo，然后反射执行BackgroundJobInfo中定义的任务。

下面是一个ABP中通过BackgroundJobManager安排BackgroundJob的例子。

返回ABP源码分析系列文章目录