1.1概述：
- xxl-job是一个开源的轻量级分布式的调度任务框架，作者许雪里。其底层是基于spring， quartz，netty实现的。解决的问题是不用每个业务系统都需要集成quartz，管理cron配置，特别是任务很多的时候当容器启动会执行一堆job，影响启动速度。原理简单而言就是由统一调度中心通过quartz 控制业务系统触发时机，然后通过netty rpc 调用执行业务系统的具体实现。这样中心化的方式可以极大改善job的管理成本，也可以配置集群，加上本身框架的轻量级，所以用起来很方便。
1.2架构图
- 任务执行器根据配置的调度中心的地址，自动注册到调度中心
- 达到任务触发条件，调度中心下发任务
- 执行器基于线程池执行任务，并把执行结果放入内存队列中、把执行日志写入日志文件中
- 执行器的回调线程消费内存队列中的执行结果，主动上报给调度中心
- 当用户在调度中心查看任务日志，调度中心请求任务执行器，任务执行器读取任务日志文件并返回日志详情
2.项目搭建
1.源码下载地址
2.文档地址
3.项目导入
第一步：将下载好的项目导入到idea中，其结构图如下：
第二步：执行数据库脚本，/doc/db/tables_xxl_job.sql
第三步：修改xxl-job-admin项目配置
配置文件：application.properties
配置项：将数据库用户密码改为自己的，如果项目中数据库驱动的版本和自己本地mysql有冲突则将com.mysql.jdbc.Driver 改为 com.mysql.cj.jdbc.Driver 并且在spring.datasource.url后面在上&serverTimezone=GMT%2B8 GMT%2B8表示东八区。
另外值得注意下的是报警邮箱，因为该工程任务失败后有失败告警功能，可以通过邮件来提醒，如果我们需要此功能，可以配置一下参数spring.mail.host
4.启动项目
该工程是一个springboot项目，我们只需要XxlJobAdminApplication 类即可
5.管理界面
访问地址： http://localhost:8080/xxl-job-admin 然后输入用户名和密码（默认登录账号 “admin/123456”），即可看到如下管理界面。
3.创建执行器项目
在源码里，作者提供了各个版本的执行器，这里我们另外创建一个springboot项目。
1.添加maven依赖
<!-- https://mvnrepository.com/artifact/com.xuxueli/xxl-job-core -->
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.1.2</version>
</dependency>2.配置执行器
第一步：在创建好的springboot 项目的配置文件 application.properties 添加如下配置：
#项目端口号
server.port=8081
#日志文件
logging.config=classpath:logback.xml
#调度中心部署跟地址：如调度中心集群部署存在多个地址则用逗号分隔。
#执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"。
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
#分别配置执行器的名称、ip地址、端口号
#注意：如果配置多个执行器时，防止端口冲突
xxl.job.executor.appname=task-demo
xxl.job.executor.ip=
xxl.job.executor.port=9999
xxl.job.accessToken=
#执行器运行日志文件存储的磁盘位置，需要对该路径拥有读写权限
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
#执行器Log文件定期清理功能，指定日志保存天数，日志文件过期自动删除。限制至少保持3天，否则功能不生效；
#-1表示永不删除
xxl.job.executor.logretentiondays=30
第二步：在resources文件下创建日志文件logback.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="true" scanPeriod="1 seconds">
<contextName>logback</contextName>
<property name="log.path" value="/data/applogs/xxl-job/task-demo.log"/>
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${log.path}</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}.%d{yyyy-MM-dd}.zip</fileNamePattern>
</rollingPolicy>
<encoder>
<pattern>%date %level [%thread] %logger{36} [%file : %line] %msg%n
</pattern>
</encoder>
</appender>
<root level="info">
<appender-ref ref="console"/>
<appender-ref ref="file"/>
</root>
</configuration>3.载入配置文件
在项目中创建 XxlJobConfig.class 文件：
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;
/**
* xxl-job config
*
* @author xuxueli 2017-04-28
*/
@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
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();
*/
}4.创建任务JobHandler
在项目中创建一个调度任务类，创建好后启动项目。
package com.example.taskdemo.service.jobhandler;
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.IJobHandler;
import com.xxl.job.core.handler.annotation.XxlJob;
import com.xxl.job.core.log.XxlJobLogger;
import org.springframework.stereotype.Component;
/**
* @Description 调度任务类
* @Date Created in 下午8:19 2020/2/15
* @Version 1.0
*/
@Component
public class TaskHandler extends IJobHandler {
@XxlJob("taskHandler")
@Override
public ReturnT<String> execute(String param) throws Exception {
XxlJobLogger.log("接受参数" + param +"\n执行任务");
return SUCCESS;
}
}
5.在调度任务中心配置执行器
点击执行器管理-->新增执行器 注意AppName为执行器项目应用名，即上面参数xxl.job.executor.appname=task-demo
执行器属性说明：
- AppName:是每个执行器集群的标识AppName,执行器会周期性以AppName为对象进行自动注册。可通过改配置自动发现注册成功的执行器，供任务调度时使用；
- 名称：执行器的名称，因为AppName限制字母数字等组成，可读性不强，名称为了提高执行器的可读性；
- 排序：执行器的排序，系统中需要执行器的点，例如新增，将会按照该排序读取可用的执行器列表；
- 注册方式：调度中心获取执行器地址的方式；
- 自动注册：执行器自动进行执行器注册，调度中心通过底层注册表可以动态发现执行器机器地址；
- 手动录入：人工手动录入执行器的地址信息，多地址逗号分隔，供调度中心使用；
- 机器地址：注册方式为手动录入时有效，支持人工维护执行器的地址信息；
6.创建任务
点击任务管理-->新增 执行器下拉列表选择刚新增的执行器 注意JobHandler为上面调度任务类@JobHandler(value="taskHandler")中value值
配置属性详细说明：
- 执行器：任务的绑定的执行器，任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能; 另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器, 可在 "执行器管理" 进行设置;- 任务描述：任务的描述信息，便于任务管理；- 路由策略：当执行器集群部署时，提供丰富的路由策略，包括；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所对应的任务的一次主动调度。- 任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；- 失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；（10s后自动再执行该任务）- 报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；- 负责人：任务的负责人；- 执行参数：任务执行所需的参数；（当jobhandler为相同时，则可以根据该执行参数不同处理不同的业务）
7.启动任务
任务启动后我们可以在调度日志里看调用日志情况
在这里可以看到日志打印的情况，包括定时任务执行时间，执行参数，结束时间等。
这个就很方便监督各个业务系统的调度任务情况，如果调度任务出现问题，也更容易排查是哪一天，具体是什么问题导致定时任务失败，对比quartz的话，如果出现问题的话，如果要排查的话就比较麻烦，需要到服务器上看日志，也没有图形化的界面查看。
1640
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
