位置：首页-资讯-后端开发

springboot多数据源使用@Qualifier自动注入无效的解决

2024-04-02 19:55

短信预约 -IT技能 免费直播动态提醒

@Qualifier自动注入无效的解决

问题

使用springboot进行多数据源时，发生了单例DataSource对应多个DataSourceBean的问题。

具体错误如下：XXXXX required a single bean, but 3 were found。通过@Qualifier来区分，或是在@Bean中添加name属性来区分，都没有作用。

问题的根本原因

主要在于SpringBoot的DataSourceInitializer，该类在autoConfigure包中，用来自动初始化一个内置的DataSource实例，在创建该实例的时候发生了注入的问题。

创建实例的流程（记录一下方便以后再次调试）：

1. 调用DataSourceInitializer的构造方法

2. 调用AbstractAutowireCapableBeanFactory的applyMergedBeanDefinitionPostProcessors方法

3. 调用AbstractAutowireCapableBeanFactory的initializeBean方法

4. AbstractAutowireCapableBeanFactory的applyBeanPostProcessorsBeforeInitialization方法，其中有一个循环是用多种Bean处理器来处理DataSourceInitializer对象

5. 之后使用反射的方式跳转到DataSourceInitializer的init方法

6.里面通过this.applicationContext.getBean(DataSource.class)来获取所有DataSource的实现类对象实例。

7. DefaultListableBeanFactory的resolveNamedBean方法中来选取实例对象，通过里面的getBeanNamesForType方法获取到所有的符合requireType(也就是DataSource.class)的对象。

8. 如果对象实例的实例数量大于1，则会进入以下的两个判断：

判断是否有Primary的实例，或者是优先级高的实例对象，如果有，则将候选对象名赋值给candidateName。没有则置为空，最后抛出多个实例的异常。

其中问题出在

因为项目中只使用了@Qualifier，而且springboot的DataSourceInitializer没有对@Qualifier的处理，所以没有对实例进行匹配。

造成多个数据源实例。对于存在多数据源的情况，他们做的补救措施是在代码中添加了是否是Primary和是否是HighestPriority的判断，

来处理采用哪个数据源。所以解决的方式也因此出来了。就是将某个实例标记为Primary或者HighestPriority。

解决问题的方法

在某个@Bean上添加@Primary注解，就可以做到唯一区分。

这里其实应该还可以通过优先级来区分，但使用@Order发现并不是这个优先级，也没找到相关的资料，所以之后再研究一下。

@Qualifier的作用和应用

@Qualifier的作用

这是官方的介绍

This annotation may be used on a field or parameter as a qualifier for candidate beans when autowiring. It may also be used to annotate other custom annotations that can then in turn be used as qualifiers.

简单的理解就是：

在使用@Autowire自动注入的时候，加上@Qualifier(“test”)可以指定注入哪个对象；
可以作为筛选的限定符，我们在做自定义注解时可以在其定义上增加@Qualifier，用来筛选需要的对象。这个理解看下面的代码吧，不好解释。

功能介绍

首先是对（1）的理解。


//我们定义了两个TestClass对象，分别是testClass1和testClass2
//我们如果在另外一个对象中直接使用@Autowire去注入的话，spring肯定不知道使用哪个对象
//会排除异常 required a single bean, but 2 were found
@Configuration
public class TestConfiguration {
   @Bean("testClass1")
   TestClass testClass1(){
       return new TestClass("TestClass1");
   }
   @Bean("testClass2")
   TestClass testClass2(){
       return new TestClass("TestClass2");
   }
}

下面是正常的引用


@RestController
public class TestController {
 
    //此时这两个注解的连用就类似 @Resource(name="testClass1")
    @Autowired
    @Qualifier("testClass1")
    private TestClass testClass;
 
    @GetMapping("/test")
    public Object test(){
        return testClassList;
    }

}

@Autowired和@Qualifier这两个注解的连用在这个位置就类似 @Resource(name=“testClass1”)

对(2)的理解


@Configuration
public class TestConfiguration {
    //我们调整下在testClass1上增加@Qualifier注解
    @Qualifier
    @Bean("testClass1")
    TestClass testClass1(){
        return new TestClass("TestClass1");
    }
 
    @Bean("testClass2")
    TestClass testClass2(){
        return new TestClass("TestClass2");
    }
}
@RestController
public class TestController {
    //我们这里使用一个list去接收testClass的对象
    @Autowired
    List<TestClass> testClassList= Collections.emptyList();
    
    @GetMapping("/test")
    public Object test(){
        return testClassList;
    }
}

我们调用得到的结果是

[
{
"name": "TestClass1"
},
{
"name": "TestClass2"
}
]

我们可以看到所有的testclass都获取到了。接下来我们修改下代码


@RestController
public class TestController {
 
    @Qualifier //我们在这增加注解
    @Autowired
    List<TestClass> testClassList= Collections.emptyList();
 
    @GetMapping("/test")
    public Object test(){
        return testClassList;
    }
}

和上面代码对比就是在接收参数上增加了@Qualifier注解，这样看是有什么区别，我们调用下，结果如下：