编程开源技术交流,分享技术与知识

网站首页 > 开源技术 正文

1分钟上手xxl-job分布式调度平台

wxchong 2024-06-11 09:58:26 开源技术 48 ℃ 0 评论

关注我,每天都是干货满满

一、简介

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

二、部署 XXL-JOB

1. 下载 xxl-job 源码

https://gitee.com/xuxueli0323/xxl-job/releases 解压

2. 创建数据库执行sql脚本

3. 修改 xxl-job-admin 配置文件

4. 启动 xxl-job-admin 项目

访问:http://localhost:8080/xxl-job-admin

用户名:admin

密码:123456

5. Spring Boot 整合 XXL-JOB

(1) 引入 XXL-JOB 依赖

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

(2) application配置文件

# web port
server.port=8083
# no web
#spring.main.web-environment=false

# log config
logging.config=classpath:logback.xml

# 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。
# 执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
### xxl-job admin address list, such as "http://address" or "http://address01,http://address02"
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin

# 执行器通讯TOKEN [选填]:非空时启用;
### xxl-job, access token
xxl.job.accessToken=default_token

# 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
### xxl-job executor appname
xxl.job.executor.appname=xxl-job-executor-sample

# 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
### xxl-job executor registry-address: default use address to registry , otherwise use ip:port if address is null
xxl.job.executor.address=
# 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
### xxl-job executor server-info
xxl.job.executor.ip=
# 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
xxl.job.executor.port=9997
# 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
### xxl-job executor log-path
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
# 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;
### xxl-job executor log-retention-days
xxl.job.executor.logretentiondays=30

(3) 编写配置类

@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;
   }  
}

(4) 编写定时任务

@Component
public class SampleXxlJob {

   /**
   * 1、简单任务示例(Bean模式)
   */
   @XxlJob("test1")
   public void demoJobHandler() throws Exception {
     System.out.println("基本任务启动。。。。");
     for (int i = 0; i < 5; i++) {
       System.out.println("beat at:" + i);
       TimeUnit.SECONDS.sleep(2);
     }
   }


   /**
   * 2、分片广播任务
   */
   @XxlJob("shardingJobHandler2")
   public void shardingJobHandler() throws Exception {

     // 分片参数
     int shardIndex = XxlJobHelper.getShardIndex();
     int shardTotal = XxlJobHelper.getShardTotal();

     System.out.println("分片参数:当前分片序号 = "+shardIndex+", 总分片数 = "+shardTotal);

     // 业务逻辑
     for (int i = 0; i < shardTotal; i++) {
       if (i == shardIndex) {
       	System.out.println("第 "+i+" 片, 命中分片开始处理");
       } else {
      	 System.out.println("第 "+1+ "片, 忽略");
       }
     }

   }
}

(5) 在控制台新增执行器、新增任务后启动

结语:

不顺利吗? 多照照镜子,很多事情你就明白原因了。

Tags:

本文暂时没有评论,来添加一个吧(●'◡'●)

欢迎 发表评论:

最近发表
标签列表