【含完整代码】Java定时任务之xxl-job[超详细]

Bertha 。 2024-04-22 15:25 56阅读 0赞

## 前言 ##

**个人博客：**[www.wdcdbd.com][]

在Java中使用定时任务是一件很常见的事情，比如使用定时任务在**什么时间**，**什么时候**，去发布一些信息，或者去查询一些日志等相关的代码。这时，我们就要开发定时任务这中功能来实现此案例。而Java常见的定时任务一般有6种，**JDK自带Timer实现，****Quartz框架集成实现**，**spring自带的Spring Task等** 剩下的就不说了，具体想要了解可以去百度搜索，而今天要讲的是Java定时任务**神器：** **xxl-Job——轻量级分布式任务调度平台。**

## XXl-Job ##

开源xxl-job： [https://gitee.com/xuxueli0323/xxl-job][https_gitee.com_xuxueli0323_xxl-job]

XXL-JOB是一个轻量级分布式任务调度平台。特点是平台化，易部署，开发迅速、学习简单、轻量级、易扩展。由调度中心和执行器功能完成定时任务的执行。调度中心负责统一调度，执行器负责接收调度并执行。

因为此文章是针对小白来讲述的，所以会使用大量的图片和代码，以便讲的更加**详细**，**易懂**，所以会有很多小废话。话不多说，直接上代码讲解。

## 一、Gitee下载开源框架XXl-job ##

### 1、拉取xxl-job代码 ###

首先去上述的gitee拉取开源的xxl-job代码，千万不要选择master分支，要选择稳定的版本，这里我选择2.2.0来做演示。

![290e61a111bf42a38ac8c48df4d1ad62.png][]

去自己的idea中拉取gitee

![f1454ae9dc724253835e3d72071834ac.png][]

![231886edc3ac45398b94cbee16a32eb7.png][]

拉取好之后，就是下述图片的样式，其中最主要的内容就是admin，等到最后，我会单独讲解xxl-job框架中所有的相关内容都是什么意思。现在先按照步骤做即可

![3d2f1c605f374b889c61d0149f8779b8.png][]

## 二、在使用xxl-job时所以要了解的知识(重要) ##

### 1、所要了解的知识 ###

> xxl-job共分为3大部分：任务调度器平台、任务执行器、任务处理器(jobHandler)、
> 
> **任务调度器平台**: 就是上述拉取下来的代码中的xxl-job-admin项目，这个项目就是任务调度平台。我们只需要配置一下就可以有自己的一个平台环境。而这个人任务调度器平台我们就可以理解为**eureka(注册中心)**
> 
> **任务执行器：**执行任务处理器
> 
> **任务处理器(jobHandler)**：通过自己在项目中自定义不同的任务处理器来让任务执行器执行，并通过调度器平台 处理不同的任务。

现在看不懂没事，等后续搭建起来之后，你就会全部理解。

## 三、搭建任务调度器平台 ##

### 1、任务调度器平台 ###

#### 1.1、创建xxl-job-admin数据库 ####

![aabd4e75831c40f8b74b45582da8537b.png][]

将这个.sql文件创建到你的数据库中，这个应该都会创建，数据库名字要为**xxl\_job**防止不必要的错误。其实里边已经帮你写好了，这里我就以Navicat为例引入.sql文件

![ceff70a1f5924fa896fd34fe16dfee49.png][]

将.sql复制粘贴到桌面，然后通过Navicat引入即可。

![29e2411fadf84612b550107f17643256.png][]

#### 1.2、配置yaml ####

首先去xxl-job-admin找到配置文件，并修改**port**、**mysql**、**mail**、**xxl.job.accessToken**

![d227018bf42e42e69dd30cddf39f145e.png][]

**修改port**

![3290991e7ed84510bdc92b0aea852fe8.png][]

**修改mysql**

![83c4b00c5f9b4ba695baf7f2d9101098.png][]

**修改mail**

邮箱的账号密码不知道的去百度搜索：java配置mail

![f88aed0f4a284afa8b4c5edb624236d1.png][]

**修改 xxl.job.accessToken**

这个accessToken可以理解为秘钥，后面会在你自己的项目中配置和他名字一模一样的秘钥，让你的项目与任务调度器平台互相关联起来。

![4c36dbfb25094a66a8dfe13820c40a72.png][]

这里我就不做修改了，使用默认的，可以自定义。

#### 1.3、配置logback.xml ####

路径可以自定义，我就放到我习惯的位置，你也可以放到你自己习惯的位置

![8be3372cce8845dab6cac3407c1480f0.png][]

在linux中先创建好自己的路径日志，然后赋权限，下面的命令，是给文件赋权限的

chmod -R 777 /home/dblog/xxl-job/xxl-job-admin.log

![645766043c9f435ba47d0e83f07e532a.png][]

#### 1.4、启动任务调度器 ####

配置好之后，用idea打包，并将jar在linux中运行。

![c05d9c8017244f4c97b8168056027508.png][]

**1.4.1、修改jar名称**

我将xxl-job-admin-2.4.1-SNAPSHOT放到自己习惯的位置并修改了名称(**个人习惯**)，不修改也可以。

![1409f5d3f7314c58b48a3170a7924ae1.png][]

> \#将jar通过后台进程启动，并将启动信息指向xxl-job-admin.log中
> 
> nohup java -jar xxl-job-admin.jar > xxl-job-admin.log 2>&1 &
> 
> \#查看日志
> 
> tail -f xxl-job-admin.log

![e2920aca0e6c4b01b52af0e4afe30f48.png][]![e36506ec27574ae58e3d93eecf7c36be.png][] 1.5、访问任务调度器  
访问地址：**http://自己的ip:自己设置的端口号/xxl-job-admin**

账号：admin ；密码：123456

![417cb6a9a60e49f4948de781c715283c.png][]

**好的！以上就是搭建好的xxl-job的调度器平台了，现在我们只需要在自己的项目中引入xxl-job依赖，然后配置一些东西，就可以在这个任务调度器平台来操作定时任务啦！！！**

## 四、sprintboot引入xxl-job ##

### 1、引入xxl-job-core依赖 ###

在自己的项目中引入xxl-job-core依赖；只需引入这一个依赖就行

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

### 2、配置yaml ###

在自己的项目中配置yaml

xxl:
      job:
        admin:
          # 调度中心服务部署的地址
          addresses: http://192.168.139.110:9000/xxl-job-admin
        # 执行器通讯TOKEN,要和调度中心服务部署配置的accessToken一致，要不然无法连接注册
        accessToken: default_token
        executor:
          # 执行器AppName
          appname: job-demo
          # 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
          address:
          ip: 192.168.139.110
          #执行器端口号：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
          port: 9999
          # 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
          logpath: /home/dblog/log/jobhandler
          # 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
          logretentiondays: 30

![16c503a7f7c54b3c8df5406ca5e2c47b.png][]

**注意！！！！**： logpath执行日志存储位置，也是需要自己在linux中创建的，和上述任务调度器平台创建一样，创建完成之后，设置权限。

### 3、配置日志 ###

去你拉取的**xxl-job**项目中找到 **logback.xml**,复制到你自己项目的位置

![93dc416b142041e9a3ddeecd1cf26f2b.png][]

复制到自己的项目中

![468359008e384c6d91b4ec296c6ba657.png][]

##### 3.1、修改日志路径 #####

![7f93d53ee4ee433fa33ddf3d03ed874c.png][]

在linux创建，并且给权限，这个就偷下懒不写了，在任务调度平台中已经写过了，可以模仿写一下。

### 4、编写配置类 ###

原封不动复制粘贴到你项目的位置就行即可，我一般习惯放到config下。这个配置类其实是可以在xxl-job项目中找到的。

![f4cdaa8a11eb498fa2d99588280743b9.png][]

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

**xxl-job项目中的XxlJobConfig**

上述的配置类代码，其实就是这个xxl-job项目中的XxlJobConfig 一模一样。

![52d6d4bd12504f39afd8f87c99ac522b.png][]

### 5、创建任务处理器类 ###

![cf7385230d6a4283bd6f670cf64ff2d4.png][]

将xxl-job中的SampleXxlJob复制到自己的项目中

![4564570c4df5471aa0d572c4e9a45f61.png][]

#### 5.1、修改并编写代码 ####

![55e03d962a10418b8b7a1a61aea6cb3f.png][]

全部配置好之后，将自己的项目打包并部署到linux中，可以看到我的项目已经起来了。

![20ca51cad38842868c40b5f1ce0ee212.png][]

接下来，就要去操作任务调度器平台了，来设置定时任务。

## 五、操作任务调度器平台(任务调度中心) ##

### 1、新增执行器 ###

![452158cc712b4216b6b4c47d42fe5dc6.png][]

![ef51fc2feee64520a8b731bba4136384.png][]

**注意**：自动注册，xxl-job会自动找到你的机器地址。

![422c01123fa74a838d18e69486537734.png][]

也就是你上述在自己项目中配置的执行器ip和端口号，如果你的机器地址为无，那么就手动注册。

### 2、新增任务处理器 ###

![b008dd0064e34e7a93e923a37b65a6a5.png][]

![95c0427c6b904dfea2633388ffbec742.png][]

**JobHandler来源**

**自己项目代码中自定义的名称。**

![47c2fa713ea04e2db72a3168cc9eedc0.png][]

### ![6928641bcf3542a593844c6d8c400ac0.png][] 3、启动任务处理器 ###

![0cad1d1167e442a18596b1f741fa1a48.png][]

启动完成之后，你可以去linux，查看你刚才打印的信息，如果出现则代表成功。

![63bccb77b2514065822a67147cea8910.png][]

还可以看调度日志

![2f6a20d386ff4bcb85455f7f59af4602.png][]

好啦！！以上就是xxl-job的使用啦，哇，深夜2点爆肝的，呜呜呜。希望各位看完之后，能够快速提升自己的实力吧。加油！

## 附加-运行模式： ##

### BEAN模式 ###

Bean模式任务，支持基于方法的开发方式，每个任务对应一个方法。

优点：每个任务只需要一个方法，添加@XxlJob注解即可，方便、快速。

缺点：需要Spring环境

### GLUE模式(Java) ###

GLUE模式(Java)  
任务以源码方式维护在调度中心，支持通过Web IDE在线更新，实时编译和生效，因此不需要指定JobHandler。开发流程如下：

步骤一：调度中心，新建调度任务：  
参考上文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 “GLUE模式(Java)”；

步骤二：开发任务代码：  
选中指定任务，点击该任务右侧“GLUE”按钮，将会前往GLUE任务的Web IDE界面，在该界面支持对任务代码进行开发（也可以在IDE中开发完成后，复制粘贴到编辑中）。

其他模式：略

[www.wdcdbd.com]: http://www.wdcdbd.com
[https_gitee.com_xuxueli0323_xxl-job]: https://gitee.com/xuxueli0323/xxl-job
[290e61a111bf42a38ac8c48df4d1ad62.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/00e4756f1c4f43d583a5856a8497aa37.png
[f1454ae9dc724253835e3d72071834ac.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/8d67cb89c36e498cbba290334e50391c.png
[231886edc3ac45398b94cbee16a32eb7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/6476dc6c1d124020a39178a4f1ecd32d.png
[3d2f1c605f374b889c61d0149f8779b8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/c9da25c168b94248827873886f1c3850.png
[aabd4e75831c40f8b74b45582da8537b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/d11383e2bf0c4b25888e45fba8a08e19.png
[ceff70a1f5924fa896fd34fe16dfee49.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/d44b0aae3d4740a78a1c21be37cb6311.png
[29e2411fadf84612b550107f17643256.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/43751f0984b14c45bc841ac6839e8db1.png
[d227018bf42e42e69dd30cddf39f145e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/1e027078c4874edc8cb66e2a209f985c.png
[3290991e7ed84510bdc92b0aea852fe8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/eb32f3eb52844fd489890774547220c7.png
[83c4b00c5f9b4ba695baf7f2d9101098.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/3b1ec4105a0b44d3ba866d8869afa746.png
[f88aed0f4a284afa8b4c5edb624236d1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/386b5feadb354a63b93322f89310e271.png
[4c36dbfb25094a66a8dfe13820c40a72.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/f5d03e3c7f294f33b891243c3e9c33a9.png
[8be3372cce8845dab6cac3407c1480f0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/80a6b88a734a4e95895fea54410483c8.png
[645766043c9f435ba47d0e83f07e532a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/bed5d41391e24e3d838057a99c9e8fa5.png
[c05d9c8017244f4c97b8168056027508.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/ad8fff37145143adbaf14d6a03c9d69d.png
[1409f5d3f7314c58b48a3170a7924ae1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/1ef1923b587542d6a5f2e2e976d68886.png
[e2920aca0e6c4b01b52af0e4afe30f48.png]: https://img-blog.csdnimg.cn/direct/e2920aca0e6c4b01b52af0e4afe30f48.png
[e36506ec27574ae58e3d93eecf7c36be.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/801a0e751b044875a12e16207f60b312.png
[417cb6a9a60e49f4948de781c715283c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/7f504995f7b340eb841ca6a34226663b.png
[16c503a7f7c54b3c8df5406ca5e2c47b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/abd1f590402e4c3b90c65f58531dc878.png
[93dc416b142041e9a3ddeecd1cf26f2b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/af60e928d051438086fe3b0e14dbd1ec.png
[468359008e384c6d91b4ec296c6ba657.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/fd5b92a40bff4bf585375f43a5f4b76d.png
[7f93d53ee4ee433fa33ddf3d03ed874c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/b7ce5266140444e0b12cdd42b89a2a6d.png
[f4cdaa8a11eb498fa2d99588280743b9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/819a9ee4297048928ac64635986dc2a7.png
[52d6d4bd12504f39afd8f87c99ac522b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/aa03ffaa424f4d588fdb711d8ae40878.png
[cf7385230d6a4283bd6f670cf64ff2d4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/c0c70398b953429fa17f75a54eb27d7f.png
[4564570c4df5471aa0d572c4e9a45f61.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/06bfe42a2bc849fea0d0bd264d8ab285.png
[55e03d962a10418b8b7a1a61aea6cb3f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/af511658548d4701982c99419cbe2a95.png
[20ca51cad38842868c40b5f1ce0ee212.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/b1435076ace74915ac3620d9181b40ab.png
[452158cc712b4216b6b4c47d42fe5dc6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/2ce00509d4484033830b099139de5665.png
[ef51fc2feee64520a8b731bba4136384.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/3e7e9b391bc24c98abd57493325e8dc9.png
[422c01123fa74a838d18e69486537734.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/4f819af41a2145d9af4a8782beaca940.png
[b008dd0064e34e7a93e923a37b65a6a5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/691db445b97241e39371c88082661701.png
[95c0427c6b904dfea2633388ffbec742.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/9c6abdb50b094576ad436211b4776080.png
[47c2fa713ea04e2db72a3168cc9eedc0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/be10284cc05c43a1af646f59469afff0.png
[6928641bcf3542a593844c6d8c400ac0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/ba2c9743f63042da8d39b86c484e66ca.png
[0cad1d1167e442a18596b1f741fa1a48.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/c3f5c5895af149edb554e12fba0e8ca8.png
[63bccb77b2514065822a67147cea8910.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/affefbf40c48452fa04d4559062bf1d2.png
[2f6a20d386ff4bcb85455f7f59af4602.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/f5647874bd3c463db3a54fd43fa565ee.png