xxl-job（二）springboot集成xxl-job

迷南。 2023-01-22 15:46 110阅读 0赞

xxl-job的集成分服务端和客户端。

一、服务端：

1、首先，下载xxl-job源码，

码云地址：[https://gitee.com/xuxueli0323/xxl-job][https_gitee.com_xuxueli0323_xxl-job]

gitHub地址：[https://github.com/xuxueli/xxl-job][https_github.com_xuxueli_xxl-job]

下载后解压得到以下文件：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70][]

2、SQL执行：sql文件为：xxl-job/doc/db/tables\_xxl\_job.sql，在mysql数据库中执行该sql，能生成新的数据库xxl-job及相关的数据库表xxl\_job\_\*。目前从源码来看，暂时只支持mysql数据库，如需支持其他数据库，可在源码上进行相关的修改：如mybatis的配置、sql语句等。这里我修改了源码的SQL，修改数据库名为test了。

3、xxl-job-admin的application.properties配置文件修改：

主要修改spring.datasource.url、spring.datasource.username、spring.datasource.password为自己的配置，server.port、xxl-job-admin等按需修改即可。如我还修改了端口号为7777。

4、部署：xxl-job-core为核心代码块，xxl-job-admin为任务调度中心管理模块，部署的话，部署xxl-job-admin即可。启动成功后，可通过访问http://localhost:7777/xxl-job-admin来对任务调度中心进行访问。用户名密码默认为：admin/123456

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70 1][]

二、客户端：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70 2][]

1、pom：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>org.example</groupId>
        <artifactId>job-client</artifactId>
        <version>1.0-SNAPSHOT</version>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.4.1.RELEASE</version>
        </parent>
        <dependencies>
            <dependency>
                <groupId>com.xuxueli</groupId>
                <artifactId>xxl-job-core</artifactId>
                <version>2.3.0</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
        </dependencies>
    
    </project>

2、application.properties：

xxl.job.admin.addresses = http://127.0.0.1:7777/xxl-job-admin
    xxl.job.executor.ip =
    xxl.job.executor.port = 9999
    xxl.job.executor.address =
    xxl.job.executor.logpath = /data/applogs/xxl-job/jobhandler
    xxl.job.executor.appname = test-job
    xxl.job.accessToken =
    xxl.job.executor.logretentiondays: 1
    server.port= 6666

3、XxlJobConfig，从下载的xxl-job源码的/xxl-job-executor-samples/xxl-job-executor-sample-springboot下的src\\main\\java\\com\\xxl\\job\\executor\\core\\config的XxlJobConfig.java直接复制过来即可。如我的：

package com.job.client.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、启动类：

package com.job.client;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class ClientStart {
    
        public static void main(String args[]){
            SpringApplication.run(ClientStart.class,args);
        }
    }

5、自定义的job，如我写了两个：

package com.job.client.jobhandle;
    
    import com.xxl.job.core.biz.model.ReturnT;
    import com.xxl.job.core.handler.IJobHandler;
    import com.xxl.job.core.handler.annotation.XxlJob;
    import org.springframework.stereotype.Component;
    
    import java.util.Date;
    
    import static com.xxl.job.core.biz.model.ReturnT.SUCCESS;
    
    @Component
    public class TestOneHandler {
    
        @XxlJob("TestOneHandler")
        public ReturnT<String> jobDemo(String s) throws Exception {
            System.out.println("TestOneHandler执行次"+new Date());
            return SUCCESS;
        }
    }

job2:

package com.job.client.jobhandle;
    
    import com.xxl.job.core.biz.model.ReturnT;
    import com.xxl.job.core.handler.annotation.XxlJob;
    import org.springframework.stereotype.Component;
    
    import java.util.Date;
    
    import static com.xxl.job.core.biz.model.ReturnT.SUCCESS;
    
    @Component
    public class TestTwoHandler {
    
        @XxlJob("TestTwoHandler")
        public ReturnT<String> jobDemo(String s) throws Exception {
            System.out.println("2***TestTwoHandler执行次"+new Date());
            return SUCCESS;
        }
    }

三、测试：

1、配置执行器：只需要配置一次。点击任务调度中心的执行器管理：

![20210520170406436.png][]

在列表中对默认的执行器点击编辑

（1）AppName为客户端配置的xxl.job.executor.appname值

（2）名称：自定义

（3）注册方式：如果选择自动注册，机器地址会自动去获取；如果选择手动注册，机器地址需要自己填写。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70 3][]

2、配置任务：有多少个Job配置多少个。点击任务管理：

![2021052017072320.png][]

在右侧新增一个，如我：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70 4][]

重点注意这个JobHandler，需要和代码中的注解保持一致。点保存后可以在操作中选择执行一次、启动、停止等操作。

我新增了两个任务，一个设置每一分钟执行一次，一个设置每两分钟执行一次。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70 5][]

看下后台：任务执行正常

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70 6][]

在调度日志中也能看到：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70 7][]

服务端和客户端如果有一个挂了，直接重启即可，不需要重启另外一个。

[https_gitee.com_xuxueli0323_xxl-job]: https://gitee.com/xuxueli0323/xxl-job
[https_github.com_xuxueli_xxl-job]: https://github.com/xuxueli/xxl-job
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70]: /images/20221020/00c1edfae67545e8a8a37d4a41a6c53d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70 1]: /images/20221020/5ed6b1525af64778b973475460440ec8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70 2]: /images/20221020/95a174af77004192a7290bac1bdce8f6.png
[20210520170406436.png]: /images/20221020/e808bdf157ba46d69802202fc95b22af.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70 3]: /images/20221020/580b0e0832604ed4a760fc68b18be9f4.png
[2021052017072320.png]: /images/20221020/afe12b82b2e04d11800fa3ae8a75fe07.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70 4]: /images/20221020/2d848c0db0504d1ba1884e1875c8ffcf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70 5]: /images/20221020/049b78f53c4a4534baeda33c41de665f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70 6]: /images/20221020/cc029c64eda24113be692eacfa35abc9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dfdF95X3k_size_16_color_FFFFFF_t_70 7]: /images/20221020/573b805cd9d34d979672dbce5504fe34.png