处理spring-boot-starter-quartz和spring-boot-starter-websocket同时使用报错

Posted 2021-03-29 felixu

背景

起初这个问题是同事在项目中发现的，搜索引擎了一下也就解决了这个问题，但是我同事比较好学，解决这个Bug的帖子很多，但是却没有提及为什么会出现此情况，遂问我能不能帮他看看原因，那我当然就义不容辞撸了一下源码。

分析问题

先看一眼报错吧：

2020-12-08 18:50:09.535 [main] ERROR org.springframework.boot.SpringApplication [line:837] - Application run failed
org.springframework.beans.factory.BeanNotOfRequiredTypeException: Bean named 'defaultSockJsTaskScheduler' is expected to be of type 'org.springframework.scheduling.TaskScheduler' but was actually of type 'org.springframework.beans.factory.support.NullBean'
    at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:399)
    at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:227)
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.resolveNamedBean(DefaultListableBeanFactory.java:1175)
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.resolveNamedBean(DefaultListableBeanFactory.java:1142)
    at org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor.resolveSchedulerBean(ScheduledAnnotationBeanPostProcessor.java:327)
    at org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor.finishRegistration(ScheduledAnnotationBeanPostProcessor.java:256)
    at org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor.onApplicationEvent(ScheduledAnnotationBeanPostProcessor.java:233)
    at org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor.onApplicationEvent(ScheduledAnnotationBeanPostProcessor.java:105)
    at org.springframework.context.event.SimpleApplicationEventMulticaster.doInvokeListener(SimpleApplicationEventMulticaster.java:172)
    at org.springframework.context.event.SimpleApplicationEventMulticaster.invokeListener(SimpleApplicationEventMulticaster.java:165)
    at org.springframework.context.event.SimpleApplicationEventMulticaster.multicastEvent(SimpleApplicationEventMulticaster.java:139)
    at org.springframework.context.support.AbstractApplicationContext.publishEvent(AbstractApplicationContext.java:404)
    at org.springframework.context.support.AbstractApplicationContext.publishEvent(AbstractApplicationContext.java:361)
    at org.springframework.context.support.AbstractApplicationContext.finishRefresh(AbstractApplicationContext.java:898)
    at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:554)
    at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:143)
    at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:758)
    at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:750)
    at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:397)
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:315)
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:1237)
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:1226)

首先我们从报错入手，BeanNotOfRequiredTypeException显然是Bean的类型不对，然后我们再具体看名称叫defaultSockJsTaskScheduler的Bean类型不对，那搜索大法，先分别从@EnableWebSocket和@EnableScheduling点进行，把这两个包的源码下载了再说，然后全局搜索defaultSockJsTaskScheduler，这时候找定义叫defaultSockJsTaskScheduler的，很容易定位到org.springframework.web.socket.config.annotation.WebSocketConfigurationSupport#defaultSockJsTaskScheduler，它的定义如下：

@Bean
@Nullable
public TaskScheduler defaultSockJsTaskScheduler() {
    if (initHandlerRegistry().requiresTaskScheduler()) {
        ThreadPoolTaskScheduler threadPoolScheduler = new ThreadPoolTaskScheduler();
        threadPoolScheduler.setThreadNamePrefix("SockJS-");
        threadPoolScheduler.setPoolSize(Runtime.getRuntime().availableProcessors());
        threadPoolScheduler.setRemoveOnCancelPolicy(true);
        this.scheduler = threadPoolScheduler;
    }
    return this.scheduler;
}

这里的逻辑具体分析一下会知道，如果if条件不满足，这里将返回null，也就是会创建一个NullBean在容器中作为TaskScheduler。

我们找到了NullBean产生的地方，那么为什么单独使用两个包都不会有问题呢，只能解释，当单独使用spring-boot-starter-websocket时，即使创建了NullBean但是并不会被使用，而增加spring-boot-starter-quartz的过程肯定使用到了TaskScheduler。而单独使用spring-boot-starter-quartz又没有问题，所以肯定还有地方实例化了TaskScheduler，那么进入TaskScheduler，然后看看那些地方用到了它：

)

很容易猜到TaskSchedulingAutoConfiguration，我们进去看到了如下：

@Bean
@ConditionalOnBean(name = TaskManagementConfigUtils.SCHEDULED_ANNOTATION_PROCESSOR_BEAN_NAME)
@ConditionalOnMissingBean({ SchedulingConfigurer.class, TaskScheduler.class, ScheduledExecutorService.class })
public ThreadPoolTaskScheduler taskScheduler(TaskSchedulerBuilder builder) {
    return builder.build();
}

单独有spring-boot-starter-websocket时，会创建defaultSockJsTaskScheduler，但是没地方用到，所以不会有问题，而引入spring-boot-starter-quartz时，由于上面产生的NullBean导致这个条件装配失效，所以不会产生合适的TaskScheduler实例。由于@EnableScheduling的存在，导致org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor#finishRegistration会被执行到，为啥不用细说了吧(不明白可以截图找我问)，此时该方法中会执行this.registrar.setTaskScheduler(resolveSchedulerBean(this.beanFactory, TaskScheduler.class, false));代码，这里的resolveSchedulerBean将会去容器中找TaskScheduler的实例，通过名称找到了defaultSockJsTaskScheduler，但是他的类型却是个NullBean此时就会触发上述错误。

这便是导致这个Bug的原因了，有些人可能疑惑，你上面那些类咋知道的，emmmm，找这种问题一般步骤就是猜想、验证、整理。所以先猜，再Debug验证。

解决问题

那既然知道了为什么会出现这个错了，就容易修复了，就是因为存在了一个NullBean类型的TaskScheduler实例，在查找的时候出现了该错误，那么我们只需要自己创建一个正确类型就好了：

@Bean
public ThreadPoolTaskScheduler taskScheduler(TaskSchedulerBuilder builder) {
    return builder.build();
}

当然，根据前面提到的if条件不满足才会出现NullBean，那么自然还有种方案，那就是让if条件满足，即实现一个WebSocketConfigurer也可以解决这个问题(看一下if附近的注释，实现应该不难，不给案例了)。

可以可以，问题解决，愉快的告诉同事咋回事就完事了。

一点思考

然鹅，此时另一个念头冒出来了。这不应该是Spring Framework的Bug吗，虽然在几个使用TaskScheduler的地方都说明可以为null，但是可以为null和创建了一个NullBean类型作为TaskScheduler的实例，并导致了真正在使用的时候产生了错误，这妥妥的Spring Framework的Bug啊。那为啥明明是Bug，网上也有不少关于这个错误的处理方案，那么官方却没有解决呢，看了一下版本，这个问题存在好些个版本了，难道没人提过issue，看了一眼好像还真是。那！！！提！！！

说干就干，啪提个issue，官方回复很快，经过讨论后，据说会在5.3.3处理该问题，比较曲折的是，一开始提在Spring Framework下，后来被迁到了Spring Boot下，然后讨论完又认为是Spring Framework的问题，所以处理者又重新开了个新的issue。

结语

• 找问题要多猜想验证

• 敢于质疑，不论对于Spring Framework还是对于其他大佬，不能一味相信，要有自己的判断力

好了，就这样吧，又水一篇文章，唉~