工具篇-- 定时任务xxl-job

---

前言

xxl-job 是一个开源的分布式任务调度平台，旨在解决大规模分布式任务调度问题。它提供了任务管理、任务调度、任务执行、日志记录、监控报警等功能，可以帮助用户实现任务的调度和执行，并提高任务执行效率和稳定性。

---

一、xxl-job 运行：

1.1 下载并且启动：

下载及其启动 可以参考：阿里云轻量服务器–Docker安装xxl-job

1.2 项目介绍：

1.2.1 xxl-job-admin：

1.2.1.1 xxl-job-admin 作用：

xxl-job-admin 是一个分布式任务调度平台，它的主要作用是用于管理和调度任务，可以实现以下功能：

• 任务管理：对任务进行添加、编辑、删除等操作。可以配置任务的执行策略、定时触发规则等参数。

• 运行日志：监控任务的运行情况，查看任务的执行日志，包括任务的执行状态、执行时间、执行结果等信息。

• 报警通知：当任务运行出现异常情况时，可以设置报警通知机制，通知相关责任人或部门及时处理。

• 节点管理：管理任务调度平台的节点，包括添加、移除节点以及监控节点的状态。

• 可视化监控：通过可视化界面展示任务的运行情况、节点状态等信息，方便用户监控和管理任务调度。

• 任务日志管理：提供任务运行日志的查看、管理和导出功能，方便用户进行日志分析和故障排查。

1.2.1.2 xxl-job-admin 的配置：

要想启动xxl-job-admin 需要对数据库进行配置：

### xxl-job, datasource
spring.datasource.url=jdbc:mysql://localhost:3406/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=ddsoft
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

可以配置执行器连接 xxl-job-admin 的访问token：

### xxl-job, access token
xxl.job.accessToken=lgx123456

1.2.2 xxl-job-executor-samples：

xxl-job-executor-samples 提供了任务执行器的一个demo ，仿照改项目我们知道项目中如果要集成xxl-job 需要以下几个步骤：

1.2.2.1 pom 增加依赖：

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>${project.parent.version}</version>
</dependency>

jar 版本地址可以在maven 参考查找并选择：https://mvnrepository.com/search?q=xxl-job-core

1.2.2.2修改配置文件：

application.properties 修改：

xxl.job.admin.addresses=http://127.0.0.1:8082/xxl-job-admin
### xxl-job, access token 和xxl-job-admin 下application.properties的 配置的访问令牌保持一致
xxl.job.accessToken=lgx123456
### 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
xxl.job.executor.ip=172.29.8.200

1.2.2.3 增加xxljob 配置文件：

xxl-job-executor-samples 执行器：

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();
     */


}

1.2.2.4 定时任务业务示例：

package com.xxl.job.executor.service.jobhandler;

import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import java.io.BufferedInputStream;
import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Arrays;
import java.util.concurrent.TimeUnit;

/**
 * XxlJob开发示例（Bean模式）
 *
 * 开发步骤：
 *      1、任务开发：在Spring Bean实例中，开发Job方法；
 *      2、注解配置：为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")"，注解value值对应的是调度中心新建任务的JobHandler属性的值。
 *      3、执行日志：需要通过 "XxlJobHelper.log" 打印执行日志；
 *      4、任务结果：默认任务结果为 "成功" 状态，不需要主动设置；如有诉求，比如设置任务结果为失败，可以通过 "XxlJobHelper.handleFail/handleSuccess" 自主设置任务结果；
 *
 * @author xuxueli 2019-12-11 21:52:51
 */
@Component
public class SampleXxlJob {
    private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);


    /**
     * 1、简单任务示例（Bean模式）
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");

        for (int i = 0; i < 5; i++) {
            XxlJobHelper.log("beat at:" + i);
            TimeUnit.SECONDS.sleep(2);
        }
        // default success
    }


    /**
     * 2、分片广播任务
     */
    @XxlJob("shardingJobHandler")
    public void shardingJobHandler() throws Exception {

        // 分片参数
        int shardIndex = XxlJobHelper.getShardIndex();
        int shardTotal = XxlJobHelper.getShardTotal();

        XxlJobHelper.log("分片参数：当前分片序号 = {}, 总分片数 = {}", shardIndex, shardTotal);

        // 业务逻辑
        for (int i = 0; i < shardTotal; i++) {
            if (i == shardIndex) {
                XxlJobHelper.log("第 {} 片, 命中分片开始处理", i);
            } else {
                XxlJobHelper.log("第 {} 片, 忽略", i);
            }
        }

    }


    /**
     * 3、命令行任务
     */
    @XxlJob("commandJobHandler")
    public void commandJobHandler() throws Exception {
        String command = XxlJobHelper.getJobParam();
        int exitValue = -1;

        BufferedReader bufferedReader = null;
        try {
            // command process
            ProcessBuilder processBuilder = new ProcessBuilder();
            processBuilder.command(command);
            processBuilder.redirectErrorStream(true);

            Process process = processBuilder.start();
            //Process process = Runtime.getRuntime().exec(command);

            BufferedInputStream bufferedInputStream = new BufferedInputStream(process.getInputStream());
            bufferedReader = new BufferedReader(new InputStreamReader(bufferedInputStream));

            // command log
            String line;
            while ((line = bufferedReader.readLine()) != null) {
                XxlJobHelper.log(line);
            }

            // command exit
            process.waitFor();
            exitValue = process.exitValue();
        } catch (Exception e) {
            XxlJobHelper.log(e);
        } finally {
            if (bufferedReader != null) {
                bufferedReader.close();
            }
        }

        if (exitValue == 0) {
            // default success
        } else {
            XxlJobHelper.handleFail("command exit value("+exitValue+") is failed");
        }

    }


    /**
     * 4、跨平台Http任务
     *  参数示例：
     *      "url: http://www.baidu.com\n" +
     *      "method: get\n" +
     *      "data: content\n";
     */
    @XxlJob("httpJobHandler")
    public void httpJobHandler() throws Exception {

        // param parse
        String param = XxlJobHelper.getJobParam();
        if (param==null || param.trim().length()==0) {
            XxlJobHelper.log("param["+ param +"] invalid.");

            XxlJobHelper.handleFail();
            return;
        }

        String[] httpParams = param.split("\n");
        String url = null;
        String method = null;
        String data = null;
        for (String httpParam: httpParams) {
            if (httpParam.startsWith("url:")) {
                url = httpParam.substring(httpParam.indexOf("url:") + 4).trim();
            }
            if (httpParam.startsWith("method:")) {
                method = httpParam.substring(httpParam.indexOf("method:") + 7).trim().toUpperCase();
            }
            if (httpParam.startsWith("data:")) {
                data = httpParam.substring(httpParam.indexOf("data:") + 5).trim();
            }
        }

        // param valid
        if (url==null || url.trim().length()==0) {
            XxlJobHelper.log("url["+ url +"] invalid.");

            XxlJobHelper.handleFail();
            return;
        }
        if (method==null || !Arrays.asList("GET", "POST").contains(method)) {
            XxlJobHelper.log("method["+ method +"] invalid.");

            XxlJobHelper.handleFail();
            return;
        }
        boolean isPostMethod = method.equals("POST");

        // request
        HttpURLConnection connection = null;
        BufferedReader bufferedReader = null;
        try {
            // connection
            URL realUrl = new URL(url);
            connection = (HttpURLConnection) realUrl.openConnection();

            // connection setting
            connection.setRequestMethod(method);
            connection.setDoOutput(isPostMethod);
            connection.setDoInput(true);
            connection.setUseCaches(false);
            connection.setReadTimeout(5 * 1000);
            connection.setConnectTimeout(3 * 1000);
            connection.setRequestProperty("connection", "Keep-Alive");
            connection.setRequestProperty("Content-Type", "application/json;charset=UTF-8");
            connection.setRequestProperty("Accept-Charset", "application/json;charset=UTF-8");

            // do connection
            connection.connect();

            // data
            if (isPostMethod && data!=null && data.trim().length()>0) {
                DataOutputStream dataOutputStream = new DataOutputStream(connection.getOutputStream());
                dataOutputStream.write(data.getBytes("UTF-8"));
                dataOutputStream.flush();
                dataOutputStream.close();
            }

            // valid StatusCode
            int statusCode = connection.getResponseCode();
            if (statusCode != 200) {
                throw new RuntimeException("Http Request StatusCode(" + statusCode + ") Invalid.");
            }

            // result
            bufferedReader = new BufferedReader(new InputStreamReader(connection.getInputStream(), "UTF-8"));
            StringBuilder result = new StringBuilder();
            String line;
            while ((line = bufferedReader.readLine()) != null) {
                result.append(line);
            }
            String responseMsg = result.toString();

            XxlJobHelper.log(responseMsg);

            return;
        } catch (Exception e) {
            XxlJobHelper.log(e);

            XxlJobHelper.handleFail();
            return;
        } finally {
            try {
                if (bufferedReader != null) {
                    bufferedReader.close();
                }
                if (connection != null) {
                    connection.disconnect();
                }
            } catch (Exception e2) {
                XxlJobHelper.log(e2);
            }
        }

    }

    /**
     * 5、生命周期任务示例：任务初始化与销毁时，支持自定义相关逻辑；
     */
    @XxlJob(value = "demoJobHandler2", init = "init", destroy = "destroy")
    public void demoJobHandler2() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");
    }
    public void init(){
        logger.info("init");
    }
    public void destroy(){
        logger.info("destroy");
    }


}

1.2.3 xxl-job-core ：

xxl-job-admin 和 xxl-job-executor-samples 的通信：

-xxl-job-admin 和 xxl-job-executor-samples 之间通过 xxl-job-core 完成通信，其中使用的是 RPC（远程过程调用）机制。xxl-job-core 是 xxl-job 框架的核心模块，包含了一些基础功能和通用代码，用于 admin 和 executor 之间的通信。

在 xxl-job 框架中，xxl-job-admin 是任务调度中心，负责管理和调度任务，而 xxl-job-executor-samples 是任务执行器，负责执行具体的任务。这两部分通过 RPC 来进行通信，实现任务的调度和执行功能。

具体来说，xxl-job-core 中封装了一些 RPC 调用的接口和工具类，admin 和 executor 均依赖该核心模块。通过 RPC，admin 可以向 executor 发送任务执行请求，并获取执行结果。同时，executor 也可以向 admin 上报任务执行状态、日志等信息。

总的来说，xxl-job-admin 和 xxl-job-executor-samples 之间通过 xxl-job-core 完成通信，使用的是 RPC 机制。这种方式可以实现任务调度中心与任务执行器之间的高效通信和协作。

1.2.4 项目启动：

分别启动xxl-job-admin 和 xxl-job-executor-samples 登录xxl-job-admin 可以看到自动注册的执行器，以及运行示例代码：
http://localhost:port/xxl-job-admin 账号/密码 ： admin/123456
（1）执行器管理菜单下，可以看到自动注册上来的执行器：

（2）任务管理->选择示例执行器->执行一次：

（3）debug 模式下可以看到已经调到执行器服务:

（4）调度日志–>可以看到已经执行:

二、xxl-job 执行器和任务：

2.1执行器:

xxl-job 执行器（Executor）是 xxl-job 分布式任务调度平台的一个组件，用于接收任务调度中心下发的任务，并执行任务逻辑。执行器负责具体执行任务的代码逻辑，并将执行结果返回给调度中心。

以下是 xxl-job 执行器的一些特点和功能介绍：

• 分布式部署：xxl-job 执行器可以进行分布式部署，多个执行器实例共同组成一个执行器集群，提高任务执行的并发能力和稳定性。

• 任务调度：执行器接收调度中心下发的任务，按照设定的调度策略执行任务，支持单次执行、定时执行等不同的任务触发方式。

• . 任务执行：执行器获取任务后，执行任务中定义的逻辑代码，执行任务的具体功能，并将执行结果返回给调度中心，包括任务执行成功或失败的状态。

• . 日志记录：执行器会记录执行过程中的日志信息，包括任务执行状态、执行时间、执行结果等信息，方便监控和故障排查。

• . 监控报警：执行器在执行任务过程中会进行监控，当任务执行出现异常情况时，可以发送报警通知，及时处理问题。

• . 扩展点：执行器支持扩展点，可以根据需求扩展自定义任务处理逻辑、任务监控等功能，以适应不同的业务场景。

总的来说，xxl-job 执行器是 xxl-job 分布式任务调度平台中负责任务执行的核心组件，通过执行器，用户可以实现任务的调度和执行，监控任务状态和日志信息，保证任务执行的稳定性和准确性。

2.2 任务;

xxl-job-admin 中定义任务，当任务到达触发点时，通过调用执行器来最终进行业务逻辑的执行；任务到达触发点时，根据路由策略选择服务器，通过执行器 确定某个具体的执行器，通过rpc ，在具体的服务中选择bena 名称为JobHandler 中的bean 进行反射调用；
一个任务由下面部分组成：

（1）基础配置
其中基础配置 选择该任务交由哪个执行器进行任务的执行； 调度配置 任务的触发时机； 任务配置 配置任务在执行器执行具体业务逻辑的bean；
（2）高级配置：

• 路由策略，任务触发到哪台服务器执行任务：
  

• 子任务id 可以配置依赖任务；

• 调度过期策略：到了任务的执行时间，但是任务没有执行，下一次达到任务执行时，是直接忽略上次的任务，还是去补偿执行一次
  

• 阻塞处理策略：下一次达到任务执行时，上一次任务还没有执行完，对待上一次任务时，是阻塞执行，还是后面的任务不执行，还是放弃之前的任务，本次重新执行任务；
  

• 任务超时时间：0 不超时；大于0 ，任务执行的时间要在时间之内，超过这个时间意味着失败；

• 失败重试次数：任务失败最大可以重试多少次；

（3）任务启动：任务配置完成，可以在任务管理中对改任务进行启动；

三、扩展：

3.1 执行器ip 配置：

xxl.job.executor.ip ### 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 “执行器注册” 和 “调度中心请求并触发任务”；

3.1.1 Windows 网卡查询：

在 Windows 操作系统中，可以使用命令行工具 ipconfig 来查看当前系统中的网络接口信息，从而了解有多少个网卡。以下是通过 ipconfig 命令查看有多少个网卡的步骤：

• 打开命令提示符窗口，可以通过以下方法打开：

  • 按下 Win + R 组合键，输入 cmd，然后按下 Enter 键。

• . 在命令提示符窗口中，输入以下命令查看网络接口信息：

ipconfig

• 在输出结果中，你会看到每个网络接口的信息，通常以 以太网适配器 或 无线局域网适配器 开头。每个网络接口对应一个网卡，你可以根据这些信息来确定有多少个网卡。

• 如果你需要更详细的信息，可以使用以下命令来查看所有网络接口的详细信息：

ipconfig /all

3.1.2 Linux网卡查询：

在 Linux 操作系统上，你可以使用 ip 命令来查看系统中的网络接口信息，以确定有多少个网卡。以下是在 Linux 上通过 ip 命令查看有多少个网卡的步骤：

• 打开终端窗口，输入以下命令以查看网络接口信息：

ip addr

• 在输出结果中，你会看到每个网络接口的信息，包括接口名称（如 eth0、eth1、wlan0）、MAC 地址、IP 地址等。每个网络接口对应一个网卡，你可以根据这些信息来确定有多少个网卡。

• 如果你只想查看已启用的网络接口，可以使用以下命令：

ip addr show up

通过这些步骤，可以使用 ip 命令在 Linux 操作系统中查看有多少个网卡。

3.2 xxl-job与quartz 对比

xxl-job 和 Quartz 都是常见的任务调度框架，但在一些方面有不同的特点和适用场景。以下是它们之间的一些对比：

• 适用场景:

  • xxl-job 主要适用于分布式任务调度，支持分布式部署和集群化管理，适合需要大规模任务调度和分布式任务执行的场景。
  • Quartz 同样可以部署在集群中，但更适用于单机环境或小规模任务调度，适合简单的定时任务或少量任务调度。

• 分布式支持:

  • xxl-job 自身就是一个分布式任务调度平台，支持大规模分布式任务调度，具有任务分片、任务依赖等特性。
  • Quartz 需要借助集群部署或者结合其他分布式调度框架才能实现分布式任务调度。

• 监控和报警:

  • xxl-job 提供了完善的任务监控和报警机制，可以查看任务执行情况、日志、监控任务状态等。
  • Quartz 对于监控和报警功能相对简单，需要结合其他监控工具或自定义实现。

• 可视化管理:

  • xxl-job 提供了可视化的任务管理界面，用户可以方便地进行任务的添加、编辑、监控等操作。
  • Quartz 需要通过代码配置任务，没有可视化管理界面，操作相对复杂。

• 灵活性:

  • Quartz 在任务调度方面更加灵活，可以支持复杂的调度需求，定时任务表达式灵活且功能强大。
  • xxl-job 更偏向于分布式任务调度，对于数据分片，任务依赖等方面提供了更好的支持。

总的来说，如果需要分布式任务调度、大规模任务执行、监控报警等功能，可以选择使用 xxl-job；如果是单机环境下简单的任务调度或定时任务，可以选择使用 Quartz。选择合适的任务调度框架取决于具体的业务需求和环境。

---

总结：

本文对于定时任务xxl-job 的运行及其 xxl-job-admin，xxl-job-core，xxl-job-executor-samples 三个组件做了介绍；并对执行器和任务做了介绍；

参考：

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