xxl-job任务调度2.0.2升级到2.3.0版本，执行器改造过程中经验总结

妖狐艹你老母 2024-03-27 18:45 21阅读 0赞

#### xxl-job任务调度2.0.2升级到2.3.0版本 ####

*  一、背景
 *  二、开始改造
 *   *  1、修改pom.xml
     *  2、修改Handler
     *  3、启动服务并验证
     *  4、解决异常
     *  5、再次启动服务并验证

## 一、背景 ##

现在要对一批老项目中的执行器进行升级，原来老项目中的执行器，依赖的任务调度中心xxl-job版本是2.0.2-SNAPSHOT版本，现在要依赖2.3.0版本的xxl-job任务调度中心

## 二、开始改造 ##

老项目的执行器，使用的是spring版本，需要tomcat来启动服务，这里拿一个纯净的spring项目来演示，具体如下：  
![在这里插入图片描述][d167962a89264ceda682728737e0dffa.png]

### 1、修改pom.xml ###

打开pom.xml文件，原文件是这样的  
![在这里插入图片描述][8d616324933a437aa26c6a4114addad2.png]  
如下：

<parent>
    		<groupId>com.xuxueli</groupId>
    		<artifactId>xxl-job-executor-samples</artifactId>
    		<version>2.0.2-SNAPSHOT</version>
    	</parent>

修改执行器依赖xxl-job-core的版本，改为2.3.0版本  
![在这里插入图片描述][ceb18fab9a2d40d9ad02b87dacdd76e9.png]  
如下：

<parent>
    		<groupId>com.xuxueli</groupId>
    		<artifactId>xxl-job-executor-samples</artifactId>
    		<version>2.3.0</version>
    	</parent>

### 2、修改Handler ###

升级到2.3.0版本之后，我们发现Handler类报错了  
![在这里插入图片描述][a9dd1706db244c14b5a4119137dd053b.png]  
原因就是因为，新版本的xxl-job，已经弃用了@JobHandler注解，采用了@XxlJob注解，并且@XxlJob注解只能作用在方法上面哦。

改造步骤：

*  1、去掉@JobHandler注解
 *  2、去掉 extends IJobHandler
 *  3、方法上加上@XxlJob注解
 *  4、返回值 SUCCESS 改为 ReturnT.SUCCESS

代码参考：

package com.xxl.job.executor.service.jobhandler;
    
    import com.xxl.job.core.biz.model.ReturnT;
    import com.xxl.job.core.handler.annotation.XxlJob;
    import com.xxl.job.core.log.XxlJobLogger;
    import org.springframework.stereotype.Component;
    import java.util.concurrent.TimeUnit;
    
    @Component
    public class DemoJobHandler {
        
    
    	@XxlJob("demoJobHandler")
    	public ReturnT<String> execute(String param) throws Exception {
        
    		XxlJobLogger.log("XXL-JOB, Hello World.");
    
    		for (int i = 0; i < 5; i++) {
        
    			XxlJobLogger.log("beat at:" + i);
    			TimeUnit.SECONDS.sleep(2);
    		}
    		return ReturnT.SUCCESS;
    	}
    
    }

### 3、启动服务并验证 ###

版本也升级了，handler类也改造好了，貌似没什么问题了，那我们直接启动tomcat服务，来验证一下。  
启动之后，我们看一下控制台日志

![在这里插入图片描述][5ca9abf6a42b44f1a418e75f75716df7.png]

Connected to server
    [2023-10-20 10:34:31,713] Artifact xxl-job-executor-sample-spring:war exploded: Artifact is being deployed, please wait...
    20-Oct-2023 10:34:38.787 信息 [RMI TCP Connection(5)-127.0.0.1] org.apache.jasper.servlet.TldScanner.scanJars At least one JAR was scanned for TLDs yet contained no TLDs. Enable debug logging for this logger for a complete list of JARs that were scanned but no TLDs were found in them. Skipping unneeded JARs during scanning can improve startup time and JSP compilation time.
    20-Oct-2023 10:34:38.885 严重 [RMI TCP Connection(5)-127.0.0.1] org.apache.catalina.core.StandardContext.startInternal One or more listeners failed to start. Full details will be found in the appropriate container log file
    20-Oct-2023 10:34:38.887 严重 [RMI TCP Connection(5)-127.0.0.1] org.apache.catalina.core.StandardContext.startInternal Context [] startup failed due to previous errors
    [2023-10-20 10:34:38,903] Artifact xxl-job-executor-sample-spring:war exploded: Error during artifact deployment. See server log for details.

如果这个看不出来，可以看一下另外的输出日志  
![在这里插入图片描述][861196a6ab1a45f894dfc323d6a08389.png]

org.apache.catalina.core.ApplicationContext.log No Spring WebApplicationInitializer types detected on classpath
    20-Oct-2023 10:34:38.834 严重 [RMI TCP Connection(5)-127.0.0.1] org.apache.catalina.core.StandardContext.listenerStart Error configuring application listener of class org.springframework.web.util.Log4jConfigListener
     java.lang.ClassNotFoundException: org.springframework.web.util.Log4jConfigListener

### 4、解决异常 ###

刚刚启动服务的时候，报错了，比较核心的错误日志是这一句：

java.lang.ClassNotFoundException: org.springframework.web.util.Log4jConfigListener

就是说tomcat启动的时候，没有找到spring中的Log4jConfigListener类，OK，我们先看一下spring的版本，升级到2.3.0之后，spring-webmvc的版本也跟着改变了，变成了5.3.3版本  
![在这里插入图片描述][0ae35a1b84eb407eae2dac9147936233.png]  
经过查询，发现org.springframework.web.util.Log4jConfigListener这个类在spring5.0及以上版本已经废弃删除，如果想使用这个类，spring版本需要降低。原来如此，那我们直接将spring的版本降为升级前的版本

<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-webmvc</artifactId>
    			<version>4.3.22.RELEASE</version>
    		</dependency>

OK，接下来启动服务，看一下  
![在这里插入图片描述][21563450d991425c9194890084f6c533.png]

我们发现虽然报错了，但至少spring容器在加载初始化一些配置了，我们分析一下错误：

Invalid property 'appName' of bean class [com.xxl.job.core.executor.impl.XxlJobSpringExecutor]: Bean property 'appName' is not writable or has an invalid setter method. Did you mean 'appname'?

应该是属性名称不一样，我们找一下源码，打开一下XxlJobSpringExecutor类

public class XxlJobSpringExecutor extends XxlJobExecutor implements ApplicationContextAware, SmartInitializingSingleton, DisposableBean {
        
        private static final Logger logger = LoggerFactory.getLogger(XxlJobSpringExecutor.class);
        private static ApplicationContext applicationContext;
    
        public XxlJobSpringExecutor() {
        
        }
    
        public void afterSingletonsInstantiated() {
        
            this.initJobHandlerMethodRepository(applicationContext);
            GlueFactory.refreshInstance(1);
    
            try {
        
                super.start();
            } catch (Exception var2) {
        
                throw new RuntimeException(var2);
            }
        }
        .....

发现没有，继续找他的父类XxlJobExecutor，终于找到了，我们看到appname这个字段是这样命名的  
![在这里插入图片描述][9bf5231a71ef47e98fbd7c32aef1296b.png]  
所以，我们回到项目中，看一下项目中的配置文件  
![在这里插入图片描述][cbb7915a223f42979f7b0bf05c071a3b.png]  
原来这个地方写成了appName，所以只要把他改成appname就可以了  
![在这里插入图片描述][2d846dd6b0e24a58a9d6255f73b4cbfb.png]

### 5、再次启动服务并验证 ###

![在这里插入图片描述][6e40c747668f4b10afddb4a98f1815ff.png]  
我们发现终于启动成功了，再看一下，执行器是否注册到任务调度中心了  
![在这里插入图片描述][8637e974cc554557be17e9718d8704ab.png]  
我们随便建一个任务执行一下看看  
![在这里插入图片描述][f5a4b873235e40aa8259d064a3da81c2.png]  
执行成功  
![在这里插入图片描述][fd2e610c861e452fb797d824fa9d8474.png]

![在这里插入图片描述][870ab6d63274468fb191cb066833e75b.png]  
至此，执行器的版本升级结束

[d167962a89264ceda682728737e0dffa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/b7f025ea535e43e4a360656c245e4479.png
[8d616324933a437aa26c6a4114addad2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/277b69e7f7d6498f881d0ec18ac43fa6.png
[ceb18fab9a2d40d9ad02b87dacdd76e9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/f0d712cf20074344a3f8089074a59535.png
[a9dd1706db244c14b5a4119137dd053b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/dfee8cea639a4629ae828ba18ccd685b.png
[5ca9abf6a42b44f1a418e75f75716df7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/165418c54f2342da80bafe875a73a320.png
[861196a6ab1a45f894dfc323d6a08389.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/ddc5d5a8c9ef4c96a2408f19394b508a.png
[0ae35a1b84eb407eae2dac9147936233.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/172e3ff8558f4b089d8a74f0d9f137c0.png
[21563450d991425c9194890084f6c533.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/2512b0336ed747e49158b521c48b8015.png
[9bf5231a71ef47e98fbd7c32aef1296b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/2d82e3ce1bd948d29c90d422811c217e.png
[cbb7915a223f42979f7b0bf05c071a3b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/6f46517b5d7c42a6b3a694a28eaa979c.png
[2d846dd6b0e24a58a9d6255f73b4cbfb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/5359d215714a427892245e00e099a9ef.png
[6e40c747668f4b10afddb4a98f1815ff.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/f37f4469248d40f68f6b7fd94a7e5de0.png
[8637e974cc554557be17e9718d8704ab.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/979038d387174887b4d84a0ada36a7f3.png
[f5a4b873235e40aa8259d064a3da81c2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/3c0e6adb9abb4328bc8a5ac58d499991.png
[fd2e610c861e452fb797d824fa9d8474.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/94d2e90280f14e6ca20e067933b34bf4.png
[870ab6d63274468fb191cb066833e75b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/b7465cd6aacf431b9ba64d5f96369783.png