一次Spring NoSuchBeanDefinitionException排查过程

川长思鸟来 2022-02-04 15:23 290阅读 0赞

产生NoSuchBeanDefinitionException的[一般原因][Link 1]，不清楚的同学可以先了解一波。  
而此次场景有所不同，具体的排查定位过程如下。

### 问题描述 ###

在该场景下，对应类【LoanQuestionListStrategy】标注了spring的@Service注解，并且处于【component-scan】扫描路径下。

@Service("loanQuestionListStrategy")
    public class LoanQuestionListStrategy {...}

在部署的时候，意外发生了，抛出了`NoSuchBeanDefinitionException name loanQuestionListStrategy`异常。  
具体的堆栈信息如下：

Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No bean named 'loanQuestionListStrategy' available
    	at org.springframework.beans.factory.support.DefaultListableBeanFactory.getBeanDefinition(DefaultListableBeanFactory.java:687)
    	at org.springframework.beans.factory.support.AbstractBeanFactory.getMergedLocalBeanDefinition(AbstractBeanFactory.java:1207)
    	at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:284)
    	at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:202)
    	at org.springframework.context.annotation.CommonAnnotationBeanPostProcessor.autowireResource(CommonAnnotationBeanPostProcessor.java:522)
    	at org.springframework.context.annotation.CommonAnnotationBeanPostProcessor.getResource(CommonAnnotationBeanPostProcessor.java:496)
    	at org.springframework.context.annotation.CommonAnnotationBeanPostProcessor$ResourceElement.getResourceToInject(CommonAnnotationBeanPostProcessor.java:627)
    	at org.springframework.beans.factory.annotation.InjectionMetadata$InjectedElement.inject(InjectionMetadata.java:169)
    	at org.springframework.beans.factory.annotation.InjectionMetadata.inject(InjectionMetadata.java:88)
    	at org.springframework.context.annotation.CommonAnnotationBeanPostProcessor.postProcessPropertyValues(CommonAnnotationBeanPostProcessor.java:318)
    	... 71 more

追踪到at org.springframework.beans.factory.support.DefaultListableBeanFactory.getBeanDefinition(DefaultListableBeanFactory.java:687)\`  
具体如下图所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70]  
发现在**beanDefinitionMap**中根据beanName获取BeanDefinition失败后会抛出该异常信息。  
那么为什么**beanDefinitionMap**中没有【LoanQuestionListStrategy】对应的BeanDefinition呢？  
既然**beanDefinitionMap**中没有，那么说明对应的BeanDefinition根本就没有put进去，自然而然要找到**beanDefinitionMap-PUT**的调用的地方。

在该场景下，唯一PUT的地方是在component-scan标签解析过程中进行的。  
熟悉spring handlers机制的同学可能立马能够找到【component-scan】标签扫描并注册BeanDefinition的位置。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 1]  
对应的类为：【ComponentScanBeanDefinitionParser】

在该类里会默认会扫描classpath\*路径下标注【Component】【Repository】【Service】【Controller】注解的类，并将其转化为BeanDefinition存储在上述的**beanDefinitionMap**中。  
具体步骤：如下所示：  
第一步：构建ClassPathBeanDefinitionScanner扫描器  
第二步：进行扫描，获取符合条件的BeanDefinitions  
第三步：注册BeanDefinitions到上述的**beanDefinitionMap**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 2]  
经过断点调试，发现第一步扫描根本就没有返回对应的BeanDefinition，于是继续深入【ClassPathBeanDefinitionScanner.doScan】方法，doScan方法通过调用【ClassPathBeanDefinitionScanner.findCandidateComponents】方法获取候选的BeanDefinition，在其方法调用中标注条件断点`（metadataReader.getClassMetadata().getClassName().contains("LoanQuestionListStrategy")）`  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 3]  
发现此断点没有生效。  
what???，到此已经一脸甭比。  
突然在【ClassPathBeanDefinitionScanner】类【findCandidateComponents（获取候选BeanDefinition）】方法中发现了如下红框所示的语句。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 4]  
其中packageSearchPath表示ClassPathBeanDefinitionScanner.scan的范围，默认是ClassPath\*下的所有以class结尾的文件。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 5]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 6]

那么会不会是没有对应的class文件呢？  
证明发现：确实是没有。![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 7]  
那么问题已经浮出水面，ClassPathBeanDefinitionScanner在classpath\*路径下没有发现对应的资源文件，就不会注册BeanDefinition到**beanDefinitionMap**，那么在最终获取的时候就会报出NoSuchBeanDefinitionException的错误。

### 那么Class文件为什么丢了？ ###

在这之前，我进行了一次清除缓存操作，怀疑该操作有bug。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 8]

## 解决方案： ##

删除掉target目录，重新编译即可。

[Link 1]: https://blog.csdn.net/jiangchao858/article/details/51586515
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70]: /images/20220204/5a3fc753c77248fd8ca754dacec5c2c4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 1]: /images/20220204/9c55cb5b32864561a0ee390f79d7da74.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 2]: /images/20220204/ed2b376a135d4baea2205a13b0311175.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 3]: /images/20220204/905000a832d04e8198eecc3f2565b816.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 4]: /images/20220204/07b6d6cbc5234dddb280317283e9c18d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 5]: /images/20220204/7e74102d8b7a47f7b583ddf114ebb41d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 6]: /images/20220204/bbf0cf5d2e22401583aefb22cdac37b0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 7]: /images/20220204/7650ae621f9948af89655eee098ca3ec.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 8]: /images/20220204/691c8d66d47749e6a60e345255248b72.png