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

程序员文章站 2022-06-23 12:49:55

目录@qualifier自动注入无效的解决问题问题的根本原因其中问题出在解决问题的方法@qualifier的作用和应用@qualifier的作用@qualifier自动注入无效的解决问题使用sprin...

@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注解，这样看是有什么区别，我们调用下，结果如下：