1. Обзор
В этом кратком руководстве мы обсудим аннотацию Spring @Primary , которая была представлена в версии 3.0 фреймворка.
Проще говоря, мы используем @Primary , чтобы отдавать предпочтение компоненту, когда имеется несколько компонентов одного типа.
Опишем проблему подробно.
2. Зачем нужен @Primary ?
В некоторых случаях нам нужно зарегистрировать более одного bean-компонента одного типа .
В этом примере у нас есть bean- компоненты JohnEmployee() и TonyEmployee() типа Employee :
@Configuration
public class Config {
@Bean
public Employee JohnEmployee() {
return new Employee("John");
}
@Bean
public Employee TonyEmployee() {
return new Employee("Tony");
}
}
Spring выбрасывает исключение NoUniqueBeanDefinitionException , если мы пытаемся запустить приложение .
Для доступа к bean-компонентам одного типа мы обычно используем аннотацию @Qualifier("beanName") .
Применяем его в точке инъекции вместе с @Autowired . В нашем случае мы выбираем bean-компоненты на этапе настройки, поэтому здесь нельзя применить @Qualifier . Подробнее об аннотации @Qualifier мы можем узнать , перейдя по ссылке .
Для решения этой проблемы Spring предлагает аннотацию @Primary .
3. Используйте @Primary с @Bean
Давайте посмотрим на класс конфигурации:
@Configuration
public class Config {
@Bean
public Employee JohnEmployee() {
return new Employee("John");
}
@Bean
@Primary
public Employee TonyEmployee() {
return new Employee("Tony");
}
}
Мы помечаем bean-компонент TonyEmployee() с помощью @Primary . Spring будет внедрять bean-компонент TonyEmployee() предпочтительно, а не JohnEmployee() .
Теперь давайте запустим контекст приложения и получим из него bean-компонент Employee :
AnnotationConfigApplicationContext context
= new AnnotationConfigApplicationContext(Config.class);
Employee employee = context.getBean(Employee.class);
System.out.println(employee);
После запуска приложения:
Employee{name='Tony'}
Из вывода мы видим, что экземпляр TonyEmployee() имеет предпочтение при автоподключении .
4. Используйте @Primary с @Component
Мы можем использовать @Primary непосредственно для bean-компонентов . Давайте рассмотрим следующий сценарий:
public interface Manager {
String getManagerName();
}
У нас есть интерфейс менеджера и два bean-компонента подкласса, DepartmentManager :
@Component
public class DepartmentManager implements Manager {
@Override
public String getManagerName() {
return "Department manager";
}
}
И бин GeneralManager :
@Component
@Primary
public class GeneralManager implements Manager {
@Override
public String getManagerName() {
return "General manager";
}
}
Оба они переопределяют getManagerName() интерфейса Manager . Также обратите внимание, что мы помечаем bean-компонент GeneralManager с помощью @Primary .
На этот раз @Primary имеет смысл только тогда, когда мы включаем сканирование компонентов :
@Configuration
@ComponentScan(basePackages="org.foreach.primary")
public class Config {
}
Давайте создадим сервис для использования внедрения зависимостей при поиске нужного bean-компонента:
@Service
public class ManagerService {
@Autowired
private Manager manager;
public Manager getManager() {
return manager;
}
}
Здесь оба bean -компонента, DepartmentManager и GeneralManager , имеют право на автоматическое связывание.
Поскольку мы пометили компонент GeneralManager с помощью @Primary , он будет выбран для внедрения зависимостей :
ManagerService service = context.getBean(ManagerService.class);
Manager manager = service.getManager();
System.out.println(manager.getManagerName());
Результатом является « Генеральный менеджер».
5. Вывод
В этой статье мы узнали об аннотации Spring @Primary . С помощью примеров кода мы продемонстрировали необходимость и варианты использования @Primary.
Как обычно, полный код для этой статьи доступен в проекте GitHub .