Elastic-Job
一、主要功能
- 定时任务：基于成熟的定时任务作业框架Quartz cron表达式执行定时任务。
- 作业注册中心：基于Zookeeper和其客户端Curator实现的全局作业注册控制中心。用于注册，控制和协调分布式作业执行。
- 作业分片：将一个任务分片成为多个小任务项在多服务器上同时执行。
- 弹性扩容缩容：运行中的作业服务器崩溃，或新增加n台作业服务器，作业框架将在下次作业执行前重新分片，不影响当前作业执行。
- 支持多种作业执行模式：支持OneOff，Perpetual和SequencePerpetual三种作业模式。
- 失效转移：运行中的作业服务器崩溃不会导致重新分片，只会在下次作业启动时分片。启用失效转移功能可以在本次作业执行过程中，监测其他作业服务器空闲，抓取未完成的孤儿分片项执行。
- 运行时状态收集：监控作业运行时状态，统计最近一段时间处理的数据成功和失败数量，记录作业上次运行开始时间，结束时间和下次运行时间。
- 作业停止；恢复；禁用：用于操作作业启停，并可以禁止某作业运行（上线时常用）。
- 被错过执行的作业重触发：自动记录错过执行的作业，并在上次作业完成后自动触发。可参考Quartz的misfire。
- 多线程快速处理数据：使用多线程处理抓取到的数据，提升吞吐量。
- 幂等性：重复作业任务项判定，不重复执行已运行的作业任务项。由于开启幂等性需要监听作业运行状态，对瞬时反复运行的作业对性能有较大影响。
- 容错处理：作业服务器与Zookeeper服务器通信失败则立即停止作业运行，防止作业注册中心将失效的分片分项配给其他作业服务器，而当前作业服务器仍在执行任务，导致重复执行。
- Spring支持：支持spring容器，自定义命名空间，支持占位符。
- 运维平台：提供运维界面，可以管理作业和注册中心。
二、结构
- elastic-job-core：elastic-job核心模块，只通过Quartz和Curator就可执行分布式作业。
- elastic-job-spring：elastic-job对spring支持的模块，包括命名空间，依赖注入，占位符等。
- elastic-job-console：elastic-job web控制台，可将编译之后的war放入tomcat等servlet容器中使用。
- elastic-job-example：使用例子。
- elastic-job-test：测试elastic-job使用的公用类，使用方无需关注。
三、maven依赖
com.dangdang
elastic-job-core
1.0.1
com.dangdang
elastic-job-spring
1.0.1
四、代码开发
提供3种作业类型，分别是OneOff, Perpetual和SequencePerpetual。需要继承相应的抽象类。
方法参数shardingContext包含作业配置，分片和运行时信息。可通过getShardingTotalCount(),getShardingItems()等方法分别获取分片总数，运行在本作业服务器的分片序列号集合等。
- OneOff类型作业
OneOff作业类型比较简单，需要继承AbstractOneOffElasticJob，该类只提供了一个方法用于覆盖，此方法将被定时执行。用于执行普通的定时任务，与Quartz原生接口相似，只是增加了弹性扩缩容和分片等功能。
public class MyElasticJob extends AbstractOneOffElasticJob {
@Override
protected void process(JobExecutionMultipleShardingContext context) {
// do something by sharding items
}
}
- Perpetual类型作业
Perpetual作业类型略为复杂，需要继承AbstractPerpetualElasticJob并可以指定返回值泛型，该类提供两个方法可覆盖，分别用于抓取和处理数据。可以获取数据处理成功失败次数等辅助监控信息。需要注意fetchData方法的返回值只有为null或长度为空时，作业才会停止执行，否则作业会一直运行下去。这点是参照TbSchedule的设计。Perpetual作业类型更适用于流式不间歇的数据处理。
作业执行时会将fetchData的数据传递给processData处理，其中processData得到的数据是通过多线程（线程池大小可配）拆分的。建议processData处理数据后，更新其状态，避免fetchData再次抓取到，从而使得作业永远不会停止。processData的返回值用于表示数据是否处理成功，抛出异常或者返回false将会在统计信息中归入失败次数，返回true则归入成功次数。
public class MyElasticJob extends AbstractPerpetualElasticJob {
@Override
protected List fetchData(JobExecutionMultipleShardingContext context) {
List result = // get data from database by sharding items
return result;
}
@Override
protected boolean processData(JobExecutionMultipleShardingContext context, Foo data) {
// process data
return true;
}
}
- SequencePerpetual类型作业
SequencePerpetual作业类型和Perpetual作业类型极为相似，所不同的是Perpetual作业类型可以将获取到的数据多线程处理，但不会保证多线程处理数据的顺序。如：从2个分片共获取到100条数据，第1个分片40条，第2个分片60条，配置为两个线程处理，则第1个线程处理前50条数据，第2个线程处理后50条数据，无视分片项；SequencePerpetual类型作业则根据当前服务器所分配的分片项数量进行多线程处理，每个分片项使用同一线程处理，防止了同一分片的数据被多线程处理，从而导致的顺序问题。如：从2个分片共获取到100条数据，第1个分片40条，第2个分片60条，则系统自动分配两个线程处理，第1个线程处理第1个分片的40条数据，第2个线程处理第2个分片的60条数据。由于Perpetual作业可以使用多余分片项的任意线程数处理，所以性能调优的可能会优于SequencePerpetual作业。
public class MyElasticJob extends AbstractSequencePerpetualElasticJob {
@Override
protected List fetchData(JobExecutionSingleShardingContext context) {
List result = // get data from database by sharding items
return result;
}
@Override
protected boolean processData(JobExecutionSingleShardingContext context, Foo data) {
// process data
return true;
}
}
五、配置
Elastic-Job官方提供了基于Spring和Java代码注解2种方式的任务配置。
- spring xml配置
这种方式能够很直观的看到所有的任务信息，结构比较清晰。但是要配置xml文件，项目整体看起来臃肿。
- java代码注解
1 增加elastic-job-spring-boot-starter的Maven依赖
2 增加Zookeeper注册中心的配置
3 开启Elastic-Job自动配置：只需要在Spring Boot的启动类上增加@EnableElasticJob注解
4 配置任务：ElasticJobConf
com.cxytiandi
elastic-job-spring-boot-starter
1.0.0
elasticJob.zk.serverLists=192.168.10.47:2181
elasticJob.zk.namespace=cxytiandi_job2
package com.cxytiandi.elasticjob.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.stereotype.Component;
/**
* ElasticJob 注解配置类
*
* 任务的配置只需要在Job类上加上此注解即可
*
* @author yinjihuan
*
* @about http://cxytiandi.com/about
*
*/
@Component
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface ElasticJobConf {
/*********************DataflowJobConfiguration START********************/
/**
* 作业名称
* @return
*/
String name();
/**
* cron表达式，用于控制作业触发时间
* @return
*/
String cron() default "";
/**
* 作业分片总数
* @return
*/
int shardingTotalCount() default 1;
/**
* 分片序列号和参数用等号分隔，多个键值对用逗号分隔
*
分片序列号从0开始，不可大于或等于作业分片总数
*
如：
*
0=a,1=b,2=c
* @return
*/
String shardingItemParameters() default "";
/**
* 作业自定义参数
*
作业自定义参数，可通过传递该参数为作业调度的业务方法传参，用于实现带参数的作业
*
例：每次获取的数据量、作业实例从数据库读取的主键等
* @return
*/
String jobParameter() default "";
/**
* 是否开启任务执行失效转移，开启表示如果作业在一次任务执行中途宕机，允许将该次未完成的任务在另一作业节点上补偿执行
* @return
*/
boolean failover() default false;
/**
* 是否开启错过任务重新执行
* @return
*/
boolean misfire() default false;
/**
* 作业描述信息
* @return
*/
String description() default "";
boolean overwrite() default false;
/*********************DataflowJobConfiguration END********************/
/*********************DataflowJobConfiguration START********************/
/**
* 是否流式处理数据
*
如果流式处理数据, 则fetchData不返回空结果将持续执行作业
*
如果非流式处理数据, 则处理数据完成后作业结束
* @return
*/
boolean streamingProcess() default false;
/*********************DataflowJobConfiguration END********************/
/*********************ScriptJobConfiguration START********************/
/**
* 脚本型作业执行命令行
* @return
*/
String scriptCommandLine() default "";
/*********************ScriptJobConfiguration END********************/
/*********************LiteJobConfiguration START********************/
/**
* 监控作业运行时状态
*
每次作业执行时间和间隔时间均非常短的情况，建议不监控作业运行时状态以提升效率。
*
因为是瞬时状态，所以无必要监控。请用户自行增加数据堆积监控。并且不能保证数据重复选取，应在作业中实现幂等性。
*
每次作业执行时间和间隔时间均较长的情况，建议监控作业运行时状态，可保证数据不会重复选取。
* @return
*/
boolean monitorExecution() default true;
/**
* 作业监控端口
*
建议配置作业监控端口, 方便开发者dump作业信息。
*
使用方法: echo “dump” | nc 127.0.0.1 9888
* @return
*/
int monitorPort() default -1;
/**
* 大允许的本机与注册中心的时间误差秒数
*
如果时间误差超过配置秒数则作业启动时将抛异常
*
配置为-1表示不校验时间误差
* @return
*/
int maxTimeDiffSeconds() default -1;
/**
* 作业分片策略实现类全路径,默认使用平均分配策略
* @return
*/
String jobShardingStrategyClass() default "";
/**
* 修复作业服务器不一致状态服务调度间隔时间，配置为小于1的任意值表示不执行修复,单位：分钟
* @return
*/
int reconcileIntervalMinutes() default 10;
/**
* 作业事件追踪的数据源Bean引用
* @return
*/
String eventTraceRdbDataSource() default "";
/*********************LiteJobConfiguration END********************/
/**
* 前置后置任务监听实现类，需实现ElasticJobListener接口
* @return
*/
String listener() default "";
/**
* 作业是否禁止启动,可用于部署作业时，先禁止启动，部署结束后统一启动
* @return
*/
boolean disabled() default false;
/**
* 前置后置任务分布式监听实现类，需继承AbstractDistributeOnceElasticJobListener类
* @return
*/
String distributedListener() default "";
/**
* 最后一个作业执行前的执行方法的超时时间,单位：毫秒
* @return
*/
long startedTimeoutMilliseconds() default Long.MAX_VALUE;
/**
* 最后一个作业执行后的执行方法的超时时间,单位：毫秒
* @return
*/
long completedTimeoutMilliseconds() default Long.MAX_VALUE;
/**
* 自定义异常处理类
* @return
*/
String jobExceptionHandler() default "com.dangdang.ddframe.job.executor.handler.impl.DefaultJobExceptionHandler";
/**
* 自定义业务处理线程池
* @return
*/
String executorServiceHandler() default "com.dangdang.ddframe.job.executor.handler.impl.DefaultExecutorServiceHandler";
}
六、使用限制
- 作业一旦启动成功后不能修改作业名称，如果修改名称则视为新的作业。
- 同一台作业服务器只能运行一个相同的作业实例，因为作业运行时是按照IP注册和管理的。
- 作业根据/etc/hosts文件获取IP地址，如果获取的IP地址是127.0.0.1而非真实IP地址，应正确配置此文件。
- 一旦有服务器波动，或者修改分片项，将会触发重新分片；触发重新分片将会导致运行中的Perpetual以及SequencePerpetual作业在执行完本次作业后不再继续执行，等待分片结束后再恢复正常。
- 开启monitorExecution才能实现分布式作业幂等性（即不会在多个作业服务器运行同一个分片）的功能，但monitorExecution对短时间内执行的作业（如每5秒一触发）性能影响较大，建议关闭并自行实现幂等性。
- elastic-job没有自动删除作业服务器的功能，因为无法区分是服务器崩溃还是正常下线。所以如果要下线服务器，需要手工删除zookeeper中相关的服务器节点。由于直接删除服务器节点风险较大，暂时不考虑在运维平台增加此功能。
七、实现原理
- 第一台服务器上线触发主服务器选举。主服务器一旦下线，则重新触发选举，选举过程中阻塞，只有主服务器选举完成，才会执行其他任务。
- 某作业服务器上线时会自动将服务器信息注册到注册中心，下线时会自动更新服务器状态。
- 主节点选举，服务器上下线，分片总数变更均更新重新分片标记。
- 定时任务触发时，如需重新分片，则通过主服务器分片，分片过程中阻塞，分片结束后才可执行任务。如分片过程中主服务器下线，则先选举主服务器，再分片。
- 通过4可知，为了维持作业运行时的稳定性，运行过程中只会标记分片状态，不会重新分片。分片仅可能发生在下次任务触发前。
- 每次分片都会按服务器IP排序，保证分片结果不会产生较大波动。
- 实现失效转移功能，在某台服务器执行完毕后主动抓取未分配的分片，并且在某台服务器下线后主动寻找可用的服务器执行任务。
八、流程图
作业启动
作业执行
