SpringBoot整合XXL-JOB- 执行器的具体使用

科技   2024-09-23 08:00   河北  


新建项目

在项目中添加依赖:需要添加xxl-job的相关依赖,这里的版本以你使用的为准

<!-- http://repo1.maven.org/maven2/com/xuxueli/xxl-job-core/ -->
<dependency>    
    <groupId>com.xuxueli</groupId>    
    <artifactId>xxl-job-core</artifactId>    
    <version>${最新稳定版本}</version>
</dependency>

导入依赖后,我们还需要在配置文件中做一些配置

### 调度中心部署根地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
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这一关键项。正如大家回忆起上文中调度中心配置部分所提及的,accessToken是执行器与调度中心之间建立通信并进行身份验证的重要凭证。因此,确保这两端配置的accessToken完全一致,是它们能够顺畅通信的前提。

接下来,我们聚焦于IP地址的配置部分。正如注释中所详尽说明的,IP地址的配置并非强制性的,系统能够自动检测并获取当前的网络地址。当然,根据实际需求,您也可以选择手动填写一个固定的IP地址。这样的灵活性,旨在满足不同场景下的配置需求。


完成了以上的配置后,我们还需要对执行器进行配置,将它注册成Bean交由Spring容器管理

@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;
    }
}

创建测试方法

使用的方式也很简单,在方法上使用 @XxlJob 注解并写上执行器名称(Ps:自定义即可)即可,

@Component
public class TestJob {

    @XxlJob("jobTestHandler")
    public void jobTestHandler() {
        System.out.println("hello World!" + "- " + "定时任务执行时间:" +new Date());
    }
}

启动定时任务

回到调度中心,去到执行器管理模块,如下:

现在执行器已经被自动注册了,来看下机器地址,就是我们创建的项目

确认了执行器正确注册后,接下来,来到任务管理模块:

来新建一个任务,不做高级配置,只填写必填项。

调度类型运行模式先全部默认不改JobHandler把我们前面注解里写的名称填在这里

接下来启动任务:

查看控制台可以看到控制台多了一条输出记录


总结
通过这篇介绍,各位读者已经掌握了Xxl-Job的基本使用方法,这无疑让大家深刻体会到了这款分布式任务调度中间件的诸多优势。我们不再需要深陷于定时器实现的细节之中,而是能够集中精力于编写那些真正需要定时执行的业务逻辑。这种解耦的设计思想,无疑极大地提升了开发效率与系统的可维护性。期待在接下来的篇章中,我们将深入探讨Xxl-Job的路由策略,为大家揭示更多高级功能与应用场景!

Java技术前沿
专注分享Java技术,包括但不限于 SpringBoot,SpringCloud,Docker,消息中间件等。
 最新文章