一、部署XXL-JOB任务调度中心
下载地址:XXXL开源社区
1、初始化数据库
2、修改配置文件
修改数据库密码,注意spring.mail.password设置是邮箱授权码,不是邮箱密码
3、启动项目
http://localhost:8080/xxl-job-admin/ 账号和密码,admin/123456
二、使用任务调度中心
1、新建执行器
2、新增任务管理器
报警邮件:当调度任务发生异常时,会往当前邮箱发送报警邮件
JobHandler:这个名称可以随便写,但要记住这个名称,因为springboot集成时会用到这个名称
其他的默认就行
三、SpringBoot集成XXL-JOB
1、依赖
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.3.1</version>
</dependency>
2、properties文件配置
server.port=8081
#------------xxl-job配置--------------
# log config
logging.config=classpath:logback.xml
### 调度中心部署地址,多个配置逗号分隔 such as "http://address" or "http://address01,http://address02"
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器token,非空时启动 token?xxl-job, access token,这个和任务调度中心配置的accessToken保持一致
xxl.job.accessToken=default_token
### 执行器app名称,和控制台那边配置一样的名称,不然注册不上去 xxl-job executor appname
xxl.job.executor.appname=itcloud-executor
### 【选填】 执行器注册:优先使用该配置作为注册地址,为空时使用内嵌服务 “IP:PORT” 作为注册地址
#从而更灵活的支持容器类型执行器动态IP和动态映射端口问题
xxl.job.executor.address=
### 【选填】执行器IP:默认为空表示自动获取IP(即springboot容器的ip和端口,可以自动获取,也可以指定),多网卡是可手动设置指定IP,该IP不会绑定Host仅作为通讯使用;
xxl.job.executor.ip=
#【选填】执行器端口号:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同的执行器端口;
xxl.job.executor.port=9999
### 执行器日志文件存储路径,需要对该路径拥有读写权限;为空则使用默认路径
xxl.job.executor.logpath=/data/logs/xxl-job/executor
### 执行器日志保存天数
xxl.job.executor.logretentiondays=30
3、新增logback.xml日志文件
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="true" scanPeriod="1 seconds">
<contextName>logback</contextName>
<property name="log.path" value="/data/logs/=itcloud-xxl-job.log"/>
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${log.path}</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}.%d{yyyy-MM-dd}.zip</fileNamePattern>
</rollingPolicy>
<encoder>
<pattern>%date %level [%thread] %logger{36} [%file : %line] %msg%n
</pattern>
</encoder>
</appender>
<root level="info">
<appender-ref ref="console"/>
<appender-ref ref="file"/>
</root>
</configuration>
4、新建配置类 XxlJobConfig,这个是固定配置,照抄就行
package cn.itcloud.itcloudxxjob.config;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* @author zqing
* @description: TODO
* @date: 2022/6/29 15:27
*/
@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();
*/
}
5、新建定时任务配置类 MyJobHandler
package cn.itcloud.itcloudxxjob.job;
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
/**
* @author zqing
* @description: TODO
* @date: 2022/6/29 15:42
*/
@Component
@Slf4j
public class MyJobHandler {
@Value("${server.port}")
private String port;
@XxlJob(value="demoJobHandler", init = "init", destroy = "destroy")
public ReturnT<String> execute(){
log.info("定时任务触发成功:"+ LocalDateTime.now());
log.info("端口号:{}",port);
String jobParam = XxlJobHelper.getJobParam();
log.info("参数:{}",jobParam);
return ReturnT.SUCCESS;
}
private void init(){
log.info("init 调用成功");
}
private void destroy(){
log.info("destroy 调用成功");
}
}
其中 value="demoJobHandler" 的值是前面配置的JobHandler名称
6、 启动项目
7、查询执行器的机器地址,看是否注册成功,如果没有地址要等15秒-30秒左右才会出来
四、执行调度任务
1、执行一次
说明执行成功了,可以看调度日志
2、附带参数执行调度
3、启动任务
任务是每5秒执行一次
以上就是集成效果,具体请看官方文档 XXL开源社区