spring框架对于不同包下同名类的查找问题
问题背景
在使用dubbo的时候突然想到如果不同提供者的类名一样的话那调用时怎么办(因为调用提供者的服务包名结构必须要一致)。于是找了一下这个问题
问题分析
(可能比较冗余,如果不想看可以直接跳结论)
java描述一个类(相同加载器,相同虚拟机),确实是依赖类的完整名(包名+类名),也就是说,不同包下的同名类,互相完全没有关系,是两个完全不同的类。但spring对这种类的处理却和这种方式不同。很有趣的问题,因此决定把它搞清楚。
是spring中,被它所管理的类是通过BeanDefinition来描述的,而注册一个bean,是通过这个函数registerBeanDefinition(String beanName, BeanDefinition beanDefinition)进行的。
最终bean会被存储在这样一个map里:private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap(256);
现在的报错原因,就是因为在注册bean之前,对beanName做了唯一性验证,而这个验证正好失败。
我们继续看spring的源码
//扫码获取bean的主要函数
protected Set<BeanDefinitionHolder> doScan(String... basePackages) {
Assert.notEmpty(basePackages, "At least one base package must be specified");
Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<BeanDefinitionHolder>();
for (String basePackage : basePackages) {
Set<BeanDefinition> candidates = findCandidateComponents(basePackage);
for (BeanDefinition candidate : candidates) {
ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate);
candidate.setScope(scopeMetadata.getScopeName());
String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry); //获取beanName
if (candidate instanceof AbstractBeanDefinition) {
postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName);
}
if (candidate instanceof AnnotatedBeanDefinition) {
AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate);
}
if (checkCandidate(beanName, candidate)) { //该步报错,conflicts
BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName);
definitionHolder =
AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
beanDefinitions.add(definitionHolder);
registerBeanDefinition(definitionHolder, this.registry);
}
}
}
return beanDefinitions;
}
现在问题变成了为什么beanNameGenerator.generateBeanName(candidate, this.registry);会返回类名,而不是package+类名。
我们继续看generateBeanName的实现,有两个实现
DefaultBeanNameGenerator
AnnotationBeanNameGenerator
先看DefaultBeanNameGenerator的实现,它的实现相对简单,核心代码是这句String generatedBeanName = definition.getBeanClassName();而它的实现如下
@Override
public String getBeanClassName() {
Object beanClassObject = this.beanClass;
if (beanClassObject instanceof Class) {
return ((Class<?>) beanClassObject).getName(); //返回类的完整名,packageName + className
}
else {
return (String) beanClassObject;
}
}
也就是说,DefaultBeanNameGenerator返回的beanName是packageName+beanName。
总结
spring并不支持不同的包下类名相同的设定。这是因为默认的spring检索bean的唯一id(@Service,@Component等)为bean的name,并不包含package name信息。想要规避这种问题有两种方式
a 对bean显式命名,@Service("yourName")
b 使用xml的方式声明bean
在调用同名的类时第二个需要写全包名结构,使用 @Qualifier 注释和 @Autowired 注释通过指定哪一个真正的 bean 将会被装配来消除混乱。如:
@RestController
public class TestController {
@Autowired
private TestService testService;
@Autowired @Qualifier("dTestService")
private com.example.demo.service.TestService t2;
@RequestMapping(value = "t")
public String testt(String str){
return t2.s1(str);
}
@RequestMapping(value = "d")
public String testd(String str){
return testService.testWord(str);
}
@RequestMapping(value = "test")
public String test(String str){
return "Hello "+str+" test";
}
}
@Qualifier限定描述符除了能根据名字进行注入,更能进行更细粒度的控制如何选择候选者