You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

473 lines
22 KiB
Markdown

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# 02Spring Bean 依赖注入常见错误(上)
你好,我是傅健,这节课我们来聊聊 Spring @Autowired
提及Spring的优势或特性我们都会立马想起“**控制反转、依赖注入**”这八字真言。而@Autowired正是用来支持依赖注入的核心利器之一。表面上看它仅仅是一个注解在使用上不应该出错。但是在实际使用中我们仍然会出现各式各样的错误而且都堪称经典。所以这节课我就带着你学习下这些经典错误及其背后的原因以防患于未然。
## 案例1过多赠予无所适从
在使用@Autowired时不管你是菜鸟级还是专家级的Spring使用者都应该制造或者遭遇过类似的错误
> required a single bean, but 2 were found
顾名思义我们仅需要一个Bean但实际却提供了2个这里的“2”在实际错误中可能是其它大于1的任何数字
为了重现这个错误我们可以先写一个案例来模拟下。假设我们在开发一个学籍管理系统案例需要提供一个API根据学生的学号ID来移除学生学生的信息维护肯定需要一个数据库来支撑所以大体上可以实现如下
```
@RestController
@Slf4j
@Validated
public class StudentController {
@Autowired
DataService dataService;
@RequestMapping(path = "students/{id}", method = RequestMethod.DELETE)
public void deleteStudent(@PathVariable("id") @Range(min = 1,max = 100) int id){
dataService.deleteStudent(id);
};
}
```
其中DataService是一个接口其实现依托于Oracle代码示意如下
```
public interface DataService {
void deleteStudent(int id);
}
@Repository
@Slf4j
public class OracleDataService implements DataService{
@Override
public void deleteStudent(int id) {
log.info("delete student info maintained by oracle");
}
}
```
截止目前运行并测试程序是毫无问题的。但是需求往往是源源不断的某天我们可能接到节约成本的需求希望把一些部分非核心的业务从Oracle迁移到社区版Cassandra所以我们自然会先添加上一个新的DataService实现代码如下
```
@Repository
@Slf4j
public class CassandraDataService implements DataService{
@Override
public void deleteStudent(int id) {
log.info("delete student info maintained by cassandra");
}
}
```
实际上,当我们完成支持多个数据库的准备工作时,程序就已经无法启动了,报错如下:
![](https://static001.geekbang.org/resource/image/80/36/80b14cf13b383e48f64f7052d6747836.png)
很显然,上述报错信息正是我们这一小节讨论的错误,那么这个错误到底是怎么产生的呢?接下来我们具体分析下。
### 案例解析
要找到这个问题的根源,我们就需要对@Autowired实现的依赖注入的原理有一定的了解。首先我们先来了解下 @Autowired 发生的位置和核心过程。
当一个Bean被构建时核心包括两个基本步骤
1. 执行AbstractAutowireCapableBeanFactory#createBeanInstance方法通过构造器反射构造出这个Bean在此案例中相当于构建出StudentController的实例
2. 执行AbstractAutowireCapableBeanFactory#populate方法填充即设置这个Bean在本案例中相当于设置StudentController实例中被@Autowired标记的dataService属性成员。
在步骤2中“填充”过程的关键就是执行各种BeanPostProcessor处理器关键代码如下
```
protected void populateBean(String beanName, RootBeanDefinition mbd, @Nullable BeanWrapper bw) {
//省略非关键代码
for (BeanPostProcessor bp : getBeanPostProcessors()) {
if (bp instanceof InstantiationAwareBeanPostProcessor) {
InstantiationAwareBeanPostProcessor ibp = (InstantiationAwareBeanPostProcessor) bp;
PropertyValues pvsToUse = ibp.postProcessProperties(pvs, bw.getWrappedInstance(), beanName);
//省略非关键代码
}
}
}
}
```
在上述代码执行过程中因为StudentController含有标记为Autowired的成员属性dataService所以会使用到AutowiredAnnotationBeanPostProcessorBeanPostProcessor中的一种来完成“装配”过程找出合适的DataService的bean并设置给StudentController#dataService。如果深究这个装配过程又可以细分为两个步骤
1. 寻找出所有需要依赖注入的字段和方法参考AutowiredAnnotationBeanPostProcessor#postProcessProperties中的代码行
```
InjectionMetadata metadata = findAutowiringMetadata(beanName, bean.getClass(), pvs);
```
2. 根据依赖信息寻找出依赖并完成注入以字段注入为例参考AutowiredFieldElement#inject方法
```
@Override
protected void inject(Object bean, @Nullable String beanName, @Nullable PropertyValues pvs) throws Throwable {
Field field = (Field) this.member;
Object value;
//省略非关键代码
try {
DependencyDescriptor desc = new DependencyDescriptor(field, this.required);
//寻找“依赖”desc为"dataService"的DependencyDescriptor
value = beanFactory.resolveDependency(desc, beanName, autowiredBeanNames, typeConverter);
}
}
//省略非关键代码
if (value != null) {
ReflectionUtils.makeAccessible(field);
//装配“依赖”
field.set(bean, value);
}
}
```
说到这里,我们基本了解了@Autowired过程发生的位置和过程。而且很明显我们案例中的错误就发生在上述“寻找依赖”的过程中上述代码的第9行那么到底是怎么发生的呢我们可以继续刨根问底。
为了更清晰地展示错误发生的位置我们可以采用调试的视角展示其位置即DefaultListableBeanFactory#doResolveDependency中代码片段参考下图
![](https://static001.geekbang.org/resource/image/4c/f9/4cb99e17967847995bfe1d7ec0fe75f9.png)
如上图所示当我们根据DataService这个类型来找出依赖时我们会找出2个依赖分别为CassandraDataService和OracleDataService。在这样的情况下如果同时满足以下两个条件则会抛出本案例的错误
1. 调用determineAutowireCandidate方法来选出优先级最高的依赖但是发现并没有优先级可依据。具体选择过程可参考DefaultListableBeanFactory#determineAutowireCandidate
```
protected String determineAutowireCandidate(Map<String, Object> candidates, DependencyDescriptor descriptor) {
Class<?> requiredType = descriptor.getDependencyType();
String primaryCandidate = determinePrimaryCandidate(candidates, requiredType);
if (primaryCandidate != null) {
return primaryCandidate;
}
String priorityCandidate = determineHighestPriorityCandidate(candidates, requiredType);
if (priorityCandidate != null) {
return priorityCandidate;
}
// Fallback
for (Map.Entry<String, Object> entry : candidates.entrySet()) {
String candidateName = entry.getKey();
Object beanInstance = entry.getValue();
if ((beanInstance != null && this.resolvableDependencies.containsValue(beanInstance)) ||
matchesBeanName(candidateName, descriptor.getDependencyName())) {
return candidateName;
}
}
return null;
}
```
如代码所示,优先级的决策是先根据@Primary来决策其次是@Priority决策最后是根据Bean名字的严格匹配来决策。如果这些帮助决策优先级的注解都没有被使用名字也不精确匹配则返回null告知无法决策出哪种最合适。
2. @Autowired要求是必须注入的即required保持默认值为true或者注解的属性类型并不是可以接受多个Bean的类型例如数组、Map、集合。这点可以参考DefaultListableBeanFactory#indicatesMultipleBeans的实现
```
private boolean indicatesMultipleBeans(Class<?> type) {
return (type.isArray() || (type.isInterface() &&
(Collection.class.isAssignableFrom(type) || Map.class.isAssignableFrom(type))));
}
```
对比上述两个条件和我们的案例,很明显,案例程序能满足这些条件,所以报错并不奇怪。而如果我们把这些条件想得简单点,或许更容易帮助我们去理解这个设计。就像我们遭遇多个无法比较优劣的选择,却必须选择其一时,与其偷偷地随便选择一种,还不如直接报错,起码可以避免更严重的问题发生。
### 问题修正
针对这个案例,有了源码的剖析,我们可以很快找到解决问题的方法:**打破上述两个条件中的任何一个即可,即让候选项具有优先级或压根可以不去选择。**不过需要你注意的是,不是每一种条件的打破都满足实际需求,例如我们可以通过使用标记@Primary的方式来让被标记的候选者有更高优先级从而避免报错但是它并不一定符合业务需求这就好比我们本身需要两种数据库都能使用而不是顾此失彼。
```
@Repository
@Primary
@Slf4j
public class OracleDataService implements DataService{
//省略非关键代码
}
```
现在请你仔细研读上述的两个条件要同时支持多种DataService且能在不同业务情景下精确匹配到要选择到的DataService我们可以使用下面的方式去修改
```
@Autowired
DataService oracleDataService;
```
如代码所示修改方式的精髓在于将属性名和Bean名字精确匹配这样就可以让注入选择不犯难需要Oracle时指定属性名为oracleDataService需要Cassandra时则指定属性名为cassandraDataService。
## 案例 2显式引用Bean时首字母忽略大小写
针对案例1的问题修正实际上还存在另外一种常用的解决办法即采用@Qualifier来显式指定引用的是那种服务例如采用下面的方式
```
@Autowired()
@Qualifier("cassandraDataService")
DataService dataService;
```
这种方式之所以能解决问题在于它能让寻找出的Bean只有一个即精确匹配所以压根不会出现后面的决策过程可以参考DefaultListableBeanFactory#doResolveDependency
```
@Nullable
public Object doResolveDependency(DependencyDescriptor descriptor, @Nullable String beanName,
@Nullable Set<String> autowiredBeanNames, @Nullable TypeConverter typeConverter) throws BeansException {
//省略其他非关键代码
//寻找bean过程
Map<String, Object> matchingBeans = findAutowireCandidates(beanName, type, descriptor);
if (matchingBeans.isEmpty()) {
if (isRequired(descriptor)) {
raiseNoMatchingBeanFound(type, descriptor.getResolvableType(), descriptor);
}
return null;
}
//省略其他非关键代码
if (matchingBeans.size() > 1) {
//省略多个bean的决策过程即案例1重点介绍内容
}
//省略其他非关键代码
}
```
我们会使用@Qualifier指定的名称去匹配最终只找到了唯一一个。
不过在使用@Qualifier时我们有时候会犯另一个经典的小错误就是我们可能会忽略Bean的名称首字母大小写。这里我们把校正后的案例稍稍变形如下
```
@Autowired
@Qualifier("CassandraDataService")
DataService dataService;
```
运行程序,我们会报错如下:
> Exception encountered during context initialization - cancelling refresh attempt: org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'studentController': Unsatisfied dependency expressed through field 'dataService'; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.spring.puzzle.class2.example2.DataService' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true), @org.springframework.beans.factory.annotation.Qualifier(value=CassandraDataService)}
这里我们很容易得出一个结论:**对于Bean的名字如果没有显式指明就应该是类名不过首字母应该小写。**但是这个轻松得出的结论成立么?
不妨再测试下假设我们需要支持SQLite这种数据库我们定义了一个命名为SQLiteDataService的实现然后借鉴之前的经验我们很容易使用下面的代码来引用这个实现
```
@Autowired
@Qualifier("sQLiteDataService")
DataService dataService;
```
满怀信心运行完上面的程序依然会出现之前的错误而如果改成SQLiteDataService则运行通过了。这和之前的结论又矛盾了。所以显式引用Bean时首字母到底是大写还是小写呢
### 案例解析
对于这种错误的报错位置其实我们正好在本案例的开头就贴出了即第二段代码清单的第9行
```
raiseNoMatchingBeanFound(type, descriptor.getResolvableType(), descriptor);
```
即当因为名称问题例如引用Bean首字母搞错了找不到Bean时会直接抛出NoSuchBeanDefinitionException。
在这里我们真正需要关心的问题是不显式设置名字的Bean其默认名称首字母到底是大写还是小写呢
看案例的话当我们启动基于Spring Boot的应用程序时会自动扫描我们的Package以找出直接或间接标记了@Component的Bean的定义即BeanDefinition。例如CassandraDataService、SQLiteDataService都被标记了@Repository而Repository本身被@Component标记所以它们都是间接标记了@Component。
一旦找出这些Bean的信息就可以生成这些Bean的名字然后组合成一个个BeanDefinitionHolder返回给上层。这个过程关键步骤可以查看下图的代码片段ClassPathBeanDefinitionScanner#doScan
![](https://static001.geekbang.org/resource/image/27/49/277f3b2421a0e173a0eee56b7d65f849.png)
基本匹配我们前面描述的过程其中方法调用BeanNameGenerator#generateBeanName即用来产生Bean的名字它有两种实现方式。因为DataService的实现都是使用注解标记的所以Bean名称的生成逻辑最终调用的其实是AnnotationBeanNameGenerator#generateBeanName这种实现方式我们可以看下它的具体实现代码如下
```
@Override
public String generateBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) {
if (definition instanceof AnnotatedBeanDefinition) {
String beanName = determineBeanNameFromAnnotation((AnnotatedBeanDefinition) definition);
if (StringUtils.hasText(beanName)) {
// Explicit bean name found.
return beanName;
}
}
// Fallback: generate a unique default bean name.
return buildDefaultBeanName(definition, registry);
}
```
大体流程只有两步看Bean有没有显式指明名称如果有则用显式名称如果没有则产生一个默认名称。很明显在我们的案例中是没有给Bean指定名字的所以产生的Bean的名称就是生成的默认名称查看默认名的产生方法buildDefaultBeanName其实现如下
```
protected String buildDefaultBeanName(BeanDefinition definition) {
String beanClassName = definition.getBeanClassName();
Assert.state(beanClassName != null, "No bean class name set");
String shortClassName = ClassUtils.getShortName(beanClassName);
return Introspector.decapitalize(shortClassName);
}
```
首先获取一个简短的ClassName然后调用Introspector#decapitalize方法设置首字母大写或小写具体参考下面的代码实现
```
public static String decapitalize(String name) {
if (name == null || name.length() == 0) {
return name;
}
if (name.length() > 1 && Character.isUpperCase(name.charAt(1)) &&
Character.isUpperCase(name.charAt(0))){
return name;
}
char chars[] = name.toCharArray();
chars[0] = Character.toLowerCase(chars[0]);
return new String(chars);
}
```
到这,我们很轻松地明白了前面两个问题出现的原因:**如果一个类名是以两个大写字母开头的,则首字母不变,其它情况下默认首字母变成小写。**结合我们之前的案例SQLiteDataService的Bean其名称应该就是类名本身而CassandraDataService的Bean名称则变成了首字母小写cassandraDataService
### 问题修正
现在我们已经从源码级别了解了Bean名字产生的规则就可以很轻松地修正案例中的两个错误了。以引用CassandraDataService类型的Bean的错误修正为例可以采用下面这两种修改方式
1. 引用处纠正首字母大小写问题:
```
@Autowired
@Qualifier("cassandraDataService")
DataService dataService;
```
2. 定义处显式指定Bean名字我们可以保持引用代码不变而通过显式指明CassandraDataService 的Bean名称为CassandraDataService来纠正这个问题。
```
@Repository("CassandraDataService")
@Slf4j
public class CassandraDataService implements DataService {
//省略实现
}
```
现在我们的程序就可以精确匹配到要找的Bean了。比较一下这两种修改方法的话如果你不太了解源码不想纠结于首字母到底是大写还是小写建议你用第二种方法去避免困扰。
## 案例 3引用内部类的Bean遗忘类名
解决完案例2是不是就意味着我们能搞定所有Bean的显式引用不再犯错了呢天真了。我们可以沿用上面的案例稍微再添加点别的需求例如我们需要定义一个内部类来实现一种新的DataService代码如下
```
public class StudentController {
@Repository
public static class InnerClassDataService implements DataService{
@Override
public void deleteStudent(int id) {
//空实现
}
}
//省略其他非关键代码
}
```
遇到这种情况我们一般都会很自然地用下面的方式直接去显式引用这个Bean
```
@Autowired
@Qualifier("innerClassDataService")
DataService innerClassDataService;
```
很明显有了案例2的经验我们上来就直接采用了**首字母小写**以避免案例2中的错误但这样的代码是不是就没问题了呢实际上仍然会报错“找不到Bean”这是为什么
### 案例解析
实际上我们遭遇的情况是“如何引用内部类的Bean”。解析案例2的时候我曾经贴出了如何产生默认Bean名的方法即AnnotationBeanNameGenerator#buildDefaultBeanName当时我们只关注了首字母是否小写的代码片段而在最后变换首字母之前有一行语句是对class名字的处理代码如下
> String shortClassName = ClassUtils.getShortName(beanClassName);
我们可以看下它的实现参考ClassUtils#getShortName方法
```
public static String getShortName(String className) {
Assert.hasLength(className, "Class name must not be empty");
int lastDotIndex = className.lastIndexOf(PACKAGE_SEPARATOR);
int nameEndIndex = className.indexOf(CGLIB_CLASS_SEPARATOR);
if (nameEndIndex == -1) {
nameEndIndex = className.length();
}
String shortName = className.substring(lastDotIndex + 1, nameEndIndex);
shortName = shortName.replace(INNER_CLASS_SEPARATOR, PACKAGE_SEPARATOR);
return shortName;
}
```
很明显,假设我们是一个内部类,例如下面的类名:
> com.spring.puzzle.class2.example3.StudentController.InnerClassDataService
在经过这个方法的处理后,我们得到的其实是下面这个名称:
> StudentController.InnerClassDataService
最后经过Introspector.decapitalize的首字母变换最终获取的Bean名称如下
> studentController.InnerClassDataService
所以我们在案例程序中,直接使用 innerClassDataService 自然找不到想要的Bean。
### 问题修正
通过案例解析我们很快就找到了这个内部类Bean的引用问题顺手就修正了如下
```
@Autowired
@Qualifier("studentController.InnerClassDataService")
DataService innerClassDataService;
```
这个引用看起来有些许奇怪,但实际上是可以工作的,反而直接使用 innerClassDataService 来引用倒是真的不可行。
通过这个案例我们可以看出,**对源码的学习是否全面决定了我们以后犯错的可能性大小。**如果我们在学习案例2时就对class名称的变化部分的源码进行了学习那么这种错误是不容易犯的。不过有时候我们确实很难一上来就把学习开展的全面而深入总是需要时间和错误去锤炼的。
## 重点回顾
看完这三个案例我们会发现这些错误的直接结果都是找不到合适的Bean但是原因却不尽相同。例如案例1是因为提供的Bean过多又无法决策选择谁案例2和案例3是因为指定的名称不规范导致引用的Bean找不到。
实际上这些错误在一些“聪明的”IDE会被提示出来但是它们在其它一些不太智能的主流IDE中并不能被告警出来。不过悲剧的是即使聪明的IDE也存在误报的情况所以**完全依赖IDE是不靠谱的**,毕竟这些错误都能编译过去。
另外我们的案例都是一些简化的场景很容易看出和发现问题而真实的场景往往复杂得多。例如对于案例1我们的同种类型的实现可能不是同时出现在自己的项目代码中而是有部分实现出现在依赖的Jar库中。所以你一定要对案例背后的源码实现有一个扎实的了解这样才能在复杂场景中去规避这些问题。
## 思考题
我们知道了通过@Qualifier可以引用想匹配的Bean也可以直接命名属性的名称为Bean的名称来引用这两种方式如下
```
//方式1属性命名为要装配的bean名称
@Autowired
DataService oracleDataService;
//方式2使用@Qualifier直接引用
@Autowired
@Qualifier("oracleDataService")
DataService dataService;
```
那么对于案例3的内部类引用你觉得可以使用第1种方式做到么例如使用如下代码
> @Autowired
> DataService studentController.InnerClassDataService;
期待在留言区看到你的答案,我们下节课见!