分布式任务调度平台 XXL-JOB

一、概述

1.1 什么是任务调度

        我们可以思考一下下面业务场景的解决方案，以下的场景就是任务调度所需要解决的问题，任务调度是为了自动完成特定任务，在约定的特定时刻去执行任务的过程。

        1、某电商平台需要每天上午 10 点，下午 3 点，晚上 8 点发放一批优惠券。

        2、某银行系统需要在信用卡到期还款日的前三天进行短信提醒。

        3、某财务系统需要在每天凌晨 0:10 分结算前一天的财务数据，统计汇总。

1.2 为什么需要分布式调度

        使用 Spring 中提供的注解 @Scheduled，也能实现调度的功能，只需要在业务类中方法中贴上这个注解，然后在启动类上加上 @EnableScheduling 注解即可，如下：

@Scheduled(cron = "0/20 * * * * ? ")
public void doWork(){
 	//doSomething   
}

        感觉 Spring 给我们提供的这个注解可以完成任务调度的功能，好像已经完美解决问题了，为什么还需要分布式呢？主要有如下这几点原因：

        1、高可用：单机版的定式任务调度只能在一台机器上运行，如果程序或者系统出现异常就会导致功能不可用。

        2、防止重复执行：在单机模式下，定时任务是没什么问题的。但当我们部署了多台服务，同时又每台服务又有定时任务时，若不进行合理的控制在同一时间，只有一个定时任务启动执行，这时，定时执行的结果就可能存在混乱和错误了。

        3、单机处理极限：原本一分钟内需要处理一万个订单，但是现在需要一分钟内处理十万个订单；原来一个统计需要一小时，现在业务方需要十分钟就统计出来。你也许会说，你也可以多线程、单机多进程处理。的确，多线程并行处理可以提高单位时间的处理效率，但是单机能力毕竟有限（主要是 CPU、内存和磁盘），始终会有单机处理不过来的情况。

1.3 XXL-JOB 介绍

        XXL-Job 是大众点评的分布式任务调度平台，是一个轻量级分布式任务调度平台, 其核心设计目标是开发迅速、学习简单、轻量级、易扩展。官网地址在这，系统的架构图如下所示：

        将调度行为抽象形成 “调度中心” 公共平台，而平台自身并不承担业务逻辑，“调度中心” 负责发起调度请求。

        将任务抽象成分散的 JobHandler，交由 “执行器” 统一管理，“执行器” 负责接收调度请求并执行对应的 JobHandler 中业务逻辑。

        因此，“调度” 和 “任务” 两部分可以相互解耦，提高系统整体稳定性和扩展性。

二、快速入门

2.1 下载源码

        gitHub 的下载地址在这，码云的下载地址在这，推荐使用码云下载，如下图：

2.2 初始化调度数据库

        解压下载好的项目源码，执行 “调度数据库初始化SQL脚本” 并执行，如下图：

        执行完毕后，创建的表结构如下所示： 

2.3 编译源码

        解压源码，按照 maven 格式将源码导入 IDE, 使用 maven 进行编译即可，源码结构如下：

2.4 配置部署调度中心

2.4.1 调度中心配置

        修改 xxl-job-admin 子模块的配置文件 application.properties，把数据库账号密码配置上，如下图：

2.4.2 部署项目

        运行 xxl-job-admin 子模块的 XxlJobAdminApplication 类即可，如下图：

        启动成功后，访问调度中心地址：http://localhost:8080/xxl-job-admin，如下图：

        默认登录账号 “admin/123456”，登录后运行界面如下图所示：

        至此 “调度中心” 项目已经部署成功。

2.5 配置部署执行器项目

2.5.1 添加 Maven 依赖

        创建一个新的 SpringBoot 项目并且添加如下依赖：

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.3.1</version>
</dependency>

2.5.2 执行器配置

        在 application.properties 中添加如下配置：

server.port=8081

### 调度中心部署根地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=default_token
### 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-sample
### 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
xxl.job.executor.address=
### 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
xxl.job.executor.ip=127.0.0.1
### 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
xxl.job.executor.port=9999
### 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
xxl.job.executor.logretentiondays=30

2.5.3 添加执行器配置

        创建 XxlJobConfig 配置类对象，代码如下：

package org.example.config;

import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class XxlJobConfig {
    @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() {
        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;
    }
}

2.5.4 添加任务处理类

        创建一个任务处理类，交给 Spring 容器管理，在处理方法上贴上 @XxlJob 注解，代码如下：

package org.example.job;

import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.stereotype.Component;

import java.util.Date;

@Component
public class SimpleXxlJob {
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        System.out.println("执行定时任务,执行时间:"+new Date());
    }
}

2.6 运行演示

2.6.1 任务配置和执行

        登录调度中心，在任务管理中新增任务，配置内容如下:

        新增后界面如下：

        接着启动定时调度任务，如下图：

2.6.2 查看日志

        在调度中心的调度日志中就可以看到，任务的执行结果

        管控台也可以看到任务的执行信息，如下：

2.7 GLUE 模式(Java)

        任务以源码方式维护在调度中心，支持通过 Web IDE 在线更新，实时编译和生效，因此不需要指定 JobHandler。

        GLUE 模式(Java) 运行模式的任务实际上是一段继承自 IJobHandler 的 Java 类代码，它在执行器项目中运行，可使用 @Resource 或 @Autowire 注入执行器里中的其他服务。

        在我们新建的 SpringBoot 工程中添加一个 HelloService 类，代码如下：

@Service
public class HelloService {
    public void methodA(){
        System.out.println("执行 MethodA 的方法");
    }
    public void methodB(){
        System.out.println("执行 MethodB 的方法");
    }
}

        在任务管理中新增调度配置，如下图：

        然后通过 GLUE IDE 在线编辑代码，如下图：

        编写内容如下，就是引入我们新建工程的 service 类，然后调用 service 类里面的方法。注意需要引入相关的依赖，别写错了。

package com.xxl.job.service.handler;

import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.IJobHandler;
import org.example.service.HelloService;
import org.springframework.beans.factory.annotation.Autowired;

public class DemoGlueJobHandler extends IJobHandler {

	@Autowired
    private HelloService helloService;
  
    @Override
    public void execute() throws Exception {
        helloService.methodA();
    }

}

        启动工程，并启动调度任务，如下图，可以看到，调用成功了。

2.8 执行器集群

2.8.1 集群环境搭建

        在 IDEA 中设置新建的 SpringBoot 项目运行开启多个集群，如下图：

        启动两个 SpringBoot 程序，但是需要修改 Tomcat 端口和执行器端口。

        Tomcat 端口 8091 程序的命令行参数如下：

-Dserver.port=8091 -Dxxl.job.executor.port=9998

        Tomcat 端口 8092 程序的命令行参数如下：

-Dserver.port=8092 -Dxxl.job.executor.port=9999

        在任务管理中，修改路由策略，修改成轮询，如下图：

        重新启动调度任务，我们可以看到效果是：定时任务会在这两台机器中进行轮询的执行，8091 端口的控制台日志如下：

        8092 端口的控制台日志如下：

        可以看到，集群达到了轮询的效果。

2.8.2 调度路由算法讲解

        当执行器集群部署时，提供丰富的路由策略，包括：

        1、FIRST（第一个）：固定选择第一个机器

        2.、LAST（最后一个）：固定选择最后一个机器

        3.、ROUND（轮询）：依次的选择在线的机器发起调度

        4.、RANDOM（随机）：随机选择在线的机器

        5.、CONSISTENT_HASH（一致性 HASH）：每个任务按照 Hash 算法固定选择某一台机器，且所有任务均匀散列在不同机器上。

        6.、LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举。

        7.、LEAST_RECENTLY_USED（最近最久未使用）：最久未使用的机器优先被选举。

        8.、FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度。

        9.、BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度。

        10.、SHARDING_BROADCAST（分片广播）：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务。

三、分片功能讲解

3.1 案例需求讲解

        我们现在实现这样的需求：在指定节假日，需要给平台的所有用户去发送祝福的短信。

3.1.1 初始化数据

        在 mysql 数据库中数据库脚本，下载地址在这，下载完毕后执行完的效果如下：

3.1.2 集成 Druid 和 MyBatis 

        在 SpringBoot 工程中的 pom.xml 中添加如下的依赖：

<!--MyBatis驱动-->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.2.0</version>
</dependency>
<!--mysql驱动-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!--lombok依赖-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <scope>provided</scope>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.10</version>
</dependency>

        在 application.properties 中添加如下的配置信息

spring.datasource.url=jdbc:mysql://localhost:3306/xxl_job_demo?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=UTF-8
spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.username=root
spring.datasource.password=123456

        添加实体类，代码如下：

package org.example.entity;

import lombok.Getter;
import lombok.Setter;

@Setter
@Getter
public class UserMobilePlan {
    private Long id;//主键
    private String username;//用户名
    private String nickname;//昵称
    private String phone;//手机号码
    private String info;//备注
}

         添加 Mapper 处理类，代码如下：

package org.example.mapper;

import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;
import org.example.entity.UserMobilePlan;

import java.util.List;

@Mapper
public interface UserMobilePlanMapper {
    @Select("select * from t_user_mobile_plan")
    List<UserMobilePlan> selectAll();
}

3.1.3 业务功能实现

        任务处理方法实现的代码如下：

package org.example.job;

import com.xxl.job.core.handler.annotation.XxlJob;
import org.example.entity.UserMobilePlan;
import org.example.mapper.UserMobilePlanMapper;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import java.util.Date;
import java.util.List;
import java.util.concurrent.TimeUnit;

@Component
public class SimpleXxlJob {
    @Resource
    UserMobilePlanMapper userMobilePlanMapper;
    @XxlJob("sendMsgHandler")
    public void sendMsgHandler() throws Exception{
        List<UserMobilePlan> userMobilePlans = userMobilePlanMapper.selectAll();
        System.out.println("任务开始时间:"+new Date()+",处理任务数量:"+userMobilePlans.size());
        Long startTime = System.currentTimeMillis();
        userMobilePlans.forEach(item->{
            try {
                //模拟发送短信动作
                TimeUnit.MILLISECONDS.sleep(10);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        });
        System.out.println("任务结束时间:"+new Date());
        System.out.println("任务耗时:"+(System.currentTimeMillis()-startTime)+"毫秒");
    }
}

        任务配置信息如下图：

3.2 分片概念讲解 

        在我们的案例中有 2000+ 条数据，如果不采取分片形式的话，任务只会在一台机器上执行，这样的话需要 30+ 秒才能执行完任务，如上图。

        如果采取分片广播的形式的话，一次任务调度将会广播触发对应集群中所有执行器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务。获取分片参数方式：

// 当前分片的索引
int shardIndex = XxlJobHelper.getShardIndex();

// 分片的总数
int shardTotal = XxlJobHelper.getShardTotal();

        通过这两个参数，我们可以通过求模取余的方式，分别查询，分别执行，这样的话就可以提高处理的速度。

        之前 2000+ 条数据只在一台机器上执行需要 30+ 秒才能完成任务，分片后，有两台机器可以共同完成 2000+ 条数据，每台机器处理 1000+ 条数据，这样的话只需要 15+ 秒就能完成任务。

3.3 案例改造成任务分片

        首先在 Mapper 中增加查询方法，代码如下：

@Mapper
public interface UserMobilePlanMapper {
    @Select("select * from t_user_mobile_plan")
    List<UserMobilePlan> selectAll();

    @Select("select * from t_user_mobile_plan where mod(id,#{shardingTotal})=#{shardingIndex}")
    List<UserMobilePlan> selectByMod(@Param("shardingIndex") Integer shardingIndex, @Param("shardingTotal")Integer shardingTotal);
}

        在 SimpleXxlJob 任务类中新添加一个方法，代码如下：

@Component
public class SimpleXxlJob {
    @XxlJob("sendMsgShardingHandler")
    public void sendMsgShardingHandler() throws Exception{
        System.out.println("任务开始时间:"+new Date());
        int shardTotal = XxlJobHelper.getShardTotal();
        int shardIndex = XxlJobHelper.getShardIndex();
        List<UserMobilePlan> userMobilePlans = null;
        if(shardTotal==1){
            // 如果没有分片就直接查询所有数据
            userMobilePlans = userMobilePlanMapper.selectAll();
        }else{
            userMobilePlans = userMobilePlanMapper.selectByMod(shardIndex,shardTotal);
        }
        System.out.println("处理任务数量:"+userMobilePlans.size());
        Long startTime = System.currentTimeMillis();
        userMobilePlans.forEach(item->{
            try {
                TimeUnit.MILLISECONDS.sleep(10);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        });
        System.out.println("任务结束时间:"+new Date());
        System.out.println("任务耗时:"+(System.currentTimeMillis()-startTime)+"毫秒");
    }
}

        任务配置信息如下图：

        启动集群，并执行一次调度任务，打印结果如下图，可以看到，两台机器分别执行了一次发送短信的任务，在 15s 左右就执行完了任务。