前言
- 在项目中经常会出现要做定时任务的功能,如果你的项目中也需要做这个功能,并且你们公司用的是xxl-job来做,那你可以看下面所述内容
- 以下内容是的xxl-job版本是2.3.0版本
简介
- xxl-job分为两个部分(两个项目),一个是调度中心,一个是需要实现定时任务的项目
- 一般来说,如果你们公司用了xxl-job,那你们老大应该只会给你一个调度中心的网址,怎么用调度中心这个系统来调度你自己的项目的定时任务就是你自己的事了
- 下面说的是如何在老大给你的调度中心上调度你自己项目的定时任务
pom.xml
<!-- xxl-job-core 版本号根据自己下载的版本修改 -->
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.3.0</version>
<dependency>
- 这个包在maven官网是下载不到的,可以问老大要,也可以百度,也可以自己生成
- 生成步骤:下载项目–生成jar
- 第一步: github下载源码导入,下载地址:https://github.com/xuxueli/xxl-job/
- 第二步:打开下载的项目,点击生成jar包到本地maven库
logback.xml
- 在resources目录下面建一个文件 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/applogs/xxl-job/xxl-job-executor-sample-springboot.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>
application.yml加入配置
-----需修改或自定义
1、xxl.job.admin.addresses:调度中心那个项目的地址
2、xxl.job.executor.appname 自定义名称,后台配置必须对应
3、xxl.job.executor.ip 你的项目的Ip
4、xxl.job.executor.port 端口
xxl:
job:
executor:
logpath: "/data/applogs/xxl-job/jobhandler"
port: "9987"
ip: "179.87.9.151"
address: ""
logretentiondays: "30"
appname: "xxl-job-tzsb"
admin:
addresses: "http://179.87.9.119:8080/xxl-job-admin"
accessToken: ""
config: "classpath:logback.xml"
添加boot配置类 XxlJobConfig
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();
*/
}
定时任务类
@Component
public class TzsbJobHandler {
private static Logger log = LoggerFactory.getLogger(TzsbJobHandler.class);
/**
* 1、简单任务示例(Bean模式)
*/
@XxlJob("tzsbJobHandler")
public void demoJobHandler() throws Exception {
int count=0;
System.out.println("执行job任务"+count++);
}
}
调度中心配置
- 调度中心的配置图里面有些网址可能和上面填的不一样,因为这两张图我是copy别人的,懒得截了
- 打开你老大给你的调度中心网址
添加执行器
添加任务
- 定时规则生成:http://cron.qqe2.com/
- job任务名:@XxlJob注解值 >> 如:@XxlJob(“demoJobHandler”)