«Весенняя @Primary аннотация»

1. Обзор

В этом кратком руководстве мы обсудим аннотацию Spring @Primary, которая появилась в версии 3.0 фреймворка.

Проще говоря, мы используем @Primary, чтобы отдавать предпочтение компоненту, когда имеется несколько компонентов одного типа.

Опишем проблему подробно.

2. Зачем нужен @Primary?

В некоторых случаях нам нужно зарегистрировать более одного bean-компонента одного типа.

В этом примере у нас есть bean-компоненты JohnEmployee() и TonyEmployee() типа Employee:

Spring генерирует исключение NoUniqueBeanDefinitionException, если мы пытаемся запустить приложение.

@Configuration
public class Config {

    @Bean
    public Employee JohnEmployee() {
        return new Employee("John");
    }

    @Bean
    public Employee TonyEmployee() {
        return new Employee("Tony");
    }
}

Для доступа к bean-компонентам одного типа мы обычно используем аннотацию @Qualifier(“beanName”).

Применяем его в точке инжекции вместе с @Autowired. В нашем случае мы выбираем bean-компоненты на этапе настройки, поэтому здесь нельзя применить @Qualifier. Мы можем узнать больше об аннотации @Qualifier, перейдя по ссылке.

Для решения этой проблемы Spring предлагает аннотацию @Primary.

3. Используйте @Primary с @Bean

Давайте посмотрим на класс конфигурации:

Мы помечаем bean-компонент TonyEmployee() @Primary. Spring будет внедрять bean-компонент TonyEmployee() предпочтительно, а не JohnEmployee().

@Configuration
public class Config {

    @Bean
    public Employee JohnEmployee() {
        return new Employee("John");
    }

    @Bean
    @Primary
    public Employee TonyEmployee() {
        return new Employee("Tony");
    }
}

Теперь давайте запустим контекст приложения и получим из него bean-компонент Employee:

После запуска приложения:

AnnotationConfigApplicationContext context
  = new AnnotationConfigApplicationContext(Config.class);

Employee employee = context.getBean(Employee.class);
System.out.println(employee);

Из вывода мы видим, что экземпляр TonyEmployee() имеет предпочтение при автопроводке.

Employee{name='Tony'}

4. Используйте @Primary с @Component

Мы можем использовать @Primary непосредственно на bean-компонентах. Давайте рассмотрим следующий сценарий:

У нас есть интерфейс Manager и два bean-компонента подкласса, DepartmentManager:

public interface Manager {
    String getManagerName();
}

И bean-компонент GeneralManager:

@Component
public class DepartmentManager implements Manager {
    @Override
    public String getManagerName() {
        return "Department manager";
    }
}

Они оба переопределяют getManagerName( ) интерфейса менеджера. Также обратите внимание, что мы помечаем bean-компонент GeneralManager с помощью @Primary.

@Component
@Primary
public class GeneralManager implements Manager {
    @Override
    public String getManagerName() {
        return "General manager";
    }
}

На этот раз @Primary имеет смысл только тогда, когда мы разрешаем сканирование компонентов:

Давайте создадим сервис для использования внедрения зависимостей при поиске нужного bean-компонента:

@Configuration
@ComponentScan(basePackages="org.baeldung.primary")
public class Config {
}

Здесь оба bean-компонента DepartmentManager и GeneralManager имеют право на автоматическое подключение.

@Service
public class ManagerService {

    @Autowired
    private Manager manager;

    public Manager getManager() {
        return manager;
    }
}

Поскольку мы пометили bean-компонент GeneralManager с помощью @Primary, он будет выбран для внедрения зависимостей:

Вывод: «Общий менеджер».

ManagerService service = context.getBean(ManagerService.class);
Manager manager = service.getManager();
System.out.println(manager.getManagerName());

5. Заключение

В этой статье мы узнали об аннотации Spring @Primary. С помощью примеров кода мы продемонстрировали необходимость и варианты использования @Primary.

Как обычно, полный код для этой статьи доступен в проекте GitHub.

«