xxl-job的在springboot下的使用

目录

官方文档：

官方代码：

新建的定时任务：

 需要注意对应的bean模式选择和对应的jobhandler要对应上。

最后控制台执行结果查看：

3.2 BEAN模式（方法形式）

springboot samples pom 目录下多了：

config类

新建项目测试：

步骤一：执行器项目中，开发Job类：

---

                                                                                                                                                                                                                                                                                                                               首先介绍产生的背景，因为quartz框架和业务是耦合的，所以使用起来随着项目的扩大，那么后续越来越复杂，难以正确的梳理对应的规律和规范，详情可参考：

• 问题一：调用API的的方式操作任务，不人性化；
• 问题二：需要持久化业务QuartzJobBean到底层数据表中，系统侵入性相当严重。
• 问题三：调度逻辑和QuartzJobBean耦合在同一个项目中，这将导致一个问题，在调度任务数量逐渐增多，同时调度任务逻辑逐渐加重的情况下，此时调度系统的性能将大大受限于业务；
• 问题四：quartz底层以“抢占式”获取DB锁并由抢占成功节点负责运行任务，会导致节点负载悬殊非常大；而XXL-JOB通过执行器实现“协同分配式”运行任务，充分发挥集群优势，负载各节点均衡。

quartz的在springboot下的使用http://quartzhttp://quartz那么有这个痛点之后，我们就知道了需要怎么样的使用更好的东西了，就是和业务分开可以独立配置的xxl-job所以答案也就出来了，这正是xxl-job的产生背景和使用原因：

官方文档：

分布式任务调度平台XXL-JOBXXL-JOB是一个轻量级分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。https://www.xuxueli.com/xxl-job/#%E6%AD%A5%E9%AA%A4%E4%B8%80%EF%BC%9A%E6%89%A7%E8%A1%8C%E5%99%A8%E9%A1%B9%E7%9B%AE%E4%B8%AD%EF%BC%8C%E5%BC%80%E5%8F%91Job%E7%B1%BB%EF%BC%9A

官方代码：

xxl-job: 一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。https://gitee.com/xuxueli0323/xxl-job

部署指南也就相对简单了：

初始化数据库：

之后修改对应的admin的配置文件 application.properties 的数据库部分：

 之后就可以启动了，先启动admin

然后再启动 xxl-job-executor-sample-springboot模块，因为springboot相对简单，只需要电脑本身有对应的仓库和数据库，对应的启动就可可以，不需要过多的配置，比如ssm等

启动成功，访问链接：

http://localhost:8080/xxl-job-admin/jobinfohttp://localhost:8080/xxl-job-admin/jobinfo对应的说明，官方文档已经比较全了，

作为spring boot的业务里面，怎么用对应的job 这是我们开发者比较关心的：

只需要在对应的方法上注解：该方法名的注解即可：

code

 /**
     * 1、简单任务示例（Bean模式）
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");
        logger.info("简单任务示例（Bean模式）");
        for (int i = 0; i < 5; i++) {
            XxlJobHelper.log("beat at:" + i);
            TimeUnit.SECONDS.sleep(2);
        }
        // default success
    }

新建的定时任务：

 需要注意对应的bean模式选择和对应的jobhandler要对应上。

然后在新建的定时任务任务管理器的执行一次上，选择执行一次，可以看到对应的日志打印记录：

 由于就在本机所以，机器地址不需要填写，

当然填写了本地 127.0.0.1 或者 ipconfig 查出来的机器 ip为什么会执行出错，这个还需要去研究调用的逻辑（todo）

最后控制台执行结果查看：

可以看出用开源的代码执行并且验证，很容易就能够得出正确的结论。

当然也可以，查看配置的日志文件的位置，查看日志文件。默认配置的是根目录下的data文件夹下，如果没有会新建，比如我的如下：

那么问题来了，我们自己新建的springboot项目 ，直接这么简单粗暴也可以么：

3.2 BEAN模式（方法形式）

所以这个需要研究 samples项目结构，并且自己新建来看看：

研究的不一致的地方，看pom 看config

springboot samples pom 目录下多了：

    <!-- xxl-job-core -->
        <dependency>
            <groupId>com.xuxueli</groupId>
            <artifactId>xxl-job-core</artifactId>
            <version>${project.parent.version}</version>
        </dependency>

外层的

xxl-job-executor-samples的pom并没有什么不一样：

config类

package com.xxl.job.executor.core.config;

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.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;
    /*配置的路径就是根目录的位置下的目录，所以下一步我们需要做的是logback。xml 配置使用 todo*/
    @Value("${xxl.job.executor.logpath}")
    private String logPath;

    @Value("${xxl.job.executor.logretentiondays}")
    private int logRetentionDays;


    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        logger.info(">>>>>>>>>>> xxl-job config init.");
        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;
    }

    /**
     * 针对多网卡、容器内部署等情况，可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP；
     *
     *      1、引入依赖：
     *          <dependency>
     *             <groupId>org.springframework.cloud</groupId>
     *             <artifactId>spring-cloud-commons</artifactId>
     *             <version>${version}</version>
     *         </dependency>
     *
     *      2、配置文件，或者容器启动变量
     *          spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
     *
     *      3、获取IP
     *          String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
     */


}

所以我们猜想就因为多了 xxl-job-core这个依赖，然后手动的新建springboot项目，复制对应的config类，相同的操作一下，应该就可以

新建项目测试：

 可以看到我新建一个项目：

新增对应的pom

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

复制对应的 config 类 和对应的 properties 文件以及  logback.xml  文件

 修改对应的 appname  为自己的模块名字

 

就可以执行成功。

步骤一：执行器项目中，开发Job类：

当然上一个的场景是定时任务是某个方法，那么如果我要job是一个比较复杂的用了其他的resources注解或者资源类应该怎么做呢？

1、自定义一个继承Ijobhandler类，然后注入：

/**
 * @author liuyuchao
 * @date 2021/12/7
 * @description
 */
public class TestJobClass extends IJobHandler {
    @Override
    public void execute() throws Exception {
        System.out.println(" hello ijobhandler success");
    }
}

    @PostConstruct
    public static void main() {
        XxlJobExecutor.registJobHandler("demo", new TestJobClass());
    }

2、配置对应的 glue的的Java代码开发：

新建任务的时候选择 glue即可