在上节中,我们部署了调度中心,并且认识了调度中心,那么让它与我们的项目相结合呢?就需要用到"执行器 ",通过调度中心配置的"执行器",再在我们的项目里使用,就可以实现定时任务的控制了。
一、新建项目
要使用执行器,一方面要在调度中心里配置,另一方面就需要在项目中使用了,所以我们先新建一个SpringBoot的项目,如下: 输入项目的基本信息后引入依赖,这里只是个简单demo,所以导入个Spring-Web就够了,如下: 点击创建,我们的新项目就创建好了!
二、导入依赖
需要添加xxl-job的相关依赖,这里的版本以你使用的为准,比如我使用的2.4.1,就填2.4.1,如下:
xml
<!-- http://repo1.maven.org/maven2/com/xuxueli/xxl-job-core/ -->
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>${最新稳定版本}</version>
</dependency>
三、配置文件
导入依赖后,我们还需要做些简单的配置,如下:
ini
### 调度中心部署根地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器通讯TOKEN [选填]:非空时启用;
xxl.job.accessToken=default_token
### 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-sample
### 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 "IP:PORT" 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
xxl.job.executor.address=
### 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
xxl.job.executor.ip=127.0.0.1
### 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
xxl.job.executor.port=9999
### 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;
xxl.job.executor.logretentiondays=30
这里的配置我们先来看下accessToken,大家还记得上篇调度中心的配置项也有这个,执行器和调度中心进行通信的前提就是需要这个token进行校验,所以这里必须一致。然后是下面有关ip的配置,如注释中写的那样,不配置也可以自动获取,也可以写固定的。
四、执行器配置
完成了以上的配置后,我们还需要对执行器进行配置,主要目的是将它注册成Bean 交由Spring容器管理,如下:
java
@Configuration
public class XxlJobConfig {
@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() {
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;
}
}
五、声明测试方法
完成了基础的配置后,我们就可以正式开始使用了。使用的方式也很简单:首先声明一个大家都很熟悉的输出Hello World的方法,然后在这个方法上使用 @XxlJob 注解并写上执行器名称(Ps:自定义即可)即可,这个名称有什么用下面会说,代码如下:
java
@Component
public class TestJob {
@XxlJob("jobTestHandler")
public void jobTestHandler() {
System.out.println("hello World!" + "- " + "定时任务执行时间:" +new Date());
}
}
六、启动定时任务
接下来,再次回到调度中心 ,去到执行器管理 模块,如下: 可以看到执行器已经被自动注册了,我们可以看下机器地址,是不是刚刚我们新建的项目,如下: 可以看到和刚刚项目的地址和端口号一致,说明执行器已经注册成功了,当然大家也可以手动添加,如下: 验证了执行器的注册成功后,我们再去到任务管理 模块,如下: 新建一个任务 ,初体验我们只填这几个必填项,其他高级配置先不管,后面再讲。执行器 目前我们只注册了一个,所以也不用选了;任务描述 根据实际业务写,我这里就写测试了;负责人 根据实际填写,我这里就随便写了;Cron 表达式旁边有时间选择器,根据需要自己调整即可,我们这里测试就5秒执行一次试试,如下: 调度类型 和运行模式 先全部默认不改,最后的JobHandler 把我们前面注解里写的名称填在这里就行了,如下:
保存后可以看到我们新建的这条任务,但此时控制台还看不到任何输出,我们可以看到这条任务的状态还不是运行中,所以我们需要将它启动,如下: 在启动之前可以先执行一次进行测试,如下: 任务参数我们暂时用不到,地址也从执行器获取就行,点击保存,可以看到控制台多了一条输出记录,如下: 测试没问题后,我们启动这个任务,观察控制台,如下: 控制台开始间隔5秒进行输出,测试成功,此时任务的状态也变为了运行中,如下:
七、小结
通过这篇,大家已经掌握了Xxl-Job的基本使用了,相信大家也感受到这款中间件的好处了,我们只需要关注需要定时执行的业务逻辑的编写,而不需要关注定时器本身,后续我们会将将怎么用它做分片!