Spring(SpringBoot)--同类型多个bean的注入--@Primary/@Qualifier

忘是亡心i 2023-09-29 12:43 11阅读 0赞

原文网址：[Spring(SpringBoot)--同类型多个bean的注入--@Primary/@Qualifier\_IT利刃出鞘的博客-CSDN博客][Spring_SpringBoot_--_bean_--_Primary_Qualifier_IT_-CSDN]

## 简介 ##

本文用示例介绍Spring中某个接口有多个实现类时该如何注入。

## 问题复现 ##

需求：一个支付接口，有两个实现：支付宝支付、微信支付。想调用支付宝支付方法。

**接口**

package com.knife.tmp;
    
    public interface Pay {
        void doPay();
    }

**实现**

支付宝

package com.knife.tmp.impl;
    
    import com.knife.tmp.Pay;
    import org.springframework.stereotype.Component;
    
    /**
     * 支付宝支付
     */
    @Component
    public class AlipayImpl implements Pay {
        @Override
        public void doPay() {
            System.out.println("支付宝支付");
        }
    }

微信支付

package com.knife.tmp.impl;
    
    import com.knife.tmp.Pay;
    import org.springframework.stereotype.Component;
    
    /**
     * 微信支付
     */
    @Component
    public class WeChatImpl implements Pay {
        @Override
        public void doPay() {
            System.out.println("微信支付");
        }
    }

**Controller**

package com.knife.controller;
    
    import com.knife.tmp.Pay;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class PayController {
        @Autowired
        private Pay pay;
    
        @GetMapping("/pay")
        public String pay() {
            pay.doPay();
            return "test success";
        }
    }

**测试**

首先，还没运行，就可以看到Idea红色波浪线提示：

![dc36cd936efd4614bd75e8602d56a249.png][]

运行结果：

> Description:
> 
> Field pay in com.knife.controller.PayController required a single bean, but 2 were found:  
> \- alipayImpl: defined in file \[E:\\work\\Idea\_proj\\demo\_Simple\\demo\_SpringBoot\\target\\classes\\com\\knife\\tmp\\impl\\AlipayImpl.class\]  
> \- weChatImpl: defined in file \[E:\\work\\Idea\_proj\\demo\_Simple\\demo\_SpringBoot\\target\\classes\\com\\knife\\tmp\\impl\\WeChatImpl.class\]
> 
>   
> Action:
> 
> Consider marking one of the beans as @Primary, updating the consumer to accept multiple beans, or using @Qualifier to identify the bean that should be consumed

如下图：

![301e6a8c2e4c484fa10d4f4cd44b7eb7.png][]

## 原因分析 ##

@Autowired是通过类型来注入的。以上边的示例来说，@Autowired注入一个Pay接口，此时Spring会查找所有实现了Pay接口的bean，此时发现了两个：AlipayImpl，WeChatImpl，然后就会报错。

## 解决方案1：@Primary ##

**说明**

将@Primary放到接口的某个实现类上边。这样如果此接口有多个实现类，则会注入有@Primary的实现类。

**实例**

相对于“问题复现”，只修改支付宝实现类，在上边添加@Primary，如下：

package com.knife.tmp.impl;
    
    import com.knife.tmp.Pay;
    import org.springframework.context.annotation.Primary;
    import org.springframework.stereotype.Component;
    
    /**
     * 支付宝支付
     */
    @Primary
    @Component
    public class AlipayImpl implements Pay {
        @Override
        public void doPay() {
            System.out.println("支付宝支付");
        }
    }

这样Controller就不会再有红色波浪线：

![2df5660bf74c43e7bcdc255bf9224419.png][]

**运行结果**

启动成功。

访问：[http://localhost:8080/pay][http_localhost_8080_pay]

![e2875464da714593bedc5f948316836d.png][]

后端结果

![b1bc4ebc4fb342958bd57d8cb5f85b67.png][]

## 解决方案2：value属性 +@Qualifier ##

**说明**

在接口的某个实现类上边的@Component里指定value，例如：@Component("xxx")，使用@Autowired注入的地方用@Qualifier("xxx")来指定（xxx表示@Component里的value）。这样如果此接口有多个实现类，则会注入@Qualifier("xxx")指定的实现类。

**实例**

接口

package com.knife.tmp;
    
    public interface Pay {
        void doPay();
    }

支付宝实现类

package com.knife.tmp.impl;
    
    import com.knife.tmp.Pay;
    import org.springframework.stereotype.Component;
    
    /**
     * 支付宝支付
     */
    @Component("alipay")
    public class AlipayImpl implements Pay {
        @Override
        public void doPay() {
            System.out.println("支付宝支付");
        }
    }

微信支付实现类

package com.knife.tmp.impl;
    
    import com.knife.tmp.Pay;
    import org.springframework.stereotype.Component;
    
    /**
     * 微信支付
     */
    @Component("wechat")
    public class WeChatImpl implements Pay {
        @Override
        public void doPay() {
            System.out.println("微信支付");
        }
    }

Controller

package com.knife.controller;
    
    import com.knife.tmp.Pay;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Qualifier;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class PayController {
        @Qualifier("alipay")
        @Autowired
        private Pay pay;
    
        @GetMapping("/pay")
        public String pay() {
            pay.doPay();
            return "test success";
        }
    }

测试

启动成功。

访问：[http://localhost:8080/pay][http_localhost_8080_pay]

![3ee0812f71794cba816c3845ab0a18c5.png][]

后端结果

![71c1631fb15f48859b07841c7921158b.png][]

## 解决方案3：指定属性名（不推荐） ##

**说明**

@Autowired提供这样的规则，首先它会根据类型找到对应的Bean，如果对应类型的Bean不是唯一的，那么它会根据其属性名称和Bean的名称进行匹配。如果匹配得上，就会使用该Bean；如果还无法匹配，就会抛出异常。

所以，在注入的地方，将属性名设置成与bean名字一样即可。

**实例**

接口

package com.knife.tmp;
    
    public interface Pay {
        void doPay();
    }

支付宝实现

微信支付

**Controller**

package com.knife.controller;
    
    import com.knife.tmp.Pay;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class PayController {
        @Autowired
        private Pay alipayImpl;
    
        @GetMapping("/pay")
        public String pay() {
            alipayImpl.doPay();
            return "test success";
        }
    }

**测试**

启动成功。

访问：[http://localhost:8080/pay][http_localhost_8080_pay]

结果：

![0fa21464912e43ddb6372a967a825ac2.png][]

后端结果

![d08c5eca9a134f078573779d5fa5a717.png][]

[Spring_SpringBoot_--_bean_--_Primary_Qualifier_IT_-CSDN]: https://knife.blog.csdn.net/article/details/124510668
[dc36cd936efd4614bd75e8602d56a249.png]: https://img-blog.csdnimg.cn/dc36cd936efd4614bd75e8602d56a249.png
[301e6a8c2e4c484fa10d4f4cd44b7eb7.png]: https://img-blog.csdnimg.cn/301e6a8c2e4c484fa10d4f4cd44b7eb7.png
[2df5660bf74c43e7bcdc255bf9224419.png]: https://img-blog.csdnimg.cn/2df5660bf74c43e7bcdc255bf9224419.png
[http_localhost_8080_pay]: http://localhost:8080/pay
[e2875464da714593bedc5f948316836d.png]: https://img-blog.csdnimg.cn/e2875464da714593bedc5f948316836d.png
[b1bc4ebc4fb342958bd57d8cb5f85b67.png]: https://img-blog.csdnimg.cn/b1bc4ebc4fb342958bd57d8cb5f85b67.png
[3ee0812f71794cba816c3845ab0a18c5.png]: https://img-blog.csdnimg.cn/3ee0812f71794cba816c3845ab0a18c5.png
[71c1631fb15f48859b07841c7921158b.png]: https://img-blog.csdnimg.cn/71c1631fb15f48859b07841c7921158b.png
[0fa21464912e43ddb6372a967a825ac2.png]: https://img-blog.csdnimg.cn/0fa21464912e43ddb6372a967a825ac2.png
[d08c5eca9a134f078573779d5fa5a717.png]: https://img-blog.csdnimg.cn/d08c5eca9a134f078573779d5fa5a717.png