注解详解系列 - @Primary：优先选择的Bean

注解简介

在今天的注解详解系列中，我们将探讨@Primary注解。@Primary是Spring框架中的一个重要注解，用于在有多个候选Bean时指定首选的Bean。通过@Primary注解，可以明确地告诉Spring容器在注入依赖时选择哪个Bean。

注解定义

@Primary注解用于指定当有多个候选Bean时，首选的Bean。它通常应用于类级别或方法级别，通常与@Component、@Service、@Repository、@Bean等注解一起使用。以下是一个基本的示例：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;

@Configuration
public class AppConfig {

    @Bean
    @Primary
    public MyService primaryService() {
        return new MyService("Primary Service");
    }

    @Bean
    public MyService secondaryService() {
        return new MyService("Secondary Service");
    }
}

class MyService {
    private String name;

    public MyService(String name) {
        this.name = name;
    }

    public void printServiceName() {
        System.out.println("Service Name: " + name);
    }
}

在这个示例中，primaryService Bean被标记为首选的Bean，因为它被注解了@Primary。

注解详解

@Primary注解是Spring框架中用于指定首选Bean的注解。它的主要功能是当有多个候选Bean时，明确指定Spring容器应该选择哪个Bean进行注入。

@Primary注解的作用包括：

指定首选Bean：在有多个候选Bean时，指定首选的Bean。
减少冲突：在依赖注入时减少Bean冲突和歧义。
简化配置：使得在多Bean场景下的配置更加简单和明确。

@Primary注解通常与@Component、@Service、@Repository、@Bean等注解一起使用，以标记需要优先选择的Bean。

使用场景

@Primary注解广泛用于Spring应用程序中，用于在有多个同类型的候选Bean时指定首选的Bean。例如，在多个数据源、多个服务实现或多个策略模式实现时，可以使用@Primary注解来指定首选的Bean。

示例代码

以下是一个使用@Primary注解的代码示例，展示了如何通过Spring指定首选的Bean：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;

@Configuration
public class AppConfig {

    @Bean
    @Primary
    public MyService primaryService() {
        return new MyService("Primary Service");
    }

    @Bean
    public MyService secondaryService() {
        return new MyService("Secondary Service");
    }
}

@Component
public class MyApp {

    private final MyService myService;

    @Autowired
    public MyApp(MyService myService) {
        this.myService = myService;
    }

    public void run() {
        myService.printServiceName();
    }
}

在这个示例中：

primaryService被标记为首选的Bean，因为它被注解了@Primary。
MyApp类中自动注入的myService实例将会是primaryService。

使用Spring Boot的首选Bean

在Spring Boot项目中，可以通过@Primary注解和Spring配置文件来指定首选的Bean。例如，通过以下方式在配置文件中定义首选的Bean：

application.properties文件内容：

spring.bean.primary=primaryService

通过这种方式，可以在Spring Boot项目中方便地定义和管理首选的Bean。

常见问题

问题：如何在有多个候选Bean时，手动指定注入的Bean？

解决方案：可以使用@Qualifier注解手动指定注入的Bean。以下是一个示例：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;

@Configuration
public class AppConfig {

    @Bean
    @Primary
    public MyService primaryService() {
        return new MyService("Primary Service");
    }

    @Bean
    public MyService secondaryService() {
        return new MyService("Secondary Service");
    }
}

@Component
public class MyApp {

    private final MyService myService;

    @Autowired
    public MyApp(@Qualifier("secondaryService") MyService myService) {
        this.myService = myService;
    }

    public void run() {
        myService.printServiceName();
    }
}

在这个示例中：

MyApp类中通过@Qualifier注解手动指定注入secondaryService Bean。

问题：如何在测试中验证首选的Bean？

解决方案：可以通过Spring的依赖注入和测试框架来验证首选的Bean。例如，通过JUnit测试框架，可以验证@Primary注解指定的首选Bean。

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class PrimaryBeanTest {

    @Autowired
    private MyService myService;

    @Test
    public void testPrimaryBean() {
        assertEquals("Primary Service", myService.printServiceName());
    }
}