记录折腾的那点事
在折腾的道路上永不止步

spring boot项目整合xxl-job

关于分布式任务调度平台XXL-JOB,作者 许雪里 在其发布的中文教程中已经介绍的很清楚了,这里就不做过多的介绍了。按照文档搭建xxl-job,做此记录。


1、源码下载地址

GitHub:https://github.com/xuxueli/xxl-job 码云:https://gitee.com/xuxueli0323/xxl-job

2.文档地址

中文文档:

http://www.xuxueli.com/xxl-job/#/

3.源码结构

spring boot项目整合xxl-job

xxl-job-admin:调度中心

xxl-job-core:公共依赖

xxl-job-executor:执行器Sample示例(选择合适的版本执行器,可直接使用,也可以参考其并将现有项目改造成执行器)


xxl-job-executor-sample-spring:Spring版本,通过Spring容器管理执行器,比较通用,推荐这种方式;



xxl-job-executor-sample-springboot:Springboot版本,通过Springboot管理执行器;



xxl-job-executor-sample-jfinal:JFinal版本,通过JFinal管理执行器;



xxl-job-executor-sample-nutz:Nutz版本,通过Nutz管理执行器;

4.初始化数据库脚本

/doc/db/tables_xxl_job.sql ,将此脚本在MySQL数据库中执行。

spring boot项目整合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:系统用户表;

5.配置调度中心xxl-job-admin

我们需要将其配置成自己需要的调度中心,通过该工程能够以图形化的方式统一管理任务调度平台上调度任务,负责触发调度执行。

  • 5.1 修改调度中心配置文件:/xxl-job/xxl-job-admin/src/main/resources/application.properties
### 1、调度中心项目的端口号以及访问路径
### web
server.port=8080 server.context-path=/xxl-job-admin
### 2、配置静态文件的前缀
### resources
spring.mvc.static-path-pattern=/static/**
spring.resources.static-locations=classpath:/static/
### 3、配置模板文件
### 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.##########
### 4、配置mybatis的mapper文件地址
### mybatis
mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml
### 5、配置数据库的地址
### xxl-job, datasource
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?Unicode=true&characterEncoding=UTF-8 spring.datasource.username=root
spring.datasource.password=123456 spring.datasource.driver-class-name=com.mysql.jdbc.Driver

spring.datasource.type=org.apache.tomcat.jdbc.pool.DataSource
spring.datasource.tomcat.max-wait=10000 spring.datasource.tomcat.max-active=30 spring.datasource.tomcat.test-on-borrow=true
spring.datasource.tomcat.validation-query=SELECT 1 spring.datasource.tomcat.validation-interval=30000 ### 6、配置报警邮箱
### xxl-job email
spring.mail.host=smtp.qq.com
spring.mail.port=25 spring.mail.username=172572575 @qq.com
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
### 7、管理界面的登录用户名密码
xxl.job.login.username=admin
xxl.job.login.password=123456 ### 8、调度中心通讯TOKEN,非空时启用
### xxl-job, access token
xxl.job.accessToken=
### 9、调度中心国际化设置,默认为中文版本,值设置为“en”时切换为英文版本
### xxl-job, i18n (default empty as chinese, "en" as english)
xxl.job.i18n=

配置中基本只需要修改:

第5点:配置数据源;

第6点:报警邮箱,任务失败后有失败告警功能,可以通过发送邮箱来提醒;如果需要此功能,可以配置一下;

  • 5.2 启动调度中心

本文是基于springboot项目整合的xxl-job,即执行启动类XxlJobAdminApplication即可

spring boot项目整合xxl-job

  • 5.3 访问调度中心管理界面

在浏览器输入

http://localhost:8080/xxl-job-admin,输入用户名和密码(见配置文件),即出现如下管理界面

spring boot项目整合xxl-job

6.创建执行器项目

在源码中,作者提供了各个版本的 执行器项目,此处以

xxl-job-executor-sample-springboot项目为例。也可以自己创建项目,然后按照demo或文档进行改造。

  • 6.1 maven依赖
<!-- xxl-job-core --> <dependency> <groupId>com.xuxueli</groupId>    <artifactId>xxl-job-core</artifactId>    <version>${project.parent.version}</version> </dependency>
  • 6.2配置文件
#项目端口号
# web port
server.port=8081 #日志文件
# 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:8080/xxl-job-admin
#执行器的名称、ip地址、端口号
### xxl-job executor address
xxl.job.executor.appname=xxl-job-executor-sample
xxl.job.executor.ip=
xxl.job.executor.port=9999 #执行器通讯TOKEN:非空时启用
### xxl-job, access token
xxl.job.accessToken=
#执行器运行日志文件存储的磁盘位置,需要对该路径拥有读写权限
### xxl-job log path
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
#执行器Log文件定期清理功能,指定日志保存天数,日志文件过期自动删除。限制至少保持3天,否则功能不生效
#-1表示永不删除
### xxl-job log retention days
xxl.job.executor.logretentiondays=-1

注意:配置执行器的名称、IP地址、端口号,后面如果配置多个执行器时,要防止端口冲突

  • 6.3 载入配置文件XxlJobConfig.java
package com.xxl.job.executor.core.config; import com.xxl.job.core.executor.impl.XxlJobSpringExecutor; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration public class XxlJobConfig {
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);     @Value("${xxl.job.admin.addresses}")     private String adminAddresses;     @Value("${xxl.job.executor.appname}")     private String appName;     @Value("${xxl.job.executor.ip}")     private String ip;     @Value("${xxl.job.executor.port}")     private int port;     @Value("${xxl.job.accessToken}")     private String accessToken;     @Value("${xxl.job.executor.logpath}")     private String logPath;     @Value("${xxl.job.executor.logretentiondays}")     private int logRetentionDays;     @Bean(initMethod = "start", destroyMethod = "destroy")     public XxlJobSpringExecutor xxlJobExecutor() {
        logger.info(">>>>>>>>>>> xxl-job config init.");
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
        xxlJobSpringExecutor.setAppName(appName);
        xxlJobSpringExecutor.setIp(ip);
        xxlJobSpringExecutor.setPort(port);
        xxlJobSpringExecutor.setAccessToken(accessToken);
        xxlJobSpringExecutor.setLogPath(logPath);
        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);

        return xxlJobSpringExecutor;
    }

    /**      * 针对多网卡、容器内部署等情况,可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP;      *      *      1、引入依赖:      *          <dependency>      *             <groupId>org.springframework.cloud</groupId>      *             <artifactId>spring-cloud-commons</artifactId>      *             <version>${version}</version>      *         </dependency>      *      *      2、配置文件,或者容器启动变量      *          spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'      *      *      3、获取IP      *          String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();      */ }
  • 6.4 创建任务JobHandler

项目中已提供的示例,可以参照创建自己的handler处理类

spring boot项目整合xxl-job

新建TestJobHandler执行器,仅打印几行日志,如下

package com.xxl.job.executor.service.jobhandler; import com.xxl.job.core.biz.model.ReturnT; import com.xxl.job.core.handler.IJobHandler; import com.xxl.job.core.handler.annotation.JobHandler; import com.xxl.job.core.log.XxlJobLogger; import org.springframework.stereotype.Component; @Component public class TestJobHandler {

    @XxlJob     public ReturnT<String> execute(String param) throws Exception {
        XxlJobLogger.log("===my TestJobHandler===");

        for(int i=0; i<5; i++){
            XxlJobLogger.log("=== : " + i);
        }

        return SUCCESS;
    }

}

注意点:继承IJobHandler类,添加注解@JobHandler(value = “testJobHandler”)

  • 6.5 启动执行器XxlJobExecutorApplication
spring boot项目整合xxl-job

7、在调度中心中配置执行器

前面已启动xxl-job-admin调度中心,进入

http://localhost:8080/xxl-job-admin 管理界面

  • 7.1 点击 执行器管理—>新增执行器—>如下界面,然后填充此表格,点击保存
spring boot项目整合xxl-job

参数介绍:

AppName:是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;

名称:执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;

排序: 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;

注册方式:调度中心获取执行器地址的方式,

自动注册:执行器自动进行执行器注册,调度中心通过底层注册表可以动态发现执行器机器地址;

手动录入:人工手动录入执行器的地址信息,多地址逗号分隔,供调度中心使用;

机器地址:”注册方式”为”手动录入”时有效,支持人工维护执行器的地址信息;

  • 7.2 创建任务,点击 任务管理—>新增任务—>如下界面,然后填充此表格,点击保存
spring boot项目整合xxl-job

参数介绍:

执行器:任务的绑定的执行器,任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能; 另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器, 可在 “执行器管理” 进行设置。

任务描述:任务的描述信息,便于任务管理;

路由策略:当执行器集群部署时,提供丰富的路由策略,包括;
FIRST(第一个):固定选择第一个机器;
LAST(最后一个):固定选择最后一个机器;
ROUND(轮询):;
RANDOM(随机):随机选择在线的机器;
CONSISTENT_HASH(一致性HASH):每个任务按照Hash算法固定选择某一台机器,且所有任务均匀散列在不同机器上。
LEAST_FREQUENTLY_USED(最不经常使用):使用频率最低的机器优先被选举;
LEAST_RECENTLY_USED(最近最久未使用):最久为使用的机器优先被选举;
FAILOVER(故障转移):按照顺序依次进行心跳检测,第一个心跳检测成功的机器选定为目标执行器并发起调度;
BUSYOVER(忙碌转移):按照顺序依次进行空闲检测,第一个空闲检测成功的机器选定为目标执行器并发起调度;
SHARDING_BROADCAST(分片广播):广播触发对应集群中所有机器执行一次任务,同时系统自动传递分片参数;可根据分片参数开发分片任务;
Cron:触发任务执行的Cron表达式;
运行模式
BEAN模式:任务以JobHandler方式维护在执行器端;需要结合 “JobHandler” 属性匹配执行器中任务;
GLUE模式(Java):任务以源码方式维护在调度中心;该模式的任务实际上是一段继承自IJobHandler的Java类代码并 “groovy” 源码方式维护,它在执行器项目中运行,可使用       @Resource/@Autowire注入执行器里中的其他服务;
GLUE模式(Shell):任务以源码方式维护在调度中心;该模式的任务实际上是一段 “shell” 脚本;
GLUE模式(Python):任务以源码方式维护在调度中心;该模式的任务实际上是一段 “python” 脚本;
GLUE模式(PHP):任务以源码方式维护在调度中心;该模式的任务实际上是一段 “php” 脚本;
GLUE模式(NodeJS):任务以源码方式维护在调度中心;该模式的任务实际上是一段 “nodejs” 脚本;
GLUE模式(PowerShell):任务以源码方式维护在调度中心;该模式的任务实际上是一段 “PowerShell” 脚本;
JobHandler:运行模式为 “BEAN模式” 时生效,对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值;
阻塞处理策略:调度过于密集执行器来不及处理时的处理策略;
单机串行(默认):调度请求进入单机执行器后,调度请求进入FIFO队列并以串行方式运行;
丢弃后续调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,本次请求将会被丢弃并标记为失败;
覆盖之前调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,将会终止运行中的调度任务并清空队列,然后运行本地调度任务;
子任务:每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取),当本任务执行结束并且执行成功时,将会触发子任务ID所对应的任务的一次主动调度。
任务超时时间:支持自定义任务超时时间,任务运行超时将会主动中断任务;
失败重试次数;支持自定义任务失败重试次数,当任务失败时将会按照预设的失败重试次数主动进行重试;
报警邮件:任务调度失败时邮件通知的邮箱地址,支持配置多邮箱地址,配置多个邮箱地址时用逗号分隔;
负责人:任务的负责人;
执行参数:任务执行所需的参数,多个参数时用逗号分隔,任务执行时将会把多个参数转换成数组传入;

8、启动任务及查看日志

  • 8.1 点击”操作”按钮,然后点击”启动”
spring boot项目整合xxl-job

  • 8.2 启动后,点击”调度日志”
spring boot项目整合xxl-job

  • 8.3 点击”调度备注”列的”查看”按钮,显示调度任务的基本信息
spring boot项目整合xxl-job

  • 8.4 点击”操作”列的”执行日志”按钮,显示如下
spring boot项目整合xxl-job

至此,xxl-job已搭建及使用完成,当然更多功能请参考文档。

赞(0)
未经允许不得转载:ghMa » spring boot项目整合xxl-job
分享到: 更多 (0)

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址