目录
什么是xxl-job?
XXL-Job-环境搭建
1 调度中心环境要求
2.XXL-Job(源码说明)
3.初始化“调度数据库”
3启动调度中心xxl-job-admin
docker安装-配置调度中心
1.创建mysql容器,初始化xxl-job的SQL脚本
2.拉取镜像
3.创建容器
xxl-job入门案例
1.创建执行器
编辑
2.创建任务
SpringBoot项目集成xxl-job步骤
1.引入依赖
2.新增配置
3.添加配置类
4.在需要进行任务调度的方法上加上注解
5.控制台打印结果
常用路由策略演示
路由策略(轮询)-案例
路由策略(分片广播)-案例
什么是xxl-job?
xxl-job是一个轻量级分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
spring传统的定时任务@Scheduled,但是这样存在这一些问题 :
        做集群任务的重复执行问题
         cron表达式定义在代码之中,修改不方便
         定时任务失败了,无法重试也没有统计
         如果任务量过大,不能有效的分片执行
针对分布式任务调度的需求,市场上出现了很多的产品:
TBSchedule:淘宝推出的一款非常优秀的高性能分布式调度框架,目前被应用于阿里、京东、支付宝、国美等很多互联网企业的流程调度系统中。但是已经多年未更新,文档缺失严重,缺少维护。
XXL-Job:大众点评的分布式任务调度平台,是一个轻量级分布式任务调度平台, 其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
Elastic-job:当当网借鉴TBSchedule并基于quartz 二次开发的弹性分布式任务调度系统,功能丰富强大,采用zookeeper实现分布式协调,具有任务高可用以及分片功能。
Saturn: 唯品会开源的一个分布式任务调度平台,基于Elastic-job,可以全域统一配置,统一监 控,具有任务高可用以及分片功能
源码地址:xxl-job: 一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
XXL-Job-环境搭建
1 调度中心环境要求
-  
Maven3+
 -  
Jdk1.8+
 -  
Mysql5.7+
 
2.XXL-Job(源码说明)
3.初始化“调度数据库”
1请下载项目源码并解压,获取 “调度数据库初始化SQL脚本” 并执行即可。
位置:/xxl-job/doc/db/tables_xxl_job.sql 共8张表

- xxl_job_lock:任务调度锁表;
- xxl_job_group:执行器信息表,维护任务执行器信息;
- xxl_job_info:调度扩展信息表: 用于保存XXL-JOB调度任务的扩展信息,如任务分组、任务名、机器地址、执行器、执行入参和报警邮件等等;
- xxl_job_log:调度日志表: 用于保存XXL-JOB任务调度的历史信息,如调度结果、执行结果、调度入参、调度机器和执行器等等;
- xxl_job_logglue:任务GLUE日志:用于保存GLUE更新历史,用于支持GLUE的版本回溯功能;
- xxl_job_registry:执行器注册表,维护在线的执行器和调度中心机器地址信息;
- xxl_job_user:系统用户表;
调度中心支持集群部署,集群情况下各节点务必连接同一个mysql实例;
如果mysql做主从,调度中心集群节点务必强制走主库;
2配置部署“调度中心”
调度中心项目:xxl-job-admin
作用:统一管理任务调度平台上调度任务,负责触发调度执行,并且提供任务管理平台。
步骤一:调度中心配置
调度中心配置文件地址:/xxl-job/xxl-job-admin/src/main/resources/application.properties

根据项目进行修改配置文件。
3启动调度中心xxl-job-admin
 
启动成功,访问http://localhost:8080/xxl-job-admin/,默认登录账号密码 “admin/123456”, 登录后运行界面如下图所示。

上述是测试环境在本机进行安装测试,实际开发可以使用docker进行安装:
docker安装-配置调度中心
1.创建mysql容器,初始化xxl-job的SQL脚本
docker run -p 3306:3306 --name mysql57 -v /opt/mysql/conf:/etc/mysql -v /opt/mysql/logs:/var/log/mysql -v /opt/mysql/data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=root -d mysql:5.7 
2.拉取镜像
docker pull xuxueli/xxl-job-admin:2.3.0 
3.创建容器
docker run -e PARAMS="--spring.datasource.url=jdbc:mysql://192.168.200.130:3306/xxl_job?Unicode=true&characterEncoding=UTF-8 --spring.datasource.username=root --spring.datasource.password=root" -p 8888:8080 -v /tmp:/data/applogs --name xxl-job-admin --restart=always -d xuxueli/xxl-job-admin:2.3.0 
注意:记得修改上述docker命令中的数据库连接信息

使用docker ps命令可以查看是否运行成功

xxl-job入门案例
1.创建执行器
-  
执行器:任务的绑定的执行器,任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能;
 -  
另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器
 


以下是执行器的属性说明:
| 属性名称 | 说明 | 
|---|---|
| AppName | 是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用; | 
| 名称 | 执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性; | 
| 排序 | 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表; | 
| 注册方式 | 调度中心获取执行器地址的方式; | 
| 机器地址 | 注册方式为"手动录入"时有效,支持人工维护执行器的地址信息; | 
自动注册和手动注册的区别和配置
2.创建任务
登录调度中心,点击下图所示“新建任务”按钮,新建示例任务

基础配置
-  
执行器:每个任务必须绑定一个执行器, 方便给任务进行分组
 -  
任务描述:任务的描述信息,便于任务管理;
 -  
负责人:任务的负责人;
 -  
报警邮件:任务调度失败时邮件通知的邮箱地址,支持配置多邮箱地址,配置多个邮箱地址时用逗号分隔
 -  
调度类型:
-  
无:该类型不会主动触发调度;
 -  
CRON:该类型将会通过CRON,触发任务调度;
 -  
固定速度:该类型将会以固定速度,触发任务调度;按照固定的间隔时间,周期性触发;
 
 -  
 -  
运行模式:
 -  
JobHandler:运行模式为 "BEAN模式" 时生效,对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值;
 -  
执行参数:任务执行所需的参数;
 -  
BEAN模式:任务以JobHandler方式维护在执行器端;需要结合 "JobHandler" 属性匹配执行器中任务;
 -  
阻塞处理策略
 -  
阻塞处理策略:调度过于密集执行器来不及处理时的处理策略;
 -  
单机串行(默认):调度请求进入单机执行器后,调度请求进入FIFO(First Input First Output)队列并以串行方式运行;
 -  
丢弃后续调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,本次请求将会被丢弃并标记为失败;
 -  
覆盖之前调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,将会终止运行中的调度任务并清空队列,然后运行本地调度任务;
 -  
路由策略
当执行器集群部署时,提供丰富的路由策略,包括;
 -  
FIRST(第一个):固定选择第一个机器;
 -  
LAST(最后一个):固定选择最后一个机器;
 -  
ROUND(轮询)
 -  
RANDOM(随机):随机选择在线的机器;
 -  
CONSISTENT_HASH(一致性HASH):每个任务按照Hash算法固定选择某一台机器,且所有任务均匀散列在不同机器上。
 -  
LEAST_FREQUENTLY_USED(最不经常使用):使用频率最低的机器优先被选举;
 -  
LEAST_RECENTLY_USED(最近最久未使用):最久未使用的机器优先被选举;
 -  
FAILOVER(故障转移):按照顺序依次进行心跳检测,第一个心跳检测成功的机器选定为目标执行器并发起调度;
 -  
BUSYOVER(忙碌转移):按照顺序依次进行空闲检测,第一个空闲检测成功的机器选定为目标执行器并发起调度;
 -  
SHARDING_BROADCAST(分片广播):广播触发对应集群中所有机器执行一次任务,同时系统自动传递分片参数;可根据分片参数开发分片任务;
 
SpringBoot项目集成xxl-job步骤
1.引入依赖
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!--xxl-job-->
    <dependency>
        <groupId>com.xuxueli</groupId>
        <artifactId>xxl-job-core</artifactId>
        <version>2.3.0</version>
    </dependency>
</dependencies> 
2.新增配置
server:
  port: 8881
xxl:
  job:
    admin:
      addresses: http://27.0.0.1:8888/xxl-job-admin
    executor:
      appname: xxl-job-executor-sample
      port: 9999
 
3.添加配置类
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.accessToken}")
//    private String accessToken;
    @Value("${xxl.job.executor.appname}")
    private String appname;
//    @Value("${xxl.job.executor.address}")
//    private String address;
//    @Value("${xxl.job.executor.ip}")
//    private String ip;
    @Value("${xxl.job.executor.port}")
    private int port;
//    @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.setAddress(address);
//        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.在需要进行任务调度的方法上加上注解
@XxlJob(“demoJobHandler”),其中demoJobHandler就是新增调度任务的时候所填写的JobHandler对应的名称。
@Component
public class SampleXxlJob {
    private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
    /**
     * 1、简单任务示例(Bean模式)
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        System.out.println("XXL-JOB, Hello World.");
      
    }
} 
5.控制台打印结果

常用路由策略演示
路由策略(轮询)-案例
1.修改任务为轮询

2.修改yml配置文件
server:
  port: ${port:8881}
xxl:
  job:
    admin:
      addresses: http://127.0.0.1:8888/xxl-job-admin
    executor:
      appname: xxl-job-executor-sample
      port: ${executor.port:9999} 
3.修改代码验证
@Component
public class SampleXxlJob {
    private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
    @Value("${server.port}")
    private String port;
    /**
     * 1、简单任务示例(Bean模式)
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        System.out.println("端口号为"+port+"XXL-JOB, Hello World.");
    }
}
 
4.启动多个服务进行测试(本机)


5.控制台验证

路由策略(分片广播)-案例
1.分片逻辑
执行器集群部署时,任务路由策略选择”分片广播”情况下,一次任务调度将会广播触发对应集群中所有执行器执行一次任务.(花呗通知所有用户定时还款)
        
使用单个执行器(实例)去执行所有的任务效率就很慢,所以使用集群同时执行任务,提高执行效率。那么xxl-job是如何实现的呢?

xxl-job采用对任务项进行取模的方式将任务分配给不同的分片,所有分片同时去对任务项进行执行。
下述有一个简单的需求案例:
需求:让两个节点(服务器)同时执行10000个任务,每个节点分别执行5000个任务
1:创建分片执行器

2.创建任务,路由策略为分片广播

3.修改yml配置
server:
  port: ${port:8881}
xxl:
  job:
    admin:
      addresses: http://127.0.0.1:8888/xxl-job-admin
    executor:
      appname: xxl-job-sharding-sample
      port: ${executor.port:9999} 
4.代码实现
@Component
public class SampleXxlJob {
    private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
    @Value("${server.port}")
    private String port;
    /**
     * 1、简单任务示例(Bean模式)
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        System.out.println("端口号为"+port+"XXL-JOB, Hello World.");
    }
    /**
     * 2、分片广播任务
     */
     @XxlJob("shardingJobHandler")
    public void shardingJobHandler(){
        //分片的参数
        int shardIndex = XxlJobHelper.getShardIndex();
        int shardTotal = XxlJobHelper.getShardTotal();
        //业务逻辑
        List<Integer> list = getList();
        for (Integer integer : list) {
            if(integer % shardTotal == shardIndex){
                System.out.println("当前第"+shardIndex+"分片执行了,任务项为:"+integer);
            }
        }
    }
    public List<Integer> getList(){
        List<Integer> list = new ArrayList<>();
        for (int i = 0; i < 10000; i++) {
            list.add(i);
        }
        return list;
    }
} 
5.启动执行结果
可以得出,分别执行了5000次,这样就可以发现当一个服务进行集群部署的时候,通过xxl-job的分片广播可以同时对任务进行执行,从而提高执行效率。


















