XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
/data/xxljob/xxl-job-2.2.0/
├── doc
│ ├── db
│ ├── images
│ ├── XXL-JOB官方文档.md
│ ├── XXL-JOB架构图.pptx
│ └── XXL-JOB-English-Documentation.md
├── LICENSE
├── NOTICE
├── pom.xml
├── README.md
├── xxl-job-admin //调度中心,项目源码
│ ├── Dockerfile
│ ├── pom.xml
│ └── src
├── xxl-job-core //公共Jar依赖
│ ├── pom.xml
│ └── src
└── xxl-job-executor-samples //执行器,Sample示例项目。我们可以在该项目上进行开发,也可以将现有项目改造生成执行器项目
├── pom.xml
├── xxl-job-executor-sample-frameless //无框架版本
├── xxl-job-executor-sample-jboot //Jboot版本,通过Jboot管理执行器
├── xxl-job-executor-sample-jfinal //JFinal版本,通过JFinal管理执行器
├── xxl-job-executor-sample-nutz //Nutz版本,通过Nutz管理执行器
├── xxl-job-executor-sample-spring //Spring版本,通过Spring容器管理执行器,比较通用
└── xxl-job-executor-sample-springboot //Springboot版本,通过Springboot管理执行器,推荐这种方式
XXL-JOB调度模块基于自研调度组件并支持集群部署,调度数据库表说明如下:
- xxl_job_lock:任务调度锁表;
- xxl_job_group:执行器信息表,维护任务执行器信息;
- xxl_job_info:调度扩展信息表: 用于保存XXL-JOB调度任务的扩展信息,如任务分组、任务名、机器地址、执行器、执行入参和报警邮件等等;
- xxl_job_log:调度日志表: 用于保存XXL-JOB任务调度的历史信息,如调度结果、执行结果、调度入参、调度机器和执行器等等;
- xxl_job_log_report:调度日志报表:用户存储XXL-JOB任务调度日志的报表,调度中心报表功能页面会用到;
- xxl_job_logglue:任务GLUE日志:用于保存GLUE更新历史,用于支持GLUE的版本回溯功能;
- xxl_job_registry:执行器注册表,维护在线的执行器和调度中心机器地址信息;
- xxl_job_user:系统用户表;
将调度行为抽象形成“调度中心”公共平台,而平台自身并不承担业务逻辑,“调度中心”负责发起调度请求。
将任务抽象成分散的JobHandler,交由“执行器”统一管理,“执行器”负责接收调度请求并执行对应的JobHandler中业务逻辑。
因此,“调度”和“任务”两部分可以相互解耦,提高系统整体稳定性和扩展性。
官网要求预安装环境:
Maven3+
Jdk1.8+
Mysql5.7+
本机环境:
我这里是安装好了jdk和maven的,如果有需要的可以参考centos8使用war包安装部署jenkins以及初始化配置这篇文章,这个里面有详细的安装以及配置步骤。
MySQL我安装的是8.0.21版本的,如果有需要,可以参考centos8安装MySQL8,里面有详细的安装已经配置步骤。
[root@dxm31 ~]# mkdir -p /data/xxljob
[root@dxm31 ~]# cd /data/xxljob/
[root@dxm31 xxljob]# wget https://github.com/xuxueli/xxl-job/archive/v2.2.0.tar.gz
[root@dxm31 xxljob]# ll -h
[root@dxm31 xxljob]# tar -zxvf v2.2.0.tar.gz
“调度数据库初始化SQL脚本” 位置为:/xxl-job/doc/db/tables_xxl_job.sql
。
调度中心支持集群部署,集群情况下各节点务必连接同一个mysql实例;
如果mysql做主从,调度中心集群节点务必强制走主库;
xxl_job_info:调度扩展信息表: 用于保存XXL-JOB调度任务的扩展信息,如任务分组、任务名、机器地址、执行器、执行入参和报警邮件等等;
xxl_job_log:调度日志表: 用于保存XXL-JOB任务调度的历史信息,如调度结果、执行结果、调度入参、调度机器和执行器等等;
xxl_job_log_report:调度日志报表:用户存储XXL-JOB任务调度日志的报表,调度中心报表功能页面会用到;
xxl_job_logglue:任务GLUE日志:用于保存GLUE更新历史,用于支持GLUE的版本回溯功能;
xxl_job_registry:执行器注册表,维护在线的执行器和调度中心机器地址信息;
xxl_job_group:执行器信息表,维护任务执行器信息;
xxl_job_user:系统用户表;
xxl_job_lock:任务调度锁表;
我们可以通过mysql -uroot -p123456 < /data/xxljob/xxl-job-2.2.0/doc/db/tables_xxl_job.sql
这种操作来初始化数据库,也可以通过用navicat工具导入再执行sql这种操作来初始化数据库,大家任意选择,怎么方便怎么来。
调度中心作用:统一管理任务调度平台上调度任务,负责触发调度执行,并且提供任务管理平台。
调度中心配置文件地址:/xxl-job/xxl-job-admin/src/main/resources/application.properties
修改此配置文件
[root@dxm31 ~]# vim /data/xxljob/xxl-job-2.2.0/xxl-job-admin/src/main/resources/application.properties
内容如下:
### web
server.port=8082
server.context-path=/xxl-job-admin
### actuator
management.server.servlet.context-path=/actuator
management.health.mail.enabled=false
### resources
spring.mvc.servlet.load-on-startup=0
spring.mvc.static-path-pattern=/static/**
spring.resources.static-locations=classpath:/static/
### freemarker
spring.freemarker.templateLoaderPath=classpath:/templates/
spring.freemarker.suffix=.ftl
spring.freemarker.charset=UTF-8
spring.freemarker.request-context-attribute=request
spring.freemarker.settings.number_format=0.##########
### mybatis
mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml
#mybatis.type-aliases-package=com.xxl.job.admin.core.model
### xxl-job, datasource 调度中心JDBC链接:链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
spring.datasource.url=jdbc:mysql://192.168.0.22:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
### datasource-pool
spring.datasource.type=com.zaxxer.hikari.HikariDataSource
spring.datasource.hikari.minimum-idle=10
spring.datasource.hikari.maximum-pool-size=30
spring.datasource.hikari.auto-commit=true
spring.datasource.hikari.idle-timeout=30000
spring.datasource.hikari.pool-name=HikariCP
spring.datasource.hikari.max-lifetime=900000
spring.datasource.hikari.connection-timeout=10000
spring.datasource.hikari.connection-test-query=SELECT 1
### xxl-job email 报警邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=[email protected]
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
### xxl-job, access token 调度中心通讯TOKEN [选填]:非空时启用;
xxl.job.accessToken=
### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en") 调度中心国际化配置 [必填]: 默认为 "zh_CN"/中文简体, 可选范围为 "zh_CN"/中文简体, "zh_TC"/中文繁体 and "en"/英文;
xxl.job.i18n=zh_CN
## xxl-job, triggerpool max size 调度线程池最大线程配置【必填】
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100
### xxl-job, log retention days 调度中心日志表数据保存天数 [必填]:过期日志自动清理;限制大于等于7时生效,否则, 如-1,关闭自动清理功能;
xxl.job.logretentiondays=30
其中web 端口默认是8080,如果有冲突,一定要更换(本文采用8082,因为8080是tomcat服务,8081是maven私服。),另外spring.datasource.url注意一下这里的IP,如果不是127.0.0.1,也一定要更换。
查看一下默认配置日志路径:
默认日志路径为:/data/applogs/xxl-job/xxl-job-admin.log,我们改为/data/xxl-job/xxl-job-admin.log。
操作步骤:
[root@dxm31 ~]# vim /data/xxljob/xxl-job-2.2.0/xxl-job-admin/src/main/resources/logback.xml
修改以下内容:
<property name="log.path" value="/data/xxl-job/xxl-job-admin.log"/>
“执行器”项目:xxl-job-executor-sample-springboot (提供多种版本执行器供选择,现以 springboot 版本为例,可直接使用,也可以参考其并将现有项目改造成执行器)。
作用:负责接收“调度中心”的调度并执行;可直接部署执行器,也可以将执行器集成到现有业务项目中。
我们以 springboot 版本为例,要修改的配置文件路径为:xxl-job-2.2.0/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/application.properties
[root@dxm31 ~]# vim /data/xxljob/xxl-job-2.2.0/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/application.properties
修改内容如下:
# web port
server.port=8083
# no web
#spring.main.web-environment=false
# log config
logging.config=classpath:logback.xml
### xxl-job admin address list, such as "http://address" or "http://address01,http://address02" 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
xxl.job.admin.addresses=http://127.0.0.1:8082/xxl-job-admin
### xxl-job, access token 执行器通讯TOKEN [选填]:非空时启用;
xxl.job.accessToken=
### xxl-job executor appname 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-sample
### xxl-job executor registry-address: default use address to registry , otherwise use ip:port if address is null 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
xxl.job.executor.address=
### xxl-job executor server-info 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
xxl.job.executor.ip=
### 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
xxl.job.executor.port=9999
### xxl-job executor log-path 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
xxl.job.executor.logpath=/data/xxl-job/jobhandler
### xxl-job executor log-retention-days 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;
xxl.job.executor.logretentiondays=30
其中web 端口默认是8081,如果有冲突,一定要更换(本文采用8083)
查看一下默认配置日志路径:
默认日志路径为:/data/applogs/xxl-job/xxl-job-executor-sample-springboot.log,我们改为/data/xxl-job/xxl-job-executor-sample-springboot.log。
操作步骤:
[root@dxm31 ~]# vim /data/xxljob/xxl-job-2.2.0/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/logback.xml
修改以下内容:
<property name="log.path" value="/data/xxl-job/xxl-job-executor-sample-springboot.log"/>
如果已经正确进行上述配置,可将项目编译打包部署。
[root@dxm31 ~]# cd /data/xxljob/xxl-job-2.2.0/
[root@dxm31 xxl-job-2.2.0]# mvn clean install
看到这个证明项目编译打包完成。
查看一下xxl-job-admin/target/下面是否有xxl-job-admin-2.2.0.jar:
[root@dxm31 xxl-job-2.2.0]# ll xxl-job-admin/target/
查看一下xxl-job-executor-samples/xxl-job-executor-sample-springboot/target/下面是否有xxl-job-executor-sample-springboot-2.2.0.jar:
[root@dxm31 xxl-job-2.2.0]# ll xxl-job-executor-samples/xxl-job-executor-sample-springboot/target/
启动调度中心命令:nohup java -jar xxl-job-admin/target/xxl-job-admin-2.2.0.jar &
[root@dxm31 xxl-job-2.2.0]# nohup java -jar xxl-job-admin/target/xxl-job-admin-2.2.0.jar &
[root@dxm31 xxl-job-2.2.0]# ps aux | grep xxl-job-admin
[root@dxm31 xxl-job-2.2.0]# netstat -ntlp | grep 8082
我们用浏览器访问一下http://IP+端口,我们这里是http://192.168.0.31:8082/xxl-job-admin
默认登录账号 “admin/123456”, 登录后运行界面如下图所示:
至此“调度中心”项目已经部署成功。
启动执行器命令:nohup java -jar xxl-job-executor-samples/xxl-job-executor-sample-springboot/target/xxl-job-executor-sample-springboot-2.2.0.jar &
[root@dxm31 xxl-job-2.2.0]# nohup java -jar xxl-job-executor-samples/xxl-job-executor-sample-springboot/target/xxl-job-executor-sample-springboot-2.2.0.jar &
[root@dxm31 xxl-job-2.2.0]# ps aux | grep xxl-job-executor-sample-springboot
[root@dxm31 xxl-job-2.2.0]# netstat -ntlp | grep 8083
# 创建/usr/local/xxl-job目录,用于存放jar包和启动脚本
[root@dxm31 ~]# mkdir -p /usr/local/xxl-job
# 将编译打包后的xxl-job-admin-2.2.0.jar复制到/usr/local/xxl-job目录下
[root@dxm31 ~]# cp /data/xxljob/xxl-job-2.2.0/xxl-job-admin/target/xxl-job-admin-2.2.0.jar /usr/local/xxl-job/
# 创建启动脚本并编写内容
[root@dxm31 ~]# vim /usr/local/xxl-job/startadmin.sh
#!/bin/sh
nohup /usr/local/jdk/bin/java -jar /usr/local/xxl-job/xxl-job-admin-2.2.0.jar >> ./nohup.out 2>&1 &
# 给启动脚本增加可执行权限
[root@dxm31 ~]# chmod +x /usr/local/xxl-job/startadmin.sh
创建xxl-job-admin.service服务文件
[root@dxm31 ~]# vim /etc/systemd/system/xxl-job-admin.service
内容如下:
[Unit]
Description=xxl-job-admin server
After=network.target remote-fs.target nss-lookup.target
[Service]
Type=forking
User=root
Group=root
ExecStart=sh /usr/local/xxl-job/startadmin.sh
PrivateTmp=true
[Install]
WantedBy=multi-user.target
[root@dxm31 ~]# systemctl daemon-reload
# 停止上面手动后台启动的xxl-job-admin服务
[root@dxm31 xxl-job-2.2.0]# ps aux | grep xxl-job-admin
root 4812 0.7 15.1 4542108 582008 pts/0 Sl 12:12 0:28 java -jar xxl-job-admin/target/xxl-job-admin-2.2.0.jar
root 5778 0.0 0.0 12320 1068 pts/0 R+ 13:14 0:00 grep --color=auto xxl-job-admin
[root@dxm31 xxl-job-2.2.0]# kill -9 4812
# 检查是否还存在xxl-job-admin进程
[root@dxm31 xxl-job-2.2.0]# ps aux | grep xxl-job-admin
root 5789 0.0 0.0 12320 1084 pts/0 S+ 13:15 0:00 grep --color=auto xxl-job-admin
# 查询所有服务单元是否有xxl-job-admin
[root@dxm31 xxl-job-2.2.0]# systemctl list-unit-files | grep xxl-job-admin
xxl-job-admin.service disabled
# 存在,且非开启自启动,使用systemctl启动xxl-job-admin服务
[root@dxm31 xxl-job-2.2.0]# systemctl start xxl-job-admin.service
# 查看nginx服务状态
[root@dxm31 xxl-job-2.2.0]# systemctl status xxl-job-admin.service
Active: active (running) 可以看到xxl-job-admin服务已经启动成功。查看进程以及端口的监听情况:
[root@dxm31 xxl-job-2.2.0]# ps aux | grep xxl-job-admin
[root@dxm31 xxl-job-2.2.0]# netstat -ntlp | grep 8082
浏览器访问http://192.168.0.31:8082/xxl-job-admin
[root@dxm31 xxl-job-2.2.0]# systemctl list-unit-files | grep xxl-job-admin.service
xxl-job-admin.service disabled
# disabled表示非开机自启动
# 设置为开机自启动
[root@dxm31 xxl-job-2.2.0]# systemctl enable xxl-job-admin.service
Created symlink /etc/systemd/system/multi-user.target.wants/xxl-job-admin.service → /etc/systemd/system/xxl-job-admin.service.
# 再次查看
[root@dxm31 xxl-job-2.2.0]# systemctl list-unit-files | grep xxl-job-admin.service
xxl-job-admin.service enabled
# enabled表示是开机自启动,执行重启命令
[root@dxm31 xxl-job-2.2.0]# reboot
#重启后再次查看xxl-job-admin服务已启动完成。
# 将编译打包后的xxl-job-executor-sample-springboot-2.2.0.jar复制到/usr/local/xxl-job目录下
[root@dxm31 xxl-job-2.2.0]# cp /data/xxljob/xxl-job-2.2.0/xxl-job-executor-samples/xxl-job-executor-sample-springboot/target/xxl-job-executor-sample-springboot-2.2.0.jar /usr/local/xxl-job/
# 创建启动脚本并编写内容
[root@dxm31 xxl-job-2.2.0]# vim /usr/local/xxl-job/startexecutor.sh
#!/bin/sh
nohup /usr/local/jdk/bin/java -jar /usr/local/xxl-job/xxl-job-executor-sample-springboot-2.2.0.jar >> ./nohup.out 2>&1 &
# 给启动脚本增加可执行权限
[root@dxm31 xxl-job-2.2.0]# chmod +x /usr/local/xxl-job/startexecutor.sh
创建xxl-job-executor.service服务文件
[root@dxm31 xxl-job-2.2.0]# vim /etc/systemd/system/xxl-job-executor.service
内容如下:
[Unit]
Description=xxl-job-executor server
After=network.target remote-fs.target nss-lookup.target
[Service]
Type=forking
User=root
Group=root
ExecStart=sh /usr/local/xxl-job/startexecutor.sh
PrivateTmp=true
[Install]
WantedBy=multi-user.target
[root@dxm31 xxl-job-2.2.0]# systemctl daemon-reload
# 停止上面手动后台启动的执行器服务
[root@dxm31 xxl-job-2.2.0]# ps aux | grep xxl-job-executor-sample-springboot
root 6953 291 9.0 4518132 349104 pts/0 Sl 14:20 0:08 java -jar xxl-job-executor-samples/xxl-job-executor-sample-springboot/target/xxl-job-executor-sample-springboot-2.2.0.jar
root 6999 0.0 0.0 12320 1088 pts/0 S+ 14:20 0:00 grep --color=auto xxl-job-executor-sample-springboot
[root@dxm31 xxl-job-2.2.0]# kill -9 6953
# 检查是否还存在执行器进程
[root@dxm31 xxl-job-2.2.0]# ps aux | grep xxl-job-executor-sample-springboot
root 7016 0.0 0.0 12320 1068 pts/0 S+ 14:22 0:00 grep --color=auto xxl-job-executor-sample-springboot
# 查询所有服务单元是否有执行器
[root@dxm31 xxl-job-2.2.0]# systemctl list-unit-files | grep xxl-job-executor.service
xxl-job-executor.service disabled
# 存在,且非开启自启动,使用systemctl启动执行器服务
[root@dxm31 xxl-job-2.2.0]# systemctl start xxl-job-executor.service
# 查看nginx服务状态
[root@dxm31 xxl-job-2.2.0]# systemctl status xxl-job-executor.service
Active: active (running) 可以看到执行器服务已经启动成功。查看进程以及端口的监听情况:
[root@dxm31 xxl-job-2.2.0]# ps aux | grep xxl-job-executor-sample-springboot
[root@dxm31 xxl-job-2.2.0]# netstat -ntlp | grep 8083
[root@dxm31 xxl-job-2.2.0]# systemctl list-unit-files | grep xxl-job-executor.service
xxl-job-executor.service disabled
# disabled表示非开机自启动
# 设置为开机自启动
[root@dxm31 xxl-job-2.2.0]# systemctl enable xxl-job-executor.service
Created symlink /etc/systemd/system/multi-user.target.wants/xxl-job-executor.service → /etc/systemd/system/xxl-job-executor.service.
# 再次查看
[root@dxm31 xxl-job-2.2.0]# systemctl list-unit-files | grep xxl-job-executor.service
xxl-job-executor.service enabled
# enabled表示是开机自启动,执行重启命令
[root@dxm31 xxl-job-2.2.0]# reboot
#重启后再次查看执行器服务已启动完成。
任务运行模式主要有Bean模式和Gule模式(理解为脚本)。下面我们就分别以这两种不同的运行模式分别开发一个任务。
“GLUE模式(Java)”的执行代码托管到调度中心在线维护,相比“Bean模式任务”需要在执行器项目开发部署上线,更加简便轻量。
前提:请确认“调度中心”和“执行器”项目已经成功部署并启动!!!!
原理: 每个 “GLUE模式(Java)” 任务的代码,实际上是“一个继承自“IJobHandler”的实现类的类代码”,“执行器”接收到“调度中心”的调度请求时,会通过Groovy类加载器加载此代码,实例化成Java对象,同时注入此代码中声明的Spring服务(请确保Glue代码中的服务和类引用在“执行器”项目中存在),然后调用该对象的execute方法,执行任务逻辑。
下面开始介绍一下详细的步骤:
第一步:新建任务
登录调度中心,点击下图所示“新建任务”按钮,新建示例任务。然后,参考下面截图中任务的参数配置,点击保存。
从这个图,大家可以发现,cron表达式的编写更加方便了。
点击保存之后,弹出:
点击确定。
这个就是我们上面新建的任务。
从任务管理列表截图可以看出比之前增加了根据状态、任务描述以及负责人这三个搜索项。
第二步:“GLUE模式(Java)” 任务开发
我们在我们上面新建任务『测试』这列操作选择GLUE IDE,进入 “GLUE编辑器开发界面” ,见下图。“GLUE模式(Java)” 运行模式的任务默认已经初始化了示例任务代码,即打印Hello World。
我们简单改变一下这段示例代码,在log后面加上当前时间,然后点击保存,输入源码备注,保存成功。
版本回溯功能(支持30个版本的版本回溯):在GLUE任务的Web IDE界面,选择右上角下拉框“版本回溯”,会列出该GLUE的更新历史,选择相应版本即可显示该版本代码,保存后GLUE代码即回退到对应的历史版本;
SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
XxlJobLogger.log("XXL-JOB, Hello World."+df.format(System.currentTimeMillis()));
注意:要导入需要的包,否则会执行失败。
import java.text.SimpleDateFormat;
import java.util.Date;
见下图:
GLUE模式(Java):任务以源码方式维护在调度中心;该模式的任务实际上是一段继承自IJobHandler的Java类代码并 “groovy” 源码方式维护,它在执行器项目中运行,可使用@Resource/@Autowire注入执行器里中的其他服务。
第三步:触发执行
点击任务右侧操作下面的 “执行一次” 按钮,可手动触发一次任务执行(通常情况下,通过配置Cron表达式进行任务调度触发)。
我们这里是简单的任务测试,无需输入任何参数,只需要点击『保存』按钮即可。
第四步:查看日志
点击任务右侧操作下 “查询日志” 按钮,可前往调度日志界面查看调度日志。
在调度日志界面中,可查看该任务的历史调度记录以及每一次调度的调度时间、调度结果、调度备注、执行时间、执行结果和执行备注。运行中的任务点击右侧的“执行日志”按钮,可进入日志控制台查看实时执行日志。
可以看到调度结果和执行结果都是:成功。我们点击调度备注查看:
点击操作,里面有执行日志和终止任务两个按钮:
由于我们任务比较简单,已经执行完成,我们来点击一下执行日志按钮看一下:
2020-12-28 15:39:35 [com.xxl.job.core.thread.JobThread#run]-[124]-[Thread-8]
----------- xxl-job job execute start -----------
----------- Param:
2020-12-28 15:39:35 [com.xxl.job.core.handler.impl.GlueJobHandler#execute]-[26]-[Thread-9] ----------- glue.version:1609141157000 -----------
2020-12-28 15:39:35 [sun.reflect.NativeMethodAccessorImpl#invoke0]-[-2]-[Thread-9] XXL-JOB, Hello World.2020-12-28 15:39:35
2020-12-28 15:39:35 [com.xxl.job.core.thread.JobThread#run]-[164]-[Thread-8]
----------- xxl-job job execute end(finish) -----------
----------- ReturnT:ReturnT [code=200, msg=null, content=null]
2020-12-28 15:39:35 [com.xxl.job.core.thread.TriggerCallbackThread#callbackLog]-[191]-[xxl-job, executor TriggerCallbackThread]
----------- xxl-job job callback finish.
[Load Log Finish]
我们可以看到这里面有job执行开始信息、参数、glue版本号、我们输入的Hello World.+当前时间、job执行结束信息、ReturnT:ReturnT返回执行结果以及job 回到完成信息。
通过我们上面的简单的开发任务可以看出GLUE的**原理是:每一个GLUE模式的代码,在“执行器”接受到调度请求时,都会通过Groovy类加载器加载出代码,并实例化成Java对象,同时注入此代码中声明的Spring服务(这里要确保代码中所引用的类或服务在“执行器项目中存在”),接着调用该对象的execute方法,执行具体的任务逻辑。**说白了,就是任务以源码方式维护在调度中心,支持通过Web IDE在线更新,实时编译和生效,因此不需要指定JobHandler。
在该模式下,任务的具体实现逻辑是以JobHandler的形式存在于“执行器项目”中。
Bean模式(类形式)任务支持基于类的开发方式,每个任务对应一个Java类。
原理: 每个Bean模式任务都是一个Spring的Bean类实例,它被维护在“执行器”项目的Spring容器中。任务类需要加“@JobHandler(value=”名称”)”注解,因为“执行器”会根据该注解识别Spring容器中的任务。任务类需要继承统一接口“IJobHandler”,任务逻辑在execute方法中开发,因为“执行器”在接收到调度中心的调度请求时,将会调用“IJobHandler”的execute方法,执行任务逻辑。
开发一个继承自"com.xxl.job.core.handler.IJobHandler"的JobHandler类,实现其中任务方法。
手动通过如下方式注入到执行器容器。
XxlJobExecutor.registJobHandler(“demoJobHandler”, new DemoJobHandler());
运行模式选中 “BEAN模式”,JobHandler属性填写任务注解“@JobHandler”中定义的值;
点击保存:
接下来就可以对任务进行执行一次、查看日志、启动等操作。
Bean模式(方法形式)任务支持基于方法的开发方式,每个任务对应一个方法。
基于方法开发的任务,底层会生成JobHandler代理,和基于类的方式一样,任务也会以JobHandler的形式存在于执行器任务容器中。
1、任务开发:在Spring Bean实例中,开发Job方法;
2、注解配置:为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")",注解value值对应的是调度中心新建任务的JobHandler属性的值。
3、执行日志:需要通过 "XxlJobHelper.log" 打印执行日志;
4、任务结果:默认任务结果为 "成功" 状态,不需要主动设置;如有诉求,比如设置任务结果为失败,可以通过 "XxlJobHelper.handleFail/handleSuccess" 自主设置任务结果;
// 可参考Sample示例执行器中的 “com.xxl.job.executor.service.jobhandler.SampleXxlJob” ,如下:
@XxlJob(“demoJobHandler”)
public void demoJobHandler() throws Exception {
XxlJobHelper.log(“XXL-JOB, Hello World.”);
}
运行模式选中 “BEAN模式”,JobHandler属性填写任务注解“@XxlJob”中定义的值。可以参考下面“配置属性详细说明”对新建的任务进行参数配置。
基础配置:
触发配置:
任务配置:
高级配置: