[스프링 핵심 원리 - 기본편] #7. 의존관계 자동 주입 (2)

[YuDeokRin]

5️⃣ 조회 빈이 2개 이상 - 문제

@Autowired는 타입(Type)으로 조회한다.

@Autowired
private Discountpolicy discountPolicy

타입으로 조회하기 때문에, 아래의 코드와 유사하게 동작한다.

ac.getBean(DiscountPolicy.class)

타입으로 조회시 선택된 빈이 2개 이상일 때 문제가 발생한다.

DiscountPolicy 의 하위 타입인 FixDiscountPolicy, RateDiscountPolicy 둘다 스프링 빈으로 선언해보자.

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

그리고 이렇게 의존관계 자동 주입을 실행하면

@Autowired
private DsicountPolicy discountPolicy

🔴 오류가 발생한다.

• 오류의 내용을 보면 fixDiscountPolicy, rateDiscountPolicy 2개가 발견되었다고 표시되어있다.

NoUniqueBeanDefinitionException

NoUniqueBeanDefinitionException: No qualifying bean of type
'hello.core.discount.DiscountPolicy' available: expected single matching bean
but found 2: fixDiscountPolicy,rateDiscountPolicy

✅해결법

하위 타입으로 지정할 수 도 있지만, 하위 타입으로 지정하는 것은 DIP 위배와 더불어 유연성이 떨어진다.

그리고 이름만 다르고, 완전히 똑같은 타입의 스프링이 빈이 2개 있을 때 해결이 안됨

1. 스프링 빈을 수동으로 등록해서 문제를 해결
2. 의존 관계 자동 주입을 하여 해결하는 방법

더 구체적으로는 다음 파트 6에서 알아보자.

---

6️⃣ @Autowired 필드 명, @qualifier, @primary

➡️@Autowired 필드 명 매칭

@Autowired 는 타입 매칭을 시도하고 이때 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.

• 기존 코드

@Autowired
private DiscountPolicy discountPolicy 

• 필드 명을 빈 이름으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy 

필드 명이 rateDiscountPolicy 이므로 정상 주입됨.

필드 명 매칭은 먼저 타입 매칭을 시도 하고 그 결과에 여러 빈이 있을 때 추가로 동작하는 기능이다.

• @Autowired 매칭 정리
  1. 타입 매칭
  2. 타입 매칭의 결과가 2개 이상일 때 필드명, 파라미터 명으로 빈 이름 매칭

➡️@qualifier 사용

@Qualifier는 추가 구분자를 붙여주는 방법이다. 주입시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다.

• 빈 등록시 @qualifier를 붙여 준다.

@Component
 @Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
 @Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}

• 주입시에 @qualifier를 붙여주고 등록한 이름을 적어준다.

  • 생성자 자동 주입 예시

  @Autowired
  public OrderServiceImpl(MemberRepository memberRepository, @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
       this.memberRepository = memberRepository;
       this.discountPolicy = discountPolicy;
  }

  • 수정자 자동 주입 예시

  @Autowired
  public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy")
  DiscountPolicy discountPolicy) {
       this.discountPolicy = discountPolicy;
  }

@Qualifier로 주입할 때, @qualifier(”mainDiscountPolicy”)를 못찾으면 어떻게될까?

→ mainDiscountPolicy 라는 이름의 스프링 빈을 추가로 찾는다.

→ 그러나 @Qualifier 는 @Qualifier를 찾는 용도로만 사용하는게 명확하고 좋다고 한다.

• 다음과 같이 직접 빈 등록시에도 @qualifier를 동일하게 사용할 수 있음.

@Bean
@Qualifier("mainDiscountPolicy")
public DiscountPolicy discountPolicy() {
   return new ...
}

1. @qualifier 끼리 매칭
2. 빈 이름 매칭
3. NoSuchBeanDefinitionExecption 예외 발생

➡️ @primary 사용

@primary는 우선순위를 정하는 방법이다. @Autowired 시에 여러 빈이 매칭되면 @Primary가 우선권을 가진다.

• rateDiscountPolicy 가 우선권을 가지는 케이스

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

• 사용 코드

//생성자
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
     this.memberRepository = memberRepository;
     this.discountPolicy = discountPolicy;
 }
 
//수정자
@Autowired
public DiscountPolicy setDiscountPolicy(DiscountPolicy discountPolicy) {
     this.discountPolicy = discountPolicy;
 }

• 결과
  • 코드를 실행할 경우 문제 없이 @Primary가 잘 동작한다.

✅@Qualifier의 단점

@Qualifier단점은 주입 받을 때 모든 코드에 @Qualifier를 붙여줘야한다. 예시를 보고 확인해보자.

@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
     this.memberRepository = memberRepository;
     this.discountPolicy = discountPolicy;
}

반면에 @Primary를 사용하면 이렇게 @Qualifier를 붙일 필요가 없어짐

✅ @primary, @qualifier 활용

코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고, 코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자.

메인 데이터베이스의 커넥셔을 획득하는 스프링 빈은 @Primary를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고, 서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifier를 지정해서 명시적으로 획득하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다.

✅우선순위

@Primary는 기본값 처럼 동작하는 것이고, @Qualifier는 매우 상세하게 동작한다. 이런 경우 어떤 것이 우선권을 가져갈까 ?

→ 스프링은 자동 < 수동, 넓은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다.

→ @Qualifier가 우선권이 높다

---

7️⃣ 애노테이션 직접 만들기

@Qualifier(”mainDiscountPolicy”) 이렇게 문자를 적으면 컴파일시 타입 체크가 안된다. 이 문제를 애노테이션을 만들어서 문제를 해결할 수 있다.

package hello.core.annotataion;
import org.springframework.beans.factory.annotation.Qualifier;
import java.lang.annotation.*;

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER,
ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {

}

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

//생성자 자동 주입
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @MainDiscountPolicy DiscountPolicy discountPolicy) {
     this.memberRepository = memberRepository;
     this.discountPolicy = discountPolicy;
}
 
//수정자 자동 주입
@Autowired
public DiscountPolicy setDiscountPolicy(@MainDiscountPolicy DiscountPolicy discountPolicy) {
     this.discountPolicy = discountPolicy;
}

• 애노테이션에는 상속이라는 개념이 없다.
• 위와 같이 여러 애노테이션을 모아서 사용하는 기능은 스프링에서 지원해주는 기능
• @Autowired도 재정의 가능 → 하지만 재정의하는건 나중에 유지보수에 혼란을 가중할뿐이다..

---

8️⃣ 조회한 빈이 모두 필요할 때, List, Map

• 의도적으로 해당 타입의 스프링 빈이 다 필요한 경우가 있다.
• 예) 할인 서비스를 제공하고, 클라이언트가 할인의 종류(reate, fix)를 선택할 수 있다고 가정해보자. → 스프링을 사용하면 전략 패턴을 매우 간단하게 구현할 수 있다.

public class AllBeanTest {
    @Test
    void findAllBean() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);
        DiscountService discountService = ac.getBean(DiscountService.class);
        Member member = new Member(1L, "userA", Grade.VIP);
        int discountPrice = discountService.discount(member, 10000, "fixDiscountPolicy");
        assertThat(discountService).isInstanceOf(DiscountService.class);
        assertThat(discountPrice).isEqualTo(1000);
    }
    
    
    static class DiscountService {
        private final Map<String, DiscountPolicy> policyMap;
        private final List<DiscountPolicy> policies;
        
        public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policies) {
            this.policyMap = policyMap;
            this.policies = policies;
            System.out.println("policyMap = " + policyMap);
            System.out.println("policies = " + policies);
        }
        
        public int discount(Member member, int price, String discountCode) {
            DiscountPolicy discountPolicy = policyMap.get(discountCode);
            System.out.println("discountCode = " + discountCode);
            System.out.println("discountPolicy = " + discountPolicy);
            return discountPolicy.discount(member, price);
				} 
    }
} 

위 코드 로직 분석

✅로직 분석

• DiscountService는 Map으로 모든 DiscountPolicy를 주입 받는다. 이때 fixDiscountPolicy, rateDiscountPolicy 가 주입된다.
• discount() 메서드는 discountCode로 “fixDiscountPolicy”가 넘어오면 map에서 fixDiscountPolicy 스프링 빈을 찾아서 실행한다. 물론 “rateDiscountPolicy”가 넘어오면 rateDiscountPolicy 스프링 빈을 찾아서 실행한다.

✅ 주입 분석

• Map<String, DiscountPolicy> : map의 키에 스프링 빈의 이름을 넣어주고, 그 값으로
  DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
• List<DiscountPolicy> : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
• 만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map을 주입한다.

💈참고 스프링 컨테이너를 생성하면서 스프링 빈 등록하기

스프링 컨테이너는 생성자에 클래스 정보를 받는다. 여기에 클래스 정보를 넘기면 해당 클래스가 스프링 빈으로 자동 등록된다.

new AnnotationConfigApplicationContext(AutoAppConfig.class,DiscountService.class);

• 이 코드는 2가지로 나누어 이해할 수 있다.

  • new AnnotationConfigApplicationContext() 를 통해 스프링 컨테이너를 생성한다.
  • AutoAppConfig.class , DiscountService.class 를 파라미터로 넘기면서 해당 클래스를 자동으로 스프링 빈으로 등록한다.

• 정리

  • 스프링 컨테이너를 생성하면서, 해당 컨테이너에 동시에 AutoAppConfig, DiscountService를 스프링 빈으로 자동 등록한다.

---

9️⃣ 자동, 수동의 올바른 실무 운영 기준

• 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했다.
• 개발자 입장에서 스프링 빈을 하나 등록할 때, @Component 만 넣어주면 끝나는 일을 @Configuration 설정 정보에 가서 @bean을 적고, 객체를 생성하고, 주입할 대상을 일일이 적어주는 과정이 상당히 번거로움
• 관리할 빈이 많아서 설정 정보가 커지면 관리하는 것 자체가 어렵고 부담이 된다.
• 자동 빈 등록을 사용해도 OCP,DIP를 지킬 수 있다.

✅수동 빈 등록은 언제 사용하면 좋을까 ?

애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있다.

• 업무 로직 빈 : 웹을 지원하는 컨트롤러, 핵심 비지니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리 등이 모두 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
• 기술 지원 빈 : 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결, 공통 로그 처리 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.

✅비즈니스 로직 중에서 다형성을 적극 활용할 때

의존관계 자동 주입 - 조회한 빈이 모두 필요할 때, List, Map을 다시보자.

[seyxxn]

제일 먼저 올리셨네요 !!! 실무에서는 @Autowired 필드 명, @qualifier, @primary 중에 주로 어떤 방법을 .. 이용하나요?

[YuDeokRin]

@qualifier는 잘 써야할듯합니다. 저희도 쓰다가 거의 다 지운거같아요
@primary는 극소수에 몇개로 쓰네욤

@Autowired가 대부분이네욤