分布式任务调度平台XXL-JOB搭建教程
关于分布式任务调度平台XXL-JOB,其实作者 许雪里 在其发布的中文教程中已经介绍的很清楚了,这里我就不做过多的介绍了,关于其搭建教程,本人依照其文档搭建起来基本上也没遇到啥问题,这里通过博客的形式记录下来。
1、源码下载地址
①、GitHub:https://github.com/xuxueli/xxl-job
②、码云:https://gitee.com/xuxueli0323/xxl-job
2、文档地址
①、中文文档:http://www.xuxueli.com/xxl-job/#/
②、英文文档:http://www.xuxueli.com/xxl-job/en/#/
3、源码结构
通过上面给出的源码下载地址,我们将源码clone到IDEA中,如下:
4、初始化数据库
初始化脚本在上面源码目录的 /doc/db/tables_xxl_job.sql ,将此脚本在MySQL数据库中执行一遍。
执行完毕,会在MySQL数据库中生成如下 16 张表:
5、配置调度中心
调度中心就是源码中的 xxl-job-admin 工程,我们需要将其配置成自己需要的调度中心,通过该工程我们能够以图形化的方式统一管理任务调度平台上调度任务,负责触发调度执行。
①、修改调度中心配置文件
文件地址:/xxl-job/xxl-job-admin/src/main/resources/xxl-job-admin.properties
配置文件说明:
1 ### 1、调度中心项目的端口号以及访问路径 2 server.port=8080 3 server.context-path=/xxl-job-admin 4 5 ### 2、配置静态文件的前缀 6 spring.mvc.static-path-pattern=/static/** 7 spring.resources.static-locations=classpath:/static/ 8 9 ### 3、配置模板文件 10 spring.freemarker.templateLoaderPath=classpath:/templates/ 11 spring.freemarker.suffix=.ftl 12 spring.freemarker.charset=UTF-8 13 spring.freemarker.request-context-attribute=request 14 spring.freemarker.settings.number_format=0.########## 15 16 ### 4、配置mybatis的mapper文件地址 17 mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml 18 19 ### 5、配置数据库的地址 20 spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl-job?Unicode=true&characterEncoding=UTF-8 21 spring.datasource.username=root 22 spring.datasource.password=root_pwd 23 spring.datasource.driver-class-name=com.mysql.jdbc.Driver 24 25 spring.datasource.type=org.apache.tomcat.jdbc.pool.DataSource 26 spring.datasource.tomcat.max-wait=10000 27 spring.datasource.tomcat.max-active=30 28 spring.datasource.tomcat.test-on-borrow=true 29 spring.datasource.tomcat.validation-query=SELECT 1 30 spring.datasource.tomcat.validation-interval=30000 31 32 ### 6、配置报警邮箱 33 spring.mail.host=smtp.qq.com 34 spring.mail.port=25 35 spring.mail.username=xxx@qq.com 36 spring.mail.password=xxx 37 spring.mail.properties.mail.smtp.auth=true 38 spring.mail.properties.mail.smtp.starttls.enable=true 39 spring.mail.properties.mail.smtp.starttls.required=true 40 41 42 ### 7、管理界面的登录用户名密码 43 xxl.job.login.username=admin 44 xxl.job.login.password=123456 45 46 ### 8、调度中心通讯TOKEN,非空时启用 47 xxl.job.accessToken= 48 49 ### 9、调度中心国际化设置,默认为中文版本,值设置为“en”时切换为英文版本 50 xxl.job.i18n=
注意:基本上上面的配置文件我们需要修改的只有第 5 点,修改数据库的地址,这要与我们前面初始化的数据库名称径,用户名密码保持一致;
第二个就是修改第 6 点,报警邮箱,因为该工程任务失败后有失败告警功能,可以通过邮件来提醒,如果我们需要此功能,可以配置一下。
②、部署调度中心
该工程是一个springboot项目,我们只需要在IDEA中执行 XxlJobAdminApplication 类即可运行该工程:
③、访问调度中心管理界面
在浏览器输入 http://localhost:8080/xxl-job-admin 然后输入用户名和密码(前面配置文件中配置的),即可看到如下管理界面。
6、创建执行器项目
其实在源码中,作者提供了各个版本的 执行器项目,下面我以创建一个 springboot 版本的执行器为例来介绍。
这个执行器的地址为:https://github.com/YSOcean/xxljobexecutordemo.git
①、添加maven依赖
在创建好的springboot 项目的pom.xml 文件中添加如下依赖:
1 <!-- xxl-rpc-core --> 2 <dependency> 3 <groupId>com.xuxueli</groupId> 4 <artifactId>xxl-job-core</artifactId> 5 <version>2.0.1</version> 6 </dependency>
②、配置执行器
在创建好的springboot 项目的配置文件 application.yml 添加如下配置:
1 server: 2 #项目端口号 3 port: 8081 4 logging: 5 #日志文件 6 config: classpath:logback.xml 7 8 xxl: 9 job: 10 admin: 11 #调度中心部署跟地址:如调度中心集群部署存在多个地址则用逗号分隔。 12 #执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"。 13 addresses: http://127.0.0.1:8080/xxl-job-admin 14 15 #分别配置执行器的名称、ip地址、端口号 16 #注意:如果配置多个执行器时,防止端口冲突 17 executor: 18 appname: executorDemo 19 ip: 127.0.0.1 20 port: 9999 21 22 #执行器运行日志文件存储的磁盘位置,需要对该路径拥有读写权限 23 logpath: /data/applogs/xxl-job/jobhandler 24 #执行器Log文件定期清理功能,指定日志保存天数,日志文件过期自动删除。限制至少保持3天,否则功能不生效; 25 #-1表示永不删除 26 logretentiondays: -1
这里需要注意的是:配置执行器的名称、IP地址、端口号,后面如果配置多个执行器时,要防止端口冲突。再就是执行器的名称,我们后面会到上一步的调度中心管理界面进行对应配置。
③、载入配置文件
在项目中创建 XxlJobConfig.class 文件:
1 package com.ys.xxljobexecutordemo.config; 2 3 import com.xxl.job.core.executor.impl.XxlJobSpringExecutor; 4 import org.slf4j.Logger; 5 import org.slf4j.LoggerFactory; 6 import org.springframework.beans.factory.annotation.Value; 7 import org.springframework.context.annotation.Bean; 8 import org.springframework.context.annotation.Configuration; 9 10 /** 11 * Create by YSOcean 12 */ 13 @Configuration 14 public class XxlJobConfig { 15 private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class); 16 17 @Value("${xxl.job.admin.addresses}") 18 private String adminAddresses; 19 20 @Value("${xxl.job.executor.appname}") 21 private String appName; 22 23 @Value("${xxl.job.executor.ip}") 24 private String ip; 25 26 @Value("${xxl.job.executor.port}") 27 private int port; 28 29 @Value("${xxl.job.accessToken}") 30 private String accessToken; 31 32 @Value("${xxl.job.executor.logpath}") 33 private String logPath; 34 35 @Value("${xxl.job.executor.logretentiondays}") 36 private int logRetentionDays; 37 38 39 @Bean(initMethod = "start", destroyMethod = "destroy") 40 public XxlJobSpringExecutor xxlJobExecutor() { 41 logger.info(">>>>>>>>>>> xxl-job config init."); 42 XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor(); 43 xxlJobSpringExecutor.setAdminAddresses(adminAddresses); 44 xxlJobSpringExecutor.setAppName(appName); 45 xxlJobSpringExecutor.setIp(ip); 46 xxlJobSpringExecutor.setPort(port); 47 xxlJobSpringExecutor.setAccessToken(accessToken); 48 xxlJobSpringExecutor.setLogPath(logPath); 49 xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays); 50 51 return xxlJobSpringExecutor; 52 } 53 54 }
④、创建任务JobHandler
在项目中创建一个Handler,用于执行我们想要执行的东西,这里我只是简单的打印一行日志:
XXL-JOB, Hello World!!!
1 package com.ys.xxljobexecutordemo.jobhandler; 2 3 import com.xxl.job.core.biz.model.ReturnT; 4 import com.xxl.job.core.handler.IJobHandler; 5 import com.xxl.job.core.handler.annotation.JobHandler; 6 import com.xxl.job.core.log.XxlJobLogger; 7 import org.springframework.stereotype.Component; 8 9 /** 10 * 任务Handler示例(Bean模式) 11 * 12 * 开发步骤: 13 * 1、继承"IJobHandler":“com.xxl.job.core.handler.IJobHandler”; 14 * 2、注册到Spring容器:添加“@Component”注解,被Spring容器扫描为Bean实例; 15 * 3、注册到执行器工厂:添加“@JobHandler(value="自定义jobhandler名称")”注解,注解value值对应的是调度中心新建任务的JobHandler属性的值。 16 * 4、执行日志:需要通过 "XxlJobLogger.log" 打印执行日志; 17 */ 18 @JobHandler(value="demoJobHandler") 19 @Component 20 public class JobHandlerDemo extends IJobHandler{ 21 @Override 22 public ReturnT<String> execute(String s) throws Exception { 23 XxlJobLogger.log("XXL-JOB, Hello World."); 24 return SUCCESS; 25 } 26 }