分布式任务调度xxl-job的简单使用
描述:XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用
使用步骤:
一、下载xxl-job
地址:https://gitee.com/xuxueli0323/xxl-job,我目前最新分支是2.3.0
用IDEA打开项目,配置好maven和jdk
xxl-job-admin:调度中心
xxl-job-core:公共依赖
xxl-job-executor-samples是使用示例,可以删除不要,自己项目里配置也可参照。
二、配置数据库
项目xxl-job-2.3.0里面有doc目录,里面的db有数据库脚本,在数据库新建库:xxl_job,并执行mysql脚本。然后数据库里面就有8张表了。
在xxl-job-admin里面配置application.properties的数据库连接,端口(默认是8080容易冲突)
启动xxl-job-admin。
访问:http://localhost:8888/xxl-job-admin
登录账号密码:admin/123456
打开界面即启动成功。
三、在业务微服务配置定时任务,并连接调度中心
3.1导包(版本与当前下载的项目适配)
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.3.0</version>
</dependency>
3.2 配置连接调度中心
### 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
xxl.job.admin.addresses=http://127.0.0.1:8888/xxl-job-admin
### 执行器通讯TOKEN [选填]:非空时启用;
xxl.job.accessToken=
### 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
xxl.job.executor.appname=designmodel
### 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
xxl.job.executor.address=
### 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
xxl.job.executor.ip=
### 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
xxl.job.executor.port=9999
### 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;
xxl.job.executor.logretentiondays=30
3.3 写个配置类获取配置内容并连接调度中心
@Configuration
public class XxlJobConfig {
private Logger log = 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 xxlJobSpringExecutor(){
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;
}
}
3.4 写自己的业务定时任务
@Component
public class XxlScheduleJob {
private static Logger log = LoggerFactory.getLogger(XxlScheduleJob.class);
@XxlJob("testJobHandler")
public void testJobHandler(){
System.out.println("我是中国人");
}
}
testJobHandler方法里面写的就是定时任务这里的类是要加@Component
,方法要加@XxlJob("testJobHandler")
启动本项目
四、配置调度中的任务
在第二步打开的界面配置
4.1 配置执行器管理
点击:执行器管理>>>新增,
这里AppName
填自己的业务微服务的配置文件中的xxl.job.executor.appname对应的名字
名称可以随便取,最好贴近微服务的用途,见名知意。选择自动注册,则会根据AppName找到注册上来的对应的业务微服务,会自动获取其所在机器的地址。
4.2 配置任务管理器
点击: 任务管理器>>>新增
执行器选择对应微服务的配置的xxl.job.executor.appname。(可粗鲁的配置为微服务名字,方便一眼识别该执行器是哪个微服务的)
4.3 启动任务管理器
这时即启动了业务微服务的定时任务调度