前言

XXL-JOB是一个轻量级分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
可以前往Gitee地址进行下载使用。
image.png

搭建

拉取代码,代码结构如下

image.png

运行SQL到本地数据库

image.png

修改xxl-job-admin模块的yml文件

image.png

启动任务调度中心

image.png
浏览器访问默认地址: http://localhost:8080/xxl-job-admin
image.png
账号: admin 密码: 123456 (初始状态下)
登录成功
image.png
到此为止,第一阶段xxl-job-admin模块的部署就完成啦。

整合SpringBoot项目

一、引入maven依赖

image.png
注意:此处版本要与xxl-job-admin中版本保持一致

二、引入配置类

image.png
只需引入XxlJobConfig配置类即可,其他配置类为该项目其他配置类,与此无关!
可以直接从拉取的项目中复制过来,无需任何修改!!!
复制此类到你的项目中即可!

  1. @Configuration
  2. public class XxlJobConfig {
  3. private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
  4. @Value("${xxl.job.admin.addresses}")
  5. private String adminAddresses;
  6. @Value("${xxl.job.accessToken}")
  7. private String accessToken;
  8. @Value("${xxl.job.executor.appname}")
  9. private String appname;
  10. @Value("${xxl.job.executor.address}")
  11. private String address;
  12. @Value("${xxl.job.executor.ip}")
  13. private String ip;
  14. @Value("${xxl.job.executor.port}")
  15. private int port;
  16. @Value("${xxl.job.executor.logpath}")
  17. private String logPath;
  18. @Value("${xxl.job.executor.logretentiondays}")
  19. private int logRetentionDays;
  20. @Bean
  21. public XxlJobSpringExecutor xxlJobExecutor() {
  22. logger.info(">>>>>>>>>>> xxl-job config init.");
  23. XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
  24. xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
  25. xxlJobSpringExecutor.setAppname(appname);
  26. xxlJobSpringExecutor.setAddress(address);
  27. xxlJobSpringExecutor.setIp(ip);
  28. xxlJobSpringExecutor.setPort(port);
  29. xxlJobSpringExecutor.setAccessToken(accessToken);
  30. xxlJobSpringExecutor.setLogPath(logPath);
  31. xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
  32. return xxlJobSpringExecutor;
  33. }
  34. /**
  35. * 针对多网卡、容器内部署等情况,可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP;
  36. *
  37. * 1、引入依赖:
  38. * <dependency>
  39. * <groupId>org.springframework.cloud</groupId>
  40. * <artifactId>spring-cloud-commons</artifactId>
  41. * <version>${version}</version>
  42. * </dependency>
  43. *
  44. * 2、配置文件,或者容器启动变量
  45. * spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
  46. *
  47. * 3、获取IP
  48. * String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
  49. */
  50. }

三、修改yml配置文件

  1. xxl:
  2. job:
  3. admin:
  4. # 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。
  5. # 执行器将会使用该地址进行"执行器心跳注册""任务结果回调";为空则关闭自动注册;
  6. addresses: http://127.0.0.1:8086/xxl-job-admin
  7. # 执行器通讯TOKEN [选填]:非空时启用;
  8. accessToken:
  9. executor:
  10. # 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
  11. appname: xxl-job-executor-mileage
  12. # 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 IP:PORT 作为注册地址。
  13. #从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
  14. address:
  15. # 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;
  16. # 地址信息用于 "执行器注册" "调度中心请求并触发任务"
  17. ip:
  18. # 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
  19. port: 8088
  20. # 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
  21. logpath: /data/applogs/xxl-job/jobhandler
  22. # 执行器日志文件保存天数 [选填] 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;
  23. logretentiondays: 30
  24. logging:
  25. config: classpath:logback.xml

四、编写测试类

  1. @Component
  2. public class MileageXxlJob {
  3. private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
  4. /**
  5. * 1、简单任务示例(Bean模式)
  6. */
  7. @XxlJob("mileageJobHandler")
  8. public void mileageJobHandler() throws Exception {
  9. XxlJobHelper.log("XXL-JOB, Hello World.");
  10. for (int i = 0; i < 5; i++) {
  11. XxlJobHelper.log("beat at:" + i);
  12. System.out.println("ok");
  13. TimeUnit.SECONDS.sleep(2);
  14. }
  15. // default success
  16. }
  17. }

编写完成后,启动服务!(注意启动顺序,先启动xxl-job-admin模块,再启动您的springboot服务)

五、任务调度中心,配置服务

1.新增执行器

image.png

2.新增任务

image.png

3.执行任务

image.png

4.查看运行结果

image.png