《Dubbo 实现原理与源码解析 —— 精品合集》 《Netty 实现原理与源码解析 —— 精品合集》
《Spring 实现原理与源码解析 —— 精品合集》 《MyBatis 实现原理与源码解析 —— 精品合集》
《Spring MVC 实现原理与源码解析 —— 精品合集》 《数据库实体设计合集》
《Spring Boot 实现原理与源码解析 —— 精品合集》 《Java 面试题 + Java 学习指南》

摘要: 原创出处 blog.csdn.net/weixin_51130354 「小飞.Su」欢迎转载,保留摘要,谢谢!


🙂🙂🙂关注**微信公众号:【芋道源码】**有福利:

  1. RocketMQ / MyCAT / Sharding-JDBC 所有源码分析文章列表
  2. RocketMQ / MyCAT / Sharding-JDBC 中文注释源码 GitHub 地址
  3. 您对于源码的疑问每条留言将得到认真回复。甚至不知道如何读源码也可以请教噢
  4. 新的源码解析文章实时收到通知。每周更新一篇左右
  5. 认真的源码交流微信群。

前言

XXL-JOB是一个轻量级分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。

可以前往Gitee地址进行下载使用。

https://gitee.com/xuxueli0323/xxl-job.git

xxl-job-admin搭建

拉取代码

代码结构如下:

运行SQL文件至本地数据库

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

启动任务调度中心

浏览器访问默认地址:http://localhost:8080/xxl-job-admin

账号:admin 密码: 123456 (初始状态下)

登录成功

到此为止,第一阶段xxl-job-admin模块的部署就完成啦。

整合springboot项目

此部分官方已经给出具体案例,我们只需对赶方案例进行整合或修改即可。

接下来就是如何整合到自己的springboot项目中

一、引入maven依赖

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

二、引入配置类

只需引入XxlJobConfig配置类即可,其他配置类为该项目其他配置类,与此无关!

可以直接从拉取的项目中复制过来,无需任何修改!!!

复制此类到你的项目中即可!

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


}

三、修改yml配置文件

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

四、编写测试类

@Component
public class MileageXxlJob {
private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);


/**
* 1、简单任务示例(Bean模式)
*/
@XxlJob("mileageJobHandler")
public void mileageJobHandler() throws Exception {
XxlJobHelper.log("XXL-JOB, Hello World.");

for (int i = 0; i < 5; i++) {
XxlJobHelper.log("beat at:" + i);
System.out.println("ok");
TimeUnit.SECONDS.sleep(2);
}
// default success
}
}

项目目录如下

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

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

1.新增执行器

2.新增任务

3.执行任务

注:测试选择执行一次即可,如需项目保持运行,选择启动

4.查看运行结果

到此,XXL-JOB与SpringBoot的简单整合入门教程就完成了,感谢您的查阅!

文章目录
  1. 1. 前言
  2. 2. xxl-job-admin搭建
    1. 2.0.1. 拉取代码
    2. 2.0.2. 启动任务调度中心
    3. 2.0.3. 登录成功
  • 3. 整合springboot项目
    1. 3.0.1. 一、引入maven依赖
    2. 3.0.2. 二、引入配置类
    3. 3.0.3. 三、修改yml配置文件
    4. 3.0.4. 四、编写测试类
    5. 3.0.5. 五、任务调度中心,配置服务