XXL-JOB学习笔记

💡XXL-JOB

📝 总结

1. 简介

一个分布式任务调度平台。

2. xxl-job使用

1. xxl-job部署

1. 通过github地址下载XXL-JOB源码
    a. https://github.com/xuxueli/xxl-job
    b. 源码内容如3.编译源码所示

2. 在idea中配置xxl-job-admin服务

##此处为下载的源码xxl-job-admin的application.properties配置

## 配置/xxl-job/xxl-job-admin/src/main/resources/application.properties
## 调度中心JDBC链接的数据库为a中所创建的数据库
spring.datasource.url=jdbc:mysql://localhost/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
## 此处的username与password需要根据本地数据库的具体内容进行修改
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

### 报警邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@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

### 调度中心通讯TOKEN   访问令牌   [选填]：非空时启用；
xxl.job.accessToken=

### 调度中心国际化配置 [必填]： 默认为 "zh_CN"/中文简体, 可选范围为 "zh_CN"/中文简体, "zh_TC"/中文繁体 and "en"/英文；
xxl.job.i18n=zh_CN

## 调度线程池最大线程配置【必填】
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100

### 调度中心日志表数据保存天数 [必填]：过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
xxl.job.logretentiondays=30

3. 初始化数据库

//调度数据库初始化脚本（从官方源地址下载XXL-JOB代码，代码中sql脚本存放位置）
//在使用时需在本地数据库中，运行此脚本
/xxl-job/doc/db/tables_xxl_job.sql
数据库表：
- 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：系统用户表；

4. 调试完成后

  a. 在浏览器中输入：http://localhost:8080/xxl-job-admin/
  b. 默认账户密码：admin/123456

2. springboot整合xxl-job

1. 创建一个springboot项目

2. 部署admin管理平台
	a.admin部署参考1. xxl-job部署中内容
	b.将xxl-job-admin打包成为jar模式，部署进springboot项目当中
**注意  admin   可以直接在源码中运行，也可以通过命令行启动jar包的方式启动调度平台**

3. 配置文件内容

## 此处为自己创建的springboot项目的配置文件

# web port
server.port=8001
# 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"
## job任务管理地址，将job注入在这个地址中
## xxl-job的地址，如果有多个地址，用逗号隔开
xxl.job.admin.addresses=http://localhost:8080/xxl-job-admin
### xxl-job, access token
xxl.job.accessToken=
### xxl-job executor appname
## 执行器的名字
## 此处执行器的名字需要同XXL-JOB中设置的执行器名称一致
xxl.job.executor.appname=myapp
### xxl-job executor registry-address: default use address to registry , otherwise use ip:port if address is null
xxl.job.executor.address=
### xxl-job executor server-info
## 执行器ip，选填，为空会自动获取ip
xxl.job.executor.ip=
## 执行器的端口，为空默认为9999
xxl.job.executor.port=9999
### xxl-job executor log-path
## 执行器运行日志文件存储磁盘路径，非必填项，为空使用默认路径
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### xxl-job executor log-retention-days
## 执行器日志保存天数，选填，值大于3时生效
xxl.job.executor.logretentiondays=30
#### xxl-job, access token
#xxl.job.accessToken=/data/applogs/xxl-job/jobhandler/

4. 执行器组件配置

package com.example.demo.demo01.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.ComponentScan;
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;


    /**
     * @Description 执行器配置文件
     * @return
     */
    @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();
     */
}

5. 创建一个job

//此任务需要加@Component 可进行自动注入的注解
//否则调度中心查询不到该任务
@Component
public class DemoJobHandler {
    //使用XxlJob注解中的value与调度中心任务中的JobHandler一致
    @XxlJob("demoJobHandler")
    public ReturnT<String> demoJobHandler(String param) throws InterruptedException {
        for (int i = 0; i < 5; i++) {
            TimeUnit.SECONDS.sleep(2);
            System.out.println("任务成功执行");
        }
        System.out.println("任务执行结束");
        return SUCCESS;
    }

}

3. 管理平台操作

1. 新增执行器

appName：新增执行器中的appName需同创建的springboot项目中的配置文件中配置的appName的内容一致，
机器地址：例如：http://10.141.62.58:9999
    （9999为端口号与springboot项目的配置文件中的xxl.job.executor.port=9999一致）

2. 新增任务（job）

在调度平台中的任务管理处新增job
a、可对执行器进行选择
b、填写相应的任务描述、负责人和报警邮件
c、调度配置中的调度类型有：无、固定速度、cron（需填写正确的cron表达式）
d、任务配置：
运行模式：
    GLUE模式，此模式可直接在调度中心编写需要进行定时的任务代码
    BEAN模式，需填写正确的的jobHander（此处jobHander会扫描执行器对应的spring boot项目下是否有对应的@XxlJob(value)，若没有对应job，那么任务执行会报错）
任务参数填写，项目获取后获得对象为String类型
    java代码中可通过以下代码获取该任务参数
    String param = XxlJobHelper.getJobParam();
e、高级配如下5 6 所示

3. 任务操作

调度平台可对任务进行如上图所示操作

4. 日志信息

调度平台可在调度日志中查看任务执行日志
执行日志需要通过XxlJobLogger.log打印执行日志
调度结果：200为成功，500或其他表示失败

5. 运行报表

此处可查看所有任务的日期分布图和成功比例图

3. 源码包介绍

  a. xxl-job-admin：调度中心
  b. xxl-job-core：公共依赖
  c. xxl-job-executor-samples：执行Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）

4. 工作原理

  1. 注册线程到执行器管理
  2. 任务管理到下发任务执行服务

5. 路由策略

  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(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；

6. 阻塞处理策略

a. 单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
b. 丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
c. 覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；

本文章参考XXL-JOB官方文档：XXL-JOB文档