springboot集成xxl-job分布式调度

前言

文章在springboot项目中集成xxl-job分布式调度完成定时任务，文章作为学习记录使用。

1. xxl-job使用

这里介绍xxl-job项目的首次集成配置启动完成定时任务执行。

（1）拉取xxl-job

gitee地址：https://gitee.com/xuxueli0323/xxl-job.git

（2）初始化数据库

项目拉取成功后看到执行下面的SQL文件（tables_xxl_job.sql）到数据库中，初始化数据库配置。

（3）修改配置文件

找到xxl-job-admin模块下的配置文件application.properties，修改为自己的数据库相关配置

（4）启动项目

直接启动xxl-job-admin的启动类
启动成功后浏览器访问地址：http://localhost:8080/xxl-job-admin
初始密码：admin 123456
看到如下界面，第一次启动成功

2.springboot项目集成xxl-job

（1）导入依赖

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

（2）准备配置文件

a. yml配置

注意这里的accessToken必须和你xxl-job中的token配置一致，否则会注册失败，address是xxl-job的后台管理页面，执行器端口随便写。

#xxl-job
xxl:
  job:
    accessToken: default_token
    admin:
      # xxl-job后台管理界面的地址
      addresses: http://127.0.0.1:8080/xxl-job-admin
    executor:
      # 此执行器的名称
      appName: rabbitmq-project
      # 此执行器的端口
      port: 8888
      # 此执行器的日志存放路径
      logPath: logs/xxl-job/rabbitmq-project
      # 此执行器的日志保存时间
      logRetentionDays: 7

b. 获取值配置

admin：

@Data
@Component
@ConfigurationProperties(prefix = "xxl.job.admin")
public class XxlJobAdminProperties {
    private String addresses;
}

executor：

@Data
@Component
@ConfigurationProperties(prefix = "xxl.job.executor")
public class XxlJobExecutorProperties {
    private String appName;
    private String port;
    private String logPath;
    private String logRetentionDays;
}

accessToken：

@Data
@Component
@ConfigurationProperties(prefix = "xxl.job")
public class XxlJobTokenProperties {
    private String accessToken;
}

获取配置文件值也可以直接在配置类中使用@Value(“${xxl.job.accessToken}”)注解获取

c.配置类

启动类加上注解：@EnableScheduling
配置类：

@Configuration
public class XxlJobConfig {

    @Autowired
    private XxlJobAdminProperties adminProperties;
    @Autowired
    private XxlJobExecutorProperties executorProperties;
    @Autowired
    private XxlJobTokenProperties tokenProperties;

    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses(adminProperties.getAddresses());
        xxlJobSpringExecutor.setAppname(executorProperties.getAppName());
        xxlJobSpringExecutor.setPort(Integer.valueOf(executorProperties.getPort()));
        xxlJobSpringExecutor.setLogPath(executorProperties.getLogPath());
        xxlJobSpringExecutor.setAccessToken(tokenProperties.getAccessToken());
        xxlJobSpringExecutor.setLogRetentionDays(Integer.valueOf(executorProperties.getLogRetentionDays()));
        return xxlJobSpringExecutor;
    }
}

（3）编写测试类测试

a. 测试类

@Slf4j
@Component
public class XxlJobTest {

    @XxlJob("xxlJobTest")
    public Result test() {
        log.info("执行定时任务");
        return Result.success();
    }
}

b. 管理页面配置

添加执行器：
这里的AppName就是我们yml配置中的appName，必须保持一致，这样才能保证成功注册上去，名称随便选，选自动注册时，机器地址就不需要填写

添加任务：
在任务管理界面，选择刚刚我们添加的执行器，点击新增任务。
选择执行器，输入负责人，cron表达式，jobHandler，注意这里的jobHandler就是我们刚刚测试类里面@XxlJob中的值，保持一致，点击完成。
操作：
这里对当前任务进行操作，执行停止等，右边导航栏调度日志可以看到相关日志信息。
执行成功