官方文档https://www.xuxueli.com/xxl-job/
还是在自己看比较好,我要是写简介和使用也是从上面复制下来的
首先是git官网下载源码:
源码仓库地址 Release Download
https://github.com/xuxueli/xxl-job Download
http://gitee.com/xuxueli0323/xxl-job Download
代码下载好的目录
首先看xxl-job-admin这个项目从配置文件看起
首先这个需要数据库的支持 Mysql 所以这个改成自己本地或者服务器的路径 账号 密码
需要的表结构实际已经提供给好了在doc文件下把此文件夹下文件 复制出来运行一下就可以
运行之后是8张表包括用户表
这些配置完成 启动admin项目
启动之后访问
http://127.0.0.1:8080/xxl-job-admin
弹出登入界面 默认账号:admin 密码:123456
登入后页面
这样第一步就算完成了
他首先是个分布式框框架 admin这个就算个服务中心 那看一下 消费者怎么做
官方已经给案例了;
我这主要用boot项目所以就看boot这个案例了
点开这个项目看到他的 结构
所以比这葫芦画瓢就可以,官方文档说一分钟上手
搭建一个项目(SpringBoot)
搭建好了首先看一下依赖
2.20版本
首先这个版本和以前是不一样的
”@XxlJob”
注解即可
而以前需要这个注解进行操作
@JobHandler(value = "demoJobHandler")’
maven依赖
<!-- https://mvnrepository.com/artifact/com.xuxueli/xxl-job-core -->
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.2.0</version>
</dependency>
首先要把 config的配置那拿过来
package com.xxl.job.executor.core.config;
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* xxl-job config
*
* @author xuxueli 2017-04-28
*/
@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();
*/
}
然后就是配置文件了
配置文件
### 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-athena
### 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
xxl.job.executor.ip=
### 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
xxl.job.executor.port=9999
### 执行器通讯TOKEN [选填]:非空时启用;
xxl.job.accessToken=
### 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### 执行器日志保存天数 [选填] :值大于3时生效,启用执行器Log文件定期清理功能,否则不生效;
xxl.job.executor.logretentiondays=-1
其实把源码的匹配文件拿来就可以使用
端口设置好就可以使用了
首先手写一个测试类 测试一下
package com.tangsir.tangxxljob.testJob;
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import com.xxl.job.core.log.XxlJobLogger;
import org.springframework.stereotype.Component;
import java.util.Date;
import java.util.concurrent.TimeUnit;
@Component
public class testjob {
@XxlJob("test")
public ReturnT<String> demoJobHandler(String param) throws Exception {
System.out.println("我是调用成功执行的"+new Date());
return ReturnT.SUCCESS;
}
}
写好启动项目:
启动成功看具体的配置:
打开admin的的控制页面
首先看到这个执行任务管理器:
配置之后看一下执行任务我们需要把刚才写的测试类配置进去才可以执行
配置好保存
开始执行任务
查K你项目已经成功调用了 日志打印出来了一秒一执行一次
admin还有日志功能
用户管理可以分发权限执行任务
到此 一个简单教程结束 ,如有不足请赐教!