SpringBoot整合XxlJob

2023-02-27 | 0 评论 | 0 浏览

SpringBoot整合XxlJob

1.XxlJob简介

官方网址：https://www.xuxueli.com/xxl-job

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

为什么要使用分布式任务调度呢？无论是针对分布式项目或者是nginx负载均衡,传统的定时任务实现方式都很慢满足，比如

2.XxlJob快速入门

2.1下载源码仓库地址

源码仓库地址	Release Download
https://github.com/xuxueli/xxl-job	Download
http://gitee.com/xuxueli0323/xxl-job	Download

2.2定时任务实现步骤

1.在数据库中执行项目中的sql脚本

2.目录结构说明

xxl-job-admin：调度中心
 xxl-job-core：公共依赖
 xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
     ：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式；
     ：xxl-job-executor-sample-frameless：无框架版本；

3.修改调度中心配置文件

### web
 server.port=8080
 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?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=授权码
 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 调度中心通讯TOKEN [选填]：非空时启用； 
 ###　如果配置了通讯token,则调度中心和执行器两个服务的accessToken需保持一致
 xxl.job.accessToken=
 
 ### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en")
 # 调度中心国际化配置 [必填]： 默认为 "zh_CN"/中文简体, 可选范围为 "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
 #调度中心日志表数据保存天数 [必填]：过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
 xxl.job.logretentiondays=30

如果已经正确进行上述配置，可将项目编译打包部署。

调度中心访问地址：http://localhost:8080/xxl-job-admin (该地址执行器将会使用到，作为回调地址)

默认登录账号 “admin/123456”, 登录后运行界面如下图所示。

4.配置执行器项目

xxl-job-executor-sample-frameless原生方式（不推荐）
 “执行器”项目：xxl-job-executor-sample-springboot (提供多种版本执行器供选择，现以 springboot 版本为例，可直接使用，也可以参考其并将现有项目改造成执行器)
 作用：负责接收“调度中心”的调度并执行；可直接部署执行器，也可以将执行器集成到现有业务项目中。

# web port
 server.port=8081
 # no web
 #spring.main.web-environment=false
 
 # log config
 logging.config=classpath:logback.xml
 
 
 # 调度中心部署根地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
 xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
 
 # 执行器通讯TOKEN [选填]：非空时启用；
 xxl.job.accessToken=
 
 # 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
 xxl.job.executor.appname=xxl-job-executor-llp
 # 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
 xxl.job.executor.address=
 # 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
 xxl.job.executor.ip=
 # 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
 xxl.job.executor.port=0
 # 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
 xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
 # 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
 xxl.job.executor.logretentiondays=30

5.添加执行器

6.添加定时任务

7.编写测试程序

package com.xxl.job.executor.service.jobhandler;
 
 import com.xxl.job.core.context.XxlJobHelper;
 import com.xxl.job.core.handler.annotation.XxlJob;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.stereotype.Component;
 
 
 @Component
 public class TestXxlJob {
     private static Logger logger = LoggerFactory.getLogger(TestXxlJob.class);
 
 
     @XxlJob(value = "testJobHandler", init = "init", destroy = "destroy")
     public void testJobHandler() throws Exception {
         logger.info("进入xxlJob定时任务。。。。");
 
     }
 
 
     public void init(){
         logger.info("init");
     }
     public void destroy(){
         logger.info("destroy");
     }
 
 
     @XxlJob("testJobHandler02")
     public void demoJobHandler() throws Exception {
         XxlJobHelper.log("XXL-JOB, Hello World.");
         logger.info("进入testJobHandler02定时任务。。。。");
     }
 
 }

8.执行定时任务进行测试

查看调度日志

3.SpringBoot整合XxlJob

1.创建SpringBoot工程引入依赖

<dependency>
     <groupId>com.xuxueli</groupId>
     <artifactId>xxl-job-core</artifactId>
     <version>${稳定版}</version>
 </dependency>

2.编写properties配置文件

# web port
 server.port=8081
 # no web
 #spring.main.web-environment=false
 
 # log config
 logging.config=classpath:logback.xml
 
 
 # 调度中心部署根地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
 xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
 
 # 执行器通讯TOKEN [选填]：非空时启用；
 xxl.job.accessToken=llp
 
 # 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
 xxl.job.executor.appname=xxl-job-executor-llp
 # 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
 xxl.job.executor.address=
 # 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
 xxl.job.executor.ip=127.0.0.1
 # 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
 xxl.job.executor.port=9999
 # 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
 xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
 # 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
 xxl.job.executor.logretentiondays=30

注意，在调度中心创建任务时，appname和执行器配置的appname必须保持一致；执行器的ip和port建议都配置上

3.编写xxljob配置类

@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.编写job类进行测试

@Component
 public class TestXxlJob {
     private static Logger logger = LoggerFactory.getLogger(TestXxlJob.class);
 
 
     @XxlJob(value = "testJobHandler", init = "init", destroy = "destroy")
     public void testJobHandler() throws Exception {
         logger.info("进入xxlJob定时任务。。。。");
 
     }
 
 
     public void init(){
         logger.info("init");
     }
     public void destroy(){
         logger.info("destroy");
     }
 
 
     @XxlJob("testJobHandler02")
     public void demoJobHandler() throws Exception {
         XxlJobHelper.log("XXL-JOB, Hello World.");
         logger.info("进入testJobHandler02定时任务。。。。");
     }
 
 }

创建执行器

创建任务

查看后台执行日志

如果需要xxlJob邮件报警功能，则需要在xxl-job-admin中进行配置邮件信息，并在创建任务时指定配置的邮箱地址

### 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=授权码
 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

ps:如果定时任务执行频率很高，频繁失败的话，那收邮件就是一个噩梦~

4.XxlJob部署

4.1 jar包部署方式

jar包部署的方式比较简单，将项目编译打包部署到服务器上，其他服务和xxljob调度器之间网络、接口相通即可

4.2 Docker 镜像方式搭建调度中心

下载镜像

# Docker地址：https://hub.docker.com/r/xuxueli/xxl-job-admin/     (建议指定版本号)
 docker pull xuxueli/xxl-job-admin
 
 
 # 如需自定义 mysql 等配置，可通过 "-e PARAMS" 指定，参数格式 PARAMS="--key=value  --key2=value2" ；
 # 配置项参考文件：/xxl-job/xxl-job-admin/src/main/resources/application.properties
 # 如需自定义 JVM内存参数 等配置，可通过 "-e JAVA_OPTS" 指定，参数格式 JAVA_OPTS="-Xmx512m" ；
 
 docker run -e PARAMS="--spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai" -p 8080:8080 -v /tmp:/data/applogs --name xxl-job-admin  -d xuxueli/xxl-job-admin:{指定版本}

标题：SpringBoot整合XxlJob
作者：llp
地址：https://llinp.cn/articles/2023/02/27/1677504993676.html