垃圾站 网站优化 springboot整合xxl-job的示例代码

springboot整合xxl-job的示例代码

这篇文章主要介绍了springboot整合xxl-job的示例代码,主要分为三大模块,分别是调度中心、执行器和配置定时任务的过程,本文给大家介绍的非常详细,需要的朋友可以参考下!

关于xxl-job

在我看来,总体可以分为三大块:

调度中心

执行器

配置定时任务

调度中心

简单来讲就是 xxl-job-admin那个模块,配置:

从doc里面取出xxl-job.sql的脚本文件,创建对应的数据库。进行配置文件的配置,如下图

springboot整合xxl-job的示例代码插图

进行日志存放位置的修改

springboot整合xxl-job的示例代码插图1

然后idea打包之后就能当作调度中心运行了访问地址:ip:port/xxl-job-admin 默认的账号密码:admin/123456 注意:你进去后修改密码,有些浏览器就算你账号密码对了,可能还是会显示密码错误,默认使用谷歌浏览器。

执行器

就是我们使用springboot整合xxl-job需要编写的代码。 配置过程:

1.引入核心依赖,这里使用的是2.2.0

<!-- xxl-job -->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.2.0</version>
</dependency>

注意:这里的版本与你xxl-job-admin的版本保持一致。

2.配置文件

xxl:
  job:
    admin:
      addresses: http://127.0.0.1:8106/xxl-job-admin
    executor:
      appname: testJob #xxljob配置的执行器名称,
      ip:             #执行器IP,默认为空表示自动获取IP
      port: 9988 #xxljob配置的端口号,默认为9999
      logpath: ./data/xxl-job/jobhandler  #执行器运行日志文件存储磁盘路径
      logretentiondays: -1  #调度中心日志表数据保存天数,过期日志自动清理;限制大于等于7时生效,否则, 如-1,关闭自动清理功能
    accessToken: #调度中心通讯TOKEN [选填]:非空时启用

这里ip的获取,为空可以自动获取,你也可以在调度中心管理页面进行手动配置。

如果需要使用accessToken,那么就需要在xxl-job-admin的配置文件里进行配置对应。

springboot整合xxl-job的示例代码插图2

3.编写配置类

import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
​
/**
 * @DESC xxl-job配置类
 * @AUTHOR lh
 * @DATE 2022/6/23 11:41
 */
​
@Configuration
@Slf4j
public class XxlJobConfig {
​
@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
public XxlJobSpringExecutor xxlJobExecutor() {
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;
}
}

这里需要注意,高版本与低版本的配置类略有不同。

4.编写测试类

import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
​
/**
 * @DESC 测试定时任务代码
 * @AUTHOR lh
 * @DATE 2022/6/23 11:52
 */
@Slf4j
@Component
public class TestJob {
​
    @XxlJob("xxlJobTest")
    public ReturnT<String> xxlJobTest(String date) {
        log.info("---------xxlJobTest定时任务执行成功--------");
        return ReturnT.SUCCESS;
    }
}

注意:2.2.0版本,已经不支持@JobHandler注解了。 这里的XxlJob与调度中心的定时任务配置相对应。

springboot整合xxl-job的示例代码插图3

上一篇
下一篇

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注

联系我们

联系我们

返回顶部