一、安装服务端 Xxl-Job
1、xxl-job
官方文档
gitee: Xxl-Job
github: Xxl-Job
2、准备数据库
运行完 sql 会生成8张表:
3、修改数据库配置
如果想要修改日志地址为相对路径,可以修改 logback.xml
配置文件
4、启动xxl-job任务管理中心
运行成功后的界面是这样,登录账号是:admin/123456
二、SpringBoot集成Xxl-Job
1、添加依赖
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.3.1</version>
</dependency>
2、配置文件 .yml
创建一个springboot项目, 并添加相关的配置信息。
# xxl-job配置
xxl:
job:
admin:
# 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;xxl-job后台管理界面的地址
addresses: http://127.0.0.1:8081/xxl-job-admin
executor:
# 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
address:
# 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
appname: test-job
# 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
ip:
# 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
port: 0
# 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
logpath: logs/xxl-job/test-job
# 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;
logretentiondays: 15
# 执行器通讯TOKEN [选填]:非空时启用;
accessToken:
3、添加配置类
@Slf4j
@Configuration
@ComponentScan("com.hz.config")
public class XxlJobConfig {
@Value("${xxl.job.admin.addresses}")
private String adminAddresses;
@Value("${xxl.job.accessToken}")
private String accessToken;
@Value("${xxl.job.executor.address}")
private String address;
@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.executor.logpath}")
private String logPath;
@Value("${xxl.job.executor.logretentiondays}")
private int logRetentionDays;
@Bean
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;
}
}
4、添加一个测试任务
@Slf4j
@Component
@RequiredArgsConstructor
public class XxlJobTest {
@Resource
private IPersonInfoService iPersonInfoService;
@XxlJob("xxlJobTest")
public ReturnT<String> xxlJobTest(String date) {
XxlJobContext xxlJobContext = XxlJobContext.getXxlJobContext();
String jobParam = xxlJobContext.getJobParam();
log.info("---------xxlJobTest定时任务执行成功--------{}",jobParam);
return ReturnT.SUCCESS;
}
}
5、启动类添加注解 @EnableScheduling
@EnableScheduling
@SpringBootApplication
public class HzSjwInterfaceApplication {
public static void main(String[] args) {
SpringApplication.run(HzSjwInterfaceApplication.class, args);
}
}
6、启动springboot项目
三、实现任务调度
1、创建一个执行器
在执行器管理中新增一个执行器,执行器的AppName
是application.yml
配置文件中的xxl.job.admin.appname
的值。
注意:如果OnLine机器地址这里显示无,有可能是spring boot项目中的pom.xml出现问题,spring boot版本与xxl-job的版本不匹配。
2、创建一个任务
在任务管理中选择刚才创建的执行器,然后点击新增创建一个任务。
3、测试