Spring中@Primary注解的作用与使用
在 Spring 框架中,@Primary
注解用于解决依赖注入时的歧义性(Ambiguity)问题。当 Spring 容器中存在多个相同类型的 Bean 时,通过 @Primary
标记其中一个 Bean 作为默认的首选注入对象。
核心作用:
-
解决多个同类型 Bean 的冲突
当有多个实现同一接口或相同类型的 Bean 时,Spring 无法自动确定注入哪个 Bean,会抛出NoUniqueBeanDefinitionException
。使用@Primary
可指定默认注入的 Bean。 -
隐式选择优先级
被标记为@Primary
的 Bean 会被优先注入,无需额外使用@Qualifier
指定名称。
使用示例:
场景定义
假设有一个支付接口 PaymentService
和两个实现类:
public interface PaymentService {void pay();
}@Component
public class CreditCardService implements PaymentService {@Overridepublic void pay() { System.out.println("信用卡支付"); }
}@Component
public class AlipayService implements PaymentService {@Overridepublic void pay() { System.out.println("支付宝支付"); }
}
问题:依赖注入歧义
若直接注入 PaymentService
,Spring 会报错:
@Autowired
private PaymentService paymentService; // 抛出 NoUniqueBeanDefinitionException
解决方案:使用 @Primary
标记其中一个实现类为默认首选:
@Component
@Primary // 指定为默认注入的 Bean
public class AlipayService implements PaymentService { ... }
此时注入会成功选择 AlipayService
:
@Autowired
private PaymentService paymentService; // 隐式注入 AlipayService
与其他注解的优先级:
-
@Primary
vs@Qualifier
@Qualifier
显式指定 Bean 名称的优先级高于@Primary
。- 例如:
@Autowired @Qualifier("creditCardService")
会覆盖@Primary
。
-
多个
@Primary
的冲突
如果多个同类型 Bean 都被标记为@Primary
,Spring 会再次抛出歧义异常。
常见使用场景:
- 数据库多数据源配置
在多个DataSource
Bean 中,标记默认使用的数据源。 - 不同环境下的实现类
例如在测试和生产环境中提供同一接口的不同实现,通过@Primary
切换默认实现。 - 第三方库的扩展
当覆盖第三方库提供的 Bean 时,将自己的实现标记为@Primary
。
配置方式:
除了注解在类上,也可以在 @Bean
方法中使用:
@Configuration
public class AppConfig {@Bean@Primary // 标记此 Bean 为首选public PaymentService alipayService() {return new AlipayService();}
}
总结:
场景 | 解决方案 |
---|---|
多个同类型 Bean,需默认注入一个 | 在目标 Bean 添加 @Primary |
需要临时覆盖默认注入 | 配合 @Qualifier 指定名称 |
关键点:@Primary
是 Spring 解决依赖注入歧义性的轻量级方案,通过隐式指定默认 Bean 简化配置,但在需要精确控制的场景中仍需结合 @Qualifier
使用。