手把手教你配置xxl-job

秒速五厘米 2022-05-10 11:28 1906阅读 0赞

## 一. 概述 ##

### 1. 简介 ###

XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是开发迅速、学习简单、轻量级、易扩展

### 2. 下载地址 ###

<table> 
 <thead> 
  <tr> 
   <th>源码地址</th> 
   <th>Release Download</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><a href="https://github.com/xuxueli/xxl-job" rel="nofollow">https://github.com/xuxueli/xxl-job</a></td> 
   <td><a href="https://github.com/xuxueli/xxl-job/releases" rel="nofollow">Download</a></td> 
  </tr> 
  <tr> 
   <td><a href="http://gitee.com/xuxueli0323/xxl-job" rel="nofollow">http://gitee.com/xuxueli0323/xxl-job</a></td> 
   <td><a href="https://gitee.com/xuxueli0323/xxl-job/releases" rel="nofollow">Download</a></td> 
  </tr> 
 </tbody> 
</table>

### 3. 文档地址 ###

[中文文档][Link 1]

## 二. 使用xxl-job ##

### 1. 初始化 ###

1.1 初始化“调度数据库”

运行mysql脚本(16张表)

/xxl-job/doc/db/tables_xxl_job.sql

1.2 编译源码

解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可

xxl-job-admin：调度中心
    xxl-job-core：公共依赖
    xxl-job-executor：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
        ：xxl-job-executor-sample-spring：Spring版本，通过Spring容器管理执行器，比较通用，推荐这种方式；
        ：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器；
        ：xxl-job-executor-sample-jfinal：JFinal版本，通过JFinal管理执行器；
        ：xxl-job-executor-sample-nutz：Nutz版本，通过Nutz管理执行器；

(本例中只需要用到xxl-job-admin)

### 2.部署调度中心 ###

2.1 项目配置

/xxl-job/xxl-job-admin/src/main/resources/xxl-job-admin.properties

说明:

### 调度中心JDBC链接：链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
    xxl.job.db.driverClass=com.mysql.jdbc.Driver
    xxl.job.db.url=jdbc:mysql://localhost:3306/xxl-job?useUnicode=true&characterEncoding=UTF-8
    xxl.job.db.user=root
    xxl.job.db.password=123456
    
    ### 报警邮箱
    xxl.job.mail.host=smtp.163.com
    xxl.job.mail.port=25
    xxl.job.mail.ssl=false
    xxl.job.mail.username=ovono802302@163.com
    xxl.job.mail.password=asdfzxcv
    xxl.job.mail.sendFrom=ovono802302@163.com
    xxl.job.mail.sendNick=《任务调度平台XXL-JOB》
    
    ### 登录账号
    xxl.job.login.username=admin
    xxl.job.login.password=123456
    
    ### 调度中心通讯TOKEN，非空时启用
    xxl.job.accessToken=
    
    ### 调度中心国际化设置，默认为中文版本，值设置为“en”时切换为英文版本
    xxl.job.i18n=

2.2部署

将项目部署到tomcat中运行

![image][]

### 3. 配置执行器 ###

3.1 添加依赖

当前使用的现有项目(baic-newdms-logis)

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

3.2 配置

在原有的配置文件加入

baic-newdms-logis\src\main\resources\application-dev.properties

### xxl-job admin address list：调度中心部署跟地址：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"。
    xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
    
    ### xxl-job executor address：执行器"AppName"和地址信息配置：AppName执行器心跳注册分组依据；地址信息用于"调度中心请求并触发任务"和"执行器注册"。执行器默认端口为9999，执行器IP默认为空表示自动获取IP，多网卡时可手动设置指定IP，手动设置IP时将会绑定Host。单机部署多个执行器时，注意要配置不同执行器端口；
    xxl.job.executor.appname=my-xxl-job
    xxl.job.executor.ip=192.168.0.107
    xxl.job.executor.port=9999
    
    ### xxl-job, access token：执行器通讯TOKEN，非空时启用
    xxl.job.accessToken=
    
    ### xxl-job log path：执行器运行日志文件存储的磁盘位置，需要对该路径拥有读写权限
    xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler/
    
    ### xxl-job log retention days：执行器Log文件定期清理功能，指定日志保存天数，日志文件过期自动删除。限制至少保持3天，否则功能不生效；
    xxl.job.executor.logretentiondays=-1

添加文件

package appconfig;
    
    import com.xxl.job.core.executor.XxlJobExecutor;
    
    import common.WebLogs;
    
    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;
    
    
    @Configuration
    public class XxlJobConfig {
    
        @Value("${xxl.job.admin.addresses}")
        private String adminAddresses;
    
        @Value("${xxl.job.executor.appname}")
        private String appName;
    
        @Value("${xxl.job.executor.ip}")
        private String ip;
    
        @Value("${xxl.job.executor.port}")
        private int port;
    
        @Value("${xxl.job.accessToken}")
        private String accessToken;
    
        @Value("${xxl.job.executor.logpath}")
        private String logPath;
    
        @Value("${xxl.job.executor.logretentiondays}")
        private int logRetentionDays;
    
    
        @Bean(initMethod = "start", destroyMethod = "destroy")
        public XxlJobExecutor xxlJobExecutor() {
            XxlJobExecutor xxlJobExecutor = new XxlJobExecutor();
            xxlJobExecutor.setAdminAddresses(adminAddresses);
            xxlJobExecutor.setAppName(appName);
            xxlJobExecutor.setIp(ip);
            xxlJobExecutor.setPort(port);
            xxlJobExecutor.setAccessToken(accessToken);
            xxlJobExecutor.setLogPath(logPath);
            xxlJobExecutor.setLogRetentionDays(logRetentionDays);
    
            return xxlJobExecutor;
        }
    
    }

启动类中导入XxlJobConfig

@Import({DataSourceConfig.class,WebConfig.class,RedisConfig.class,DruidConfiguration.class,
    	BaseJunitTest.class,ExceptionAdvice.class,
    	MvcConfiguration.class,	QueryResult.class,RestResponse.class,XxlJobConfig.class,
    	SqlInjectInterceptor.class,TxConfigBeanName.class,WebLogAspect.class,Swagger2Configuration.class})

### 4. 注册执行器 ###

执行器管理->新增执行器

![image][image 1]

![image][image 2]

### 5. 测试 ###

任务管理->新增任务

![image][image 3]

点击GLUE编辑代码

![image][image 4]

修改后保存 ![image][image 5]

测试代码

public void testJob() throws MyException{
    		WebLogs.info("调用任务成功");
    	}

点击执行按钮,执行成功.

查看控制台 ![image][image 6]

**![20190429100321387.gif][]人生自有其沉浮，每个人都应该学会忍受生活中属于自己的一份悲伤。**

![20190429100039814.jpg][]*喜欢就点个赞关注一下呗 ~~*

[Link 1]: http://www.xuxueli.com/xxl-job/#/
[image]: http://p2zlyo6hi.bkt.clouddn.com/image/20180513QQ%E5%9B%BE%E7%89%8720180513024533.png?ynotemdtimestamp=1538107413061
[image 1]: http://p2zlyo6hi.bkt.clouddn.com/image/20180513QQ%E5%9B%BE%E7%89%8720180513042910.png?ynotemdtimestamp=1538107413061
[image 2]: http://p2zlyo6hi.bkt.clouddn.com/image/20180513QQ%E5%9B%BE%E7%89%8720180513043110.png?ynotemdtimestamp=1538107413061
[image 3]: http://p2zlyo6hi.bkt.clouddn.com/image/20180513QQ%E5%9B%BE%E7%89%8720180513043330.png?ynotemdtimestamp=1538107413061
[image 4]: http://p2zlyo6hi.bkt.clouddn.com/image/20180513QQ%E5%9B%BE%E7%89%8720180513043535.png?ynotemdtimestamp=1538107413061
[image 5]: http://p2zlyo6hi.bkt.clouddn.com/image/20180513QQ%E5%9B%BE%E7%89%8720180513043750.png?ynotemdtimestamp=1538107413061
[image 6]: http://p2zlyo6hi.bkt.clouddn.com/image/20180513QQ%E5%9B%BE%E7%89%8720180513044215.png?ynotemdtimestamp=1538107413061
[20190429100321387.gif]: /images/20220510/faa97331c6274f9487f733bd58927ca7.png
[20190429100039814.jpg]: /images/20220510/fe3078ee9c1f436ca5acdb7113159000.png