Рубрики
Без рубрики

Spring @Primary Аннотация

Узнайте, как использовать аннотацию Spring @Primary, чтобы отдавать предпочтение бобам при автоматической проводке

Автор оригинала: baeldung.

1. Обзор

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

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

Давайте подробно опишем проблему.

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

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

В этом примере мы имеем John Employee() и Tony Employee() бобы типа Employee :

@Configuration
public class Config {

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

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

Spring бросает NoUniqueBeanDefinitionException если мы попытаемся запустить приложение .

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

Мы применяем его в точке впрыска вместе с @Autowired . В нашем случае мы выбираем бобы на этапе настройки, поэтому @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");
    }
}

Мы отмечаем Тони Сотрудник() боб с @Первичный . Весна впрыснет Тони Сотрудник() боб предпочтительно над Джон Сотрудник() .

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

AnnotationConfigApplicationContext context
  = new AnnotationConfigApplicationContext(Config.class);

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

После того как мы запустим приложение:

Employee{name='Tony'}

Из выходных данных мы видим, что экземпляр Tony Employee() имеет предпочтение при автоматической проводке .

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

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

public interface Manager {
    String getManagerName();
}

У нас есть Менеджер интерфейс и два подкласса бобов, Менеджер отдела :

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

И Генеральный менеджер боб:

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

Они оба переопределяют getManagerName() интерфейса Manager . Кроме того, обратите внимание, что мы отмечаем General Manager bean с @Primary .

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

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

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

@Service
public class ManagerService {

    @Autowired
    private Manager manager;

    public Manager getManager() {
        return manager;
    }
}

Здесь оба компонента Department Manager и General Manager имеют право на автоматическое подключение.

Как мы отметили General Manager bean с @Primary , он будет выбран для внедрения зависимостей :

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

На выходе получается ” Генеральный менеджер”.

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

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

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