一、xxl-job环境搭建
1.下载项目
https://gitcode.net/mirrors/xuxueli/xxl-job?utm_source=csdn_github_accelerator
2.搭建xxl-job数据库
解压下载的项目,doc->db->tables_xxl_job.sql
运行这个sql文件就可以了
3.idea配置启动
使用idea打开项目
修改xxl-job-admin模块的application.properties
主要修改 mysql的连接路径,用户名,密码
启动项目
访问 http://localhost:8080/xxl-job-admin
第一次需要登录
用户名:admin
密码:123456
二、springboot项目使用xxl-job
1.导入依赖
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.3.0</version>
</dependency>
2.配置
拷贝xxl-job-executor-sample-springboot 下的
XxlJobConfig类 到springboot项目(位置没有要求)
@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;
}
}
application.properties
springboot项目的配置文件 添加xxl-job配置
### 调度中心部署根地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器通讯TOKEN [选填]:非空时启用;
xxl.job.accessToken=
### 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-test
### 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”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.1编写执行类
在实际任务中,就是具体的操作,测试用只是输出提示信息
DemoJobComponent.java
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
@Slf4j
@Component
public class DemoJobComponent {
@XxlJob("firstJob")
public ReturnT<String> execute(String s){
log.info("================执行成功!!!!");
return ReturnT.SUCCESS;
}
}
启动springboot项目
3.2 在页面中管理
访问http://localhost:8080/xxl-job-admin/
新建执行器
appname 对应 springboot项目配置文件中的 appname
机器地址也是,其中端口号是xxl配置的9999,不是springboot项目运行的8081端口
名称可以随意
新建任务
bean模式,JobHandler 是demo类里@XxlJob(“”) 里面的值
CRON具体的使用可以参考别的文章
cron表达式详解
3.3 启动定时任务
这里先启动一次
查看日志
查看springboot项目控制台输出