一、xxl-job介绍
XXL-JOB是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。
二、测试环境搭建
采用docker-compose来搭建测试环境，具体配置如下：
docker-compose-xxl-job.yml
# 参考文档：https://www.xuxueli.com/xxl-jobversion: "3"networks:xxljob:driver: bridgeservices::image: registry.cn-hangzhou.aliyuncs.com/zhengqing/xxl-job-admin:2.3.0 # 原镜像`xuxueli/xxl-job-admin:2.3.0`container_name: xxl-job-adminenvironment:# TODO 根据自己的配置修改，配置项参考源码文件：/xxl-job/xxl-job-admin/src/main/resources/application.propertiesPARAMS: "--spring.datasource.url=jdbc:mysql://10.11.68.77:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai=root=root=/xxl-job-admin=smtp.qq.com=25=xxx@qq.com=xxx@qq.com=xxx="ports:"8080:8080"depends_on:mysqlnetworks:xxljobmysql:image: registry.cn-hangzhou.aliyuncs.com/zhengqing/mysql:5.7 # 原镜像`mysql:5.7`container_name: mysql_3306 # 容器名为'mysql_3306'restart: unless-stopped # 指定容器退出后的重启策略为始终重启，但是不考虑在Docker守护进程启动时就已经停止了的容器volumes: # 数据卷挂载路径设置,将本机目录映射到容器目录"./mysql/my.cnf:/etc/mysql/my.cnf""./mysql/init-file.sql:/etc/mysql/init-file.sql""./mysql/data:/var/lib/mysql"# - "./mysql/conf.d:/etc/mysql/conf.d""./mysql/log/mysql/error.log:/var/log/mysql/error.log""./mysql/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d" # 可执行初始化sql脚本的目录 -- tips:`/var/lib/mysql`目录下无数据的时候才会执行(即第一次启动的时候才会执行)environment: # 设置环境变量,相当于docker run命令中的-eTZ: Asia/ShanghaiLANG: en_US.UTF-8MYSQL_ROOT_PASSWORD: root # 设置root用户密码MYSQL_DATABASE: xxl_job # 初始化的数据库名称ports: # 映射端口"3306:3306"networks:xxljob
运行
docker-compose -f docker-compose-xxl-job.yml -p xxl-job up -d
访问地址：http://ip地址:9003/xxl-job-admin 默认登录账号密码：admin/123456
三、代码工程
本实验目标：写一个任务类JOB，并实现在控制台进行cron调度
maven依赖
<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><parent><artifactId>springboot-demo</artifactId><groupId>com.et</groupId><version>1.0-SNAPSHOT</version></parent><modelVersion>4.0.0</modelVersion><artifactId>xxl-job</artifactId><properties><maven.compiler.source>8</maven.compiler.source><maven.compiler.target>8</maven.compiler.target></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-autoconfigure</artifactId></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.4</version><scope>provided</scope></dependency><dependency><groupId>com.xuxueli</groupId><artifactId>xxl-job-core</artifactId><version>2.3.0</version></dependency></dependencies></project>
xxl-job配置
package com.et.xxljob.config;import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;import lombok.extern.slf4j.Slf4j;import org.springframework.beans.factory.annotation.Value;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;public class XxlJobConfig {private String adminAddresses;private String accessToken;private String appname;private String address;private String ip;private int port;private String logPath;private int logRetentionDays;public XxlJobSpringExecutor xxlJobExecutor() {log.info(">>>>>>>>>>> start 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;}}
jobhandler
package com.et.xxljob.handler;import com.xxl.job.core.handler.annotation.XxlJob;import lombok.extern.slf4j.Slf4j;import org.springframework.stereotype.Component;@Slf4j@Componentpublic class DemoJob {/*** 简单的job，调度器*/@XxlJob("job1")public void job1() {log.info("do job1");}}
配置文件
server:port: 8088logging:level:: debugxxl:job:admin:#调度中心部署根地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；addresses: http://127.0.0.1:8080/xxl-job-admin#执行器通讯TOKEN [选填]：非空时启用；accessToken:executor:#执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册appname: xxljob-demo-service#${spring.application.name}#执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。address: ""#执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；ip: ""#执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；port: 0###${server-port}#执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；logpath: ./logs/xxl-job/jobhandler#执行器日志文件保存天数 [选填] ：过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；logretentiondays: 30
启动类
package com.et.xxljob;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;public class DemoApplication {public static void main(String[] args) {SpringApplication.run(DemoApplication.class, args);}}
代码仓库
https://github.com/Harries/springboot-demo
四、测试
启动执行器项目，在调度中心->执行器管理，创建新执行器，AppName要与执行器配置文件里面配置的名称一致，选择自动注册即可
在调度中心->任务管理，创建新任务，选择我们刚刚创建的新执行器，重点关注JobHandler这个配置，名称要跟相应的任务方法上@XxlJob注解里面的名称一致，才能找到相应的任务去执行
创建完成后，在操作那里进行执行一次，查看对应的日志输出，可知配置成功
2024-02-28 10:43:49.595 INFO 26368 --- [ Thread-8] com.xxl.job.core.thread.JobThread : >>>>>>>>>>> xxl-job JobThread stoped, hashCode:Thread[Thread-8,10,main]2024-02-28 10:43:50.016 INFO 26368 --- [ Thread-9] com.et.xxljob.handler.DemoJob : do job1
五、引用
https://www.jianshu.com/p/20ac45a76fde
https://www.xuxueli.com/xxl-job/
http://www.liuhaihua.cn/archives/710250.html
原文作者：HBLOG；如有侵权，请联系管理员删除。
请登录后发表评论
登录
全部评论
