一、服务端安装
1、到官网https://www.xuxueli.com/xxl-job,通过git拉取代码到本地
2、找到doc目录下,db目录下的脚本文件,在数据库中建库建表,位置如下:
3、修改xxl-job-admin项目下的application.properties文件下面的数据库链接,改为自己的数据库链接。
4、maven依赖加载完毕以后,执行maven package命令
5、找到jar包,放到linux服务器
6、执行nohup java -jar xxl-job-admin-2.3.1-SNAPSHOT.jar > xxl-job.log.txt &命令,使xxl-job运行到后台
跟本地启动springboot项目是一样的,这样就代表启动成功了,接下来就是集成xxl-job了。
二、springboot集成
1、创建项目,添加如下pom依赖:
# xxl-job配置
xxl:
job:
admin:
# 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
addresses: http://xxxxxxx:8888/xxl-job-admin
executor:
# 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
address:
# 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
appname: demo-app
# 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
ip:
# 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
port: 0
# 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
logpath:
# 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;
logretentiondays: 15
# 执行器通讯TOKEN [选填]:非空时启用;
accessToken:
2、建立XxlJobConfig用来读取配置,链接服务端
package com.jp.xxljob.xxljob;
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.ComponentScan;
import org.springframework.context.annotation.Configuration;
/**
* xxl-job配置类
*
* @author 罗俊朋
* @createTime 2022年01月02日 11:31
*/
@Slf4j
@Configuration
@ComponentScan("com.jp.xxljob.xxljob")
public class XxlJobConfig {
@Value("${xxl.job.admin.addresses}")
private String adminAddresses;
@Value("${xxl.job.executor.appname}")
private String appName;
@Value("${xxl.job.executor.ip}")
private String ip;
@Value("${xxl.job.executor.port}")
private int port;
@Value("${xxl.job.accessToken}")
private String accessToken;
@Value("${xxl.job.executor.logpath}")
private String logPath;
@Value("${xxl.job.executor.logretentiondays}")
private int logRetentionDays;
@Bean(initMethod = "start", destroyMethod = "destroy")
public XxlJobSpringExecutor xxlJobExecutor() {
log.info("====xxl-job config init====");
XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
xxlJobSpringExecutor.setAppname(appName);
xxlJobSpringExecutor.setIp(ip);
xxlJobSpringExecutor.setPort(port);
xxlJobSpringExecutor.setAccessToken(accessToken);
xxlJobSpringExecutor.setLogPath(logPath);
xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
return xxlJobSpringExecutor;
}
}
3、添加一个简单的任务
package com.jp.xxljob.xxljob;
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.IJobHandler;
import com.xxl.job.core.handler.annotation.XxlJob;
import com.xxl.job.core.util.ShardingUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import java.io.BufferedInputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.concurrent.TimeUnit;
/**
* @author 罗俊朋
* @createTime 2022年01月02日 14:11
*/
@Slf4j
@Component
public class XxlJobService {
/**
* 1、简单任务示例(Bean模式)
*/
@XxlJob("demoJobHandler")
public ReturnT<String> demoJobHandler(String param) throws Exception {
log.info("XXL-JOB, Hello World.");
for (int i = 0; i < 5; i++) {
log.info("beat at:" + i);
TimeUnit.SECONDS.sleep(2);
}
return ReturnT.SUCCESS;
}
4、将项目打包到服务器上,想本地玩的可以把后台那个jar包在windows上跑 通过内网地址去连接。
5、登录xxl-job后台,创建一个执行器,先有执行器,才能在执行器下面创建任务。这里主要是注意appName这一栏,对应application.properties中的appName
6、创建定时任务
保证服务端和客户端都启动,然后点击运行一次做测试
最简单的集成,也是第一次使用,记录一下。