上篇文章大体介绍了如何将xxl-job在自己的电脑上部署好,这篇用来介绍如何去新增一个执行器,也就是将spring项目整合,可以使用xxl-job进行执行。
一、新建一个springboot项目。
新建一个项目。
选中spring web、Mysql Driver、JDBC API、Mybatis Framework等依赖,后面就是点击确定,然后成功创建项目。
配置项目
首先引入xxl依赖。
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.1.0</version>
</dependency>
然后配置工程的application.properties文件,截图代码如下。其中
spring.datasource.url=jdbc:mysql://localhost:3306/xxl_job?Unicode=true&characterEncoding=UTF-8
spring.datasource.username=root
spring.datasource.password=7546857
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
server.port=8082
### xxl-job admin address list, such as "http://address" or "http://address01,http://address02"
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### xxl-job executor address
xxl.job.executor.appname=xxl-test
xxl.job.executor.ip=
xxl.job.executor.port=30020
### xxl-job, access token
xxl.job.accessToken=
### xxl-job log path
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### xxl-job log retention days
xxl.job.executor.logretentiondays=-1
接下来创建一个XxlJobConfig类,进行扫描JobHandler的位置。
package com.example.demo.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.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() {
logger.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;
}
}
最后创建继承了IJobHandler的类,也就是JobHandler,例子如下:
package com.example.demo.jobhandler;
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.IJobHandler;
import com.xxl.job.core.handler.annotation.JobHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
@Component
@JobHandler("test")
public class TestJobHander extends IJobHandler {
private Logger logger= LoggerFactory.getLogger(TestJobHander.class);
@Override
public ReturnT<String> execute(String s) throws Exception {
System.out.println("11111111111111111111");
logger.info("lalalala");
return ReturnT.SUCCESS;
}
}
这样就可以启动作为一个新的执行器了。
进入xxl-job页面进行新增执行器
保存之后,到相应的执行器下进行创建任务,然后执行一次就可以看到自己的输出了。
点击执行一次,查看日志。
下面是后台的输出打印:
下面更新一下一些东西,xxljob版本更新后,@JobHandler注解不被使用了,继续使用的话会出现一个错误xxl-rpc request data empty,解决方法就是使用新版本的xxljob。
依赖配置
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.3.0</version>
</dependency>
此外还有一些地方需要修改,
- 在XxlJobConfig 配置类里面,需要修改一个参数,xxlJobSpringExecutor.setAppName(appName)修改为xxlJobSpringExecutor.setAppname(appName)。
- 将@JobHandler替换为@XxlJob,区别是@XxlJob是放在方法上面的,类不需要继承IHandler了。