spring boot项目整合xxl-job

最新推荐文章于 2025-02-19 09:15:00 发布

原创最新推荐文章于 2025-02-19 09:15:00 发布 · 403 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #mybatis #java

中间件专栏收录该内容

2 篇文章

订阅专栏

本文档详细介绍了XXL-JOB的快速入门步骤，包括调度中心的下载、数据库初始化、配置及部署。同时，展示了如何在项目中整合XXL-JOB，添加依赖、配置执行器，并编写及运行定时任务。最后，提供了执行器项目的部署方法。

一、快速入门

1.下载地址

https://github.com/xuxueli/xxl-job
https://gitee.com/xuxueli0323/xxl-job

2.初始化调度数据库

调度数据库初始化SQL脚本位置为：/xxl-job/doc/db/tables_xxl_job.sql
在这里插入图片描述

3.编译源码

在这里插入图片描述

4.配置调度中心

------------------------------------------------------xxl-job[application.yml]
### web
server.port=9001
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://192.168.199.109:3306/xxl_job?useUnicode=true&characterEncoding=utf-8&useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=123456
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=60
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=1333333333@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

------------------------------------------------------项目config[application.yml]
xxl:
	job:
	admin:
		addresses:http://192.168.199.64:9001/xxl-job-admin
	executor:
		appname: xxl-job-executor-lilishop
		address:
		ip:
		port: 8891
		logpath: ./xxl-job/executor
		logretentiondays: 7

5.部署调度中心

调度中心访问地址：http://localhost:8080/xxl-job-admin (该地址执行器将会使用到，作为回调地址)，默认登录账号 admin/123456，看到运行界面说明“调度中心”项目已经部署成功。
在这里插入图片描述

二、项目整合

1.在项目中添加依赖

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

2.载入配置文件XxlJobConfig.java

读取配置文件

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;

@Configuration
public class XxlJobConfig {
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);

    @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(initMethod = "start", destroyMethod = "destroy")
    public XxlJobSpringExecutor xxlJobExecutor() {
        logger.info(">>>>>>>>>>> xxl-job config init.");
        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;
    }

    /**
     * 针对多网卡、容器内部署等情况，可借助 "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();
     */
}

3.编写一个自己的定时任务

@JobHandler(value = "MyJobHandler")
@Component
public class MyJobHandler extends IJobHandler {
	private Logger log = LoggerFactory.getLogger(MyJobHandler.class);
	
	//demoJobHandler与任务调度中心的JobHandler一致
    @XxlJob(value="demoJobHandler",init="init",destroy="destroy")
    public ReturnT<String> execute(String param) throws Exception {
        System.out.println("我们不能失去信仰");
        log.info("任务触发成功" + LocalDateTime.now());
        return SUCCESS;
    }
    private void init(){
    	log.info("init 方法调用了");
    }
    private void destroy(){
    	log.info("destroy方法调用了");
    }
}

4.任务管理里面新增任务

在这里插入图片描述

启动MyJobHandler 就可以看到结果，刚刚编写的代码已经被执行了。

5.部署执行器项目：

如果已经正确进行上述配置，可将执行器项目编译打部署，系统提供多种执行器Sample示例项目，选择其中一个即可，各自的部署方式如下。

xxl-job-executor-sample-springboot：项目编译打包成springboot类型的可执行JAR包，命令启动即可；
xxl-job-executor-sample-frameless：项目编译打包成JAR包，命令启动即可；