xxl-job集成springboot实战，xxl-job定时任务详解

置顶小七蒙恩

已于 2024-06-04 17:27:33 修改

阅读量5.2k

点赞数 6

分类专栏： springboot 文章标签： spring boot java maven 定时任务后端

于 2022-01-17 17:51:58 首次发布

本文链接：https://blog.csdn.net/qq_38105536/article/details/122544713

版权

springboot 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

xxl-job集成springboot实战，xxl-job定时任务详解

Xxl-job是什么？

我不做大量官方的解释，下面有官网地址，可以自己去看。
我的解释：XXL-JOB是一个分布式任务调度平台。它可以与其他微服务组件一起构成微服务集群。如果你的项目小，只有一个springboot，也完全可以集成xxl-job，处理你的所有定时任务。简而言之，不需要写大量代码实现复杂的定时任务，而是完全交给xxl-job来管理。只需要简单的设置定时任务即可。

Xxl-job项目地址：

GitHub地址：https://github.com/xuxueli/xxl-job
Gitee地址：https://gitee.com/xuxueli0323/xxl-job

官网地址：

https://www.xuxueli.com/xxl-job/
可以查看详细的说明文档。以及使用步骤。
研究这个需要大量时间，如果你有精力，可以去一点点学习，如果你想快速使用xxl-job集成到springboot，本篇文章够用了。

1. 下载项目。

通过上面地址下载项目源码，并下载依赖。

2. Install项目。

为什么install？
我们把项目install成maven依赖到本地maven仓库。防止后期我们使用xxl-job-core这依赖时报错，因为阿里maven库是没有这个包的，你要自己install一下。

在这里插入图片描述

3. 查看项目结构。

在这里插入图片描述

4. xxl-job分布式架构执行逻辑。

在这里插入图片描述

5. 集成到项目。

5.1定时任务管理器xxl-job-admin构建。

将xxl-job-admin这个子项目从源代码中复制出来，使用idea打开，可以看出它就是个springboot项目。以后这个就是我们的定时任务管理器，可以打jar包，独立于你的项目运行。
在这里插入图片描述

5.1为定时任务管理器创建数据库。

数据库使用源码中带的sql文件，在\xxl-job-2.3.0\doc\db下的tables_xxl_job.sql。
使用前可以修改数据库名称。
在这里插入图片描述

使用navicate创建xxl-job-admin数据库

5.2修改xxl-job-admin配置文件

打开application.properties修改端口地址和数据库地址、用户名、密码
在这里插入图片描述

### web
#启动端口
server.port=8089
server.servlet.context-path=/xxl-job-admin

### actuator
management.server.servlet.context-path=/actuator
management.health.mail.enabled=false

### resources
spring.mvc.servlet.load-on-startup=0
spring.mvc.static-path-pattern=/static/**
spring.resources.static-locations=classpath:/static/

### freemarker
spring.freemarker.templateLoaderPath=classpath:/templates/
spring.freemarker.suffix=.ftl
spring.freemarker.charset=UTF-8
spring.freemarker.request-context-attribute=request
spring.freemarker.settings.number_format=0.##########

### mybatis
mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml
#mybatis.type-aliases-package=com.xxl.job.admin.core.model

### xxl-job, datasource
#数据库连接地址
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job_admin?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

### datasource-pool
spring.datasource.type=com.zaxxer.hikari.HikariDataSource
spring.datasource.hikari.minimum-idle=10
spring.datasource.hikari.maximum-pool-size=30
spring.datasource.hikari.auto-commit=true
spring.datasource.hikari.idle-timeout=30000
spring.datasource.hikari.pool-name=HikariCP
spring.datasource.hikari.max-lifetime=900000
spring.datasource.hikari.connection-timeout=10000
spring.datasource.hikari.connection-test-query=SELECT 1
spring.datasource.hikari.validation-timeout=1000

### xxl-job, email
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
spring.mail.from=xxx@qq.com
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

### xxl-job, access token
xxl.job.accessToken=

### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en")
xxl.job.i18n=zh_CN

## xxl-job, triggerpool max size
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100

### xxl-job, log retention days
xxl.job.logretentiondays=30

5.3启动xxl-job-admin

在浏览器访问http://localhost:8089/xxl-job-admin/，用户名admin 密码123456
登录成功，此时没有任务运行。
至此，定时任务管理器已经运行成功，我们开始集成到自己的项目。

在这里插入图片描述

5.4将你的项目集成到xxl-job.

这里我的项目使用，xxl-job源码中的springboot实例项目来演示。

1）pom文件添加xxl-job-core。

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

2）修改配置文件application.properties修改

如下四个地方
在这里插入图片描述

# web port
#自定义
server.port=8085
# no web
#spring.main.web-environment=false

# log config
logging.config=classpath:logback.xml


### xxl-job admin address list, such as "http://address" or "http://address01,http://address02"
###xxl-job-admin监听地址，与你的xxl-job-admin对应
xxl.job.admin.addresses=http://127.0.0.1:8089/xxl-job-admin

### xxl-job, access token
xxl.job.accessToken=

### xxl-job executor appname
#执行器名称,自定义
xxl.job.executor.appname=xxl-job-executor-dume
### xxl-job executor registry-address: default use address to registry , otherwise use ip:port if address is null
xxl.job.executor.address=
### xxl-job executor server-info
xxl.job.executor.ip=
#项目执行器地址，每个项目都不一样
xxl.job.executor.port=8061
### xxl-job executor log-path
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### xxl-job executor log-retention-days
xxl.job.executor.logretentiondays=30

3）添加XxlJobConfig

这个代码不用改,直接用。

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;

    @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();
     */


}

4）编写简单的定时任务

package com.xxl.job.executor.service.jobhandler;

import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.stereotype.Component;

/**
 * @author dume
 * @create 2022-01-17 16:58
 **/
@Component
public class XxljobManager {

    /**
     * bean模式定时任务
     * @XxlJob("dumeExecutor")
     * @throws Exception
     */
    @XxlJob("dumeExecutor")
    public void dumeExecutor() throws Exception {

        XxlJobHelper.log("XXL-JOB, Hello World.");
        System.out.println("定时任务执行！");
    }

}