开源定时任务XXL-JOB安装与使用(ORACLE版和MYSQL版本) + 微服务模式

介绍

XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。


主要特性

  • 1、简单:支持通过Web页面对任r . ` ` N g A H X务进行CRUD操作,操作简单,a 0 E一分钟上手;
  • 2、动态:支持动态修改任务状态、启动/停止任务,以及终止^ q s 1运行中任务,即时生效;
  • 3、调度中心HA(中心式):调度采用中心式设计,“调度中心”自研调度组件并支持U Q : U集群部署,可保证调度中心HA;
  • 4、执行器HA(分布式):任务分布式执行,任务"执行器"支b y J持集群部署,可保证任务执行HA;
  • 5、注册中心: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时g 3 a f,也支持手动录入执行器地址4 ` w ) % & [ T
  • 6、弹性3 ? R ] F扩容缩容:一旦有新执行器机器上线或者下线,下次调度时将会重新分配任务;
  • 7、路由策略:执行器集群部署时提供丰富的路由策略,包括:第一个、最后一个、轮询、随机、一致性HASH、最不经常使用、最近最久未使用、故障转移、忙碌转移等;
  • 8、故障转移S D ]:任务路由策略选择"故l u V 0 H障转移"情况下,如果执行器集[ y g v群中某一台机器故障,将会自动Failover切换到一台v 3 3正常的执行器发送调度请求。
  • 9、阻塞L y r y o x 8 a ^处理策略:调度过于密集执行器来不及处理时的处理策略,策略包括:单机串行(默认)、丢弃后续调度、覆盖之前调度;
  • 10、任务超时控制:支持自定义任务超时时间,任务运行超时将会主动中断任务;
  • 11、任% 9 G务失败重试:支持自定义i c ;任务失败重试次数,当任务失败时将会按照预设的失败重试次数主动进行重试;其中分片任务支持分片粒度的失败重试;
  • 12、任务失败告警;默认提k / , B供邮件方式失败告警,同时预留扩展接口,可方便的扩展短信、钉钉等告警方式;
  • 13、分片广播任务:执行器C ` { J k集群部署时,任务路由策略选择"分片广播"情况下,一次任务调度将会广播7 Y % # u触发集群中所有执行器执行一次D / b N K ] ]任务,可根据分% 7 $ R U ? B片参数3 3 R % 9 ` H开发分片任务;
  • 14、动态分片:分片广播任务以执行器为维度进行分片,支持动态扩3 I R h o | A容执行器集群从而动态增加分片数量,协同进行业务处理;在进行大数据量业务操作时可显著提c ^ !升任务处理能力和速度。
  • 15、事件触发:除了"Cron方式"和"任务依赖方式"触发任务执行之外,支持基于事件的触发任务方式。调度中心提供触发任务单次执行的API服务,可根据业务事件灵活触发。
  • 16、任务进度监控:支持实时监控任务进度;
  • 17、Rolling实时日志:支持在线查看调度结果,并且支持以Rolling方式实时查看执行器输出的完整的执行日志;
  • 18、G9 + ! C C Z u ALUE:提供Web IDE,支持在线开发任务逻辑代码,动态发布,实时D & f l d编译生效,省略部署上线的过程。u y Q n l r 8 y支持30个版本的历史版本回溯。
  • 19、脚本任务:支持以GLUE模式开发和运行脚本任务,包括Shell、PythonW N T N -、NodeJS、PHP、Pom A Z f a YwerShell等类型脚本;
  • 20、命令行任务:原生提供通用命f J _ X B z 3令行任务Handler(Bean任务,"CommandJobHandler");业务方只需要提供命令行即可;
  • 21、任务依赖:支持配置子任务依赖,当父任务执行结束且执行成功后将会主动触发一次子任务的执行, 多个子任务用逗号分隔;
  • 22、一致性:“调度中心”通过DB锁保证集群分布式调度的一致性, 一次任务调度只会触O 3 | $ b G !发一次执行;
  • 23、自定义任务参数:支持在线配置调度任务入参,即时生效;
  • 24、调度线程池:调度系统多线程触发调度; h ? |运行,确保调度精确执行,不被堵塞;
  • 25、数据加密:调度中心和执行器之间的通讯进行数据加密,提升调度信息安全性;
  • 26、邮件报警:任务失败时支持邮件报警,支持配置多邮件地址群发报警邮件;
  • 27、推送maven中d 6 j +央仓库: 将会把最新稳定版推送到maven中央仓库, 方便用户接入和使用;
  • 28、运行报表:支持实时查看运行数据,如任务数量、调度次数、执行器数量等;以及调度报表,如调度日期分布图,调度成功分布图等;
  • 29、全异步:任务调度流程全异步化设计实现,如异步调度、异步运行、异步回调等,有效对密集调度进行流量削峰,理论上支持任意时长任务的运行;
  • 30、跨语言:调度中心与执行器提供语言无关的 RESTful API 服务D $ , Y,第三方任意语言可据此对接调度中心或者实现执行器。除此之外,还提供了 “多任务模式”和“httpJobHandler”等其他跨语言方案;
  • 31、国际化m - + M A X x:调度中心支持国际化设置,提c A I # z _ e % 0供中文、O u ~英文两种可选语言,默认为中文;
  • 32、容器化:提供官方docker镜像,并实时更新推送dockerhub,进一步实现产品开箱即用;
  • 33、线程池隔离:调度线程池进行隔离( 9 H 2 j 0 i拆分,慢任务自动降级进入"Slow"线程池,避免耗尽调度线程,提高系统稳定性;
  • 34、用户管理:支持在线管理系统用户,_ s $ D ` w存在管理员、普通用户两种角色;
  • 35、权限控制:执行器h 8 n % # & B维度进行权限控制,管理员拥有全量权限,` g H O N普通用户需要分配执行器权限后才允许相@ @ I S Q , + : ~关操作;

项目地址(里面都有相应的建表语句)

  • github mysql
  • github oracle

下载O , ?与安装(以下以ORACLE版本为例)

  • 第一种方式:

    git clone https://github.com/NopSmile/xxl-job-oracle-2.1.0
  • 第二种方式:
    开源定时任务XXL-JOB安装与使用(ORACLE版和MYSQL版本) + 微服务模式

下载好后,通过idea编译;
开源定时任务XXL-JOB安装与使用(ORACLE版和MYSQL版本) + 微服务模式

  1. 是对应的数据库建表语句
  2. 任务调度管理系统u E 9 , S ~ Q l
  3. 执行器的核心依赖包
  4. 执行器的例子

创建数据库表

将 db目录下的sql 执行到数据库中,会生成7张表。
开源定时任务XXL-JOB安装与使用(ORACLE版和MYSQL版本) + 微服务模式


修改数据库配置

修改路径为:src/main! j C U 0 8 b [ 4/resources/application.$ C x Uprod K T u B J @ R +perties 并填写自己的数据相关信息

开源定时任务XXL-JOB安装与使用(ORACLE版和MYSQL版本) + 微服务模式

选填项(预警邮箱)

开源定时任务XXL-JOB安装与使用(ORACLE版和MYSQL版本) + 微服务模式


启动项目

成功后访问:http://localhost:8088/xxl-job-admin/

初始用户名:admY 9 W H S # Sin
密码:1233 / ) S B {456

开源定时任务XXL-JOB安装与使用(ORACLE版和MYSQL版本) + 微服务模式
至此服务端O v C W t C | ~完成。


创建微服务k f D执行器

  • 引入pom依赖
 <!-- xxl-job-coreh 8 V 4 y L A . h -->
<dependency>
<groupId>com.xuxueliI b - 2 ] - w</groupId>
<artifactId&g, x N ] f  X 0t;xxl-j d ] +ob-core</artifact# c v zId>
<version>2.J t T . s S y H t1.0</version>
</dependency>
  • 创建配置文件
package com.xxl.job.executor.core.cO R 4 g Vonfig;
import com.xxl.job.core.executor.impl.XxlJo( r 9bSpringExecutor;
import org.slf4j.Logger;
import org.s6 J + $ ] _ =lf4j.LoggerFactorym E U $;
import org.springframework.beans.factory.annotation.Value;
imp^ C m 7 ~ v E M cort org.springframework.context.annotation.Bean;
imporx g x Z b 9 6 ~t org.springframework.context.annotation.Configuration;
/**
* xxl-job config
*
* @au[ e X xthor xuxueli 2017-b V (04-28
*/
@Configuration
public clo t ( c o b _ass XxlJobConfig {
private Logger logger = LoggerFacto% 5 cry.getY F U H qLogger(XxlJo z H n s A nbConfig.class);
@Value("${xxl.job.admi@ 1 Gn.addresses}"? 7 +)
private String adminAddresses;
@Value("${xxl.job.executor.appname}# o ^ 1 , k")
private String appName;
@Value("${4  K r k # ^ Fxxl.job.executor.ip}")
private String i/ b H ~ U * = $p;
@Value("3 X T , 6 0 K r h${xxl.job.executor.port}")
prj 7 ? C rivate int port;
@Value("${xxl.job.aV J 1 pccessToken}")
private String accessToken;
@ValuU f ie("${xxl.job.executor.logpath}")
private 1 p E String logPath;
@Value("${xxl.job.executor.logre% ] l 7 ( ptentiondays}")
private int logRetentionDays;
@Bean(initMethod = "start", destroyMethod =| E G U 2 ? "destroy")
public XxlJ5  /obSpringEr g u q G 6  /xecutor xxlJobExecutor() {
logger.info(">>>>>>>>>>> xxl-job config init.");
XxlJobSp@ G 1 D VringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
xxlJobSpringExecutor.setAdminAddresses(adminc ? x N h CAddresses);
xxlJobSpringExecutor.setAppName(appName);
xxlJobSpringExecutor.setIp(ip);
xxlJobSpringExecutor.setPort(port);
xxlJobSpringExecutor.setAccesss o B mToken(accessToken);
xxlJobSpringExecutor.setLogPath(logPath);
xxl8 D Y W D H ] 4JobSpringExecutO c { Yor.setLogRetentionDays(logRetentionDays);
return xxlH ( m n rJobSpringExecx U 6 c s o r %utor;
}
/**
* 针对多网卡、容器内部署等^ c y q情况,可借2 1 ^ } $ h助 "spring-cloud-commons"z h z m J n w = 提供的 "InetUtils"[ | , ` * H % 组件灵活定制注册IP;
*
*      1、引入依赖:
*          <dependency>
*             <groupId>org.springframework.cloud</groupId>
*             <artifactId` . m>spring-cloud-commons</artifactId>
*t X M _ g  0             <version>${version}</versit / ] 6 ] D K ^ |on>
*a ] i + y B         </dI . c ` U ; Jependency>
*
*      2、配置文件,或者容器启动变量
*          spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
*
*      3、获取IP
*          String ip_ = inetUtils.findFirstNonLoopbackHostIR - d F C Rnfo()F M 7 0 Y j $ c.getIpAddress();
*/
}
  • 修改配置文件
xxt Y ~ ,l:
job:
a9 ] 9 x F cccessToken:
admin:
addresses: http://lo@ v d r 1 r g f +cahos:8088/xxl-job-admin
executor:
add# x ! Jress:
appname: xxl-job-shiro ##这个是执行器名字
ip:
logpath: /data/apploO | W G l _ _ gs/M ; BxxlU _ S ~ F - x-job/jobhandlem p V Y l p t  2r
logretentiondays: -1
port: -1

appname 对应入下图所示
开源定时任务XXL-JOB安装与使用(ORACLE版和MYSQL版本) + 微服务模式

  • 创建执行器job
package com.itcc.coll.job;
import com.xxl.job.core.biz.model.Rs C /eturnT;
import= F m  com.xxl.job.core.handler.Ih # l MJobHandler;
import com.xxl.job.core.handler.annotation.JobHC x 2 ] -andler;
import com.xxl.job.core.log.XxlJobLogger;
import orgy R e M & $ - %.springfraR N e x 3 A Z 6 xmework.stereotype.Componj k 3 k L C p c Sent;
import java.util.Date;
/**
* 任务Handler示例(Bean模式)
*
* 开u d X K  S  o X发步骤:
* 1、继承"IJobHandler":“ct 1 5 L D Z p !om.xxl.job.core.handler.IJobHandler”;
* 2、注册到Spring容器:添加“@Component”注解,被Spring容器扫描为Bean实例;
* 3、注册到执行器工厂:添加“@JobHandler(value="自定义jobhandlerx J x y @名称")”注解,注解value值对应的是调度中心新建任务的JobHandler属性的值。
* 4、执行日志:需要通过 "XxlJobLogger.log" 打印执行日志7 z % M @ /;
*
* @author xuxueli 2( V | E H 4015-12-19 19:43:36
*/
@JobHandler(valu( & X _ u L ~ y [e="shiro_job")
@Comp; q q I lonent
public class DemY { T { q T yoJok V 8 gbHa+ N j K M F |ndlerF d a Q extends IJobHandler {
@Override
publd 5 } p Iic ReturnT<Strig y Q 3 O Zng>B M + t y execute(String param) throws Exception {
System.out.println(new Date()+"shiro_job.");
return SUCCESS;
}
}

JobHandler 对应调度中心的这个属性,V n M入下图
开源定时任务XXL-JOB安装与使用(ORACLE版和MYSQL版本) + 微服务模式


测试

通过管理中心,启动测试。完美运行。其他功能按字面意思$ ? e K T调用即可。


issues

需要做两台机器的时间同步,时间差的很多也会执行失败。


特别鸣谢;作者和这么好的开源项I p = . J - # $目。
祝君好运。