[Spring] 기본_의존관계 자동 주입

1. 다양한 의존관계 주입 방법

1-1. 생성자 주입

• 생성자 호출시점에 딱 1번만 호출되는 것이 보장
• 불변, 필수 의존관계에 사용
• 생성자주입말고는 FINAL불가능
• 생성자를 통해서만 의존관계 주입이 되고, 외부에서 어느 누구도 수정할 수 없음
• 객체가 생성되면서 주입

private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;

@Autowired  // 생성자가 딱 1개라면 생략 가능
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

1-2. 수정자 주입(setter 주입)

• 선택, 변경 가능성이 있는 의존관계에 사용
• 주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false) 로 지정
• 객체가 생성된 다음에 호출

private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;

@Autowired(required = false)
public void setMemberRepository(MemberRepository memberRepository) {
    this.memberRepository = memberRepository;
}

@Autowired
public void setMemberRepository(DiscountPolicy discountPolicy) {
    this.discountPolicy = discountPolicy;
}

1-3. 필드 주입

• 이름 그대로 필드에 바로 주입
• 코드가 간결해서 많은 개발자들을 유혹하지만 외부에서 변경이 불가능해서 테스트 하기 힘듦(치명적 단점)
• DI 프레임워크가 없으면 아무것도 할 수 없음
• 사용금지!
• 언제사용?
  • 애플리케이션의 실제 코드와 관계 없는 테스트 코드에서 사용
  • 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

@Autowired private MemberRepository memberRepository;
@Autowired private DiscountPolicy discountPolicy;

• 순수한 자바 테스트코드에서는 @Autowired 작동하지 않음 -> @SpringBootTest 처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능
• @Bean에서 파라미터에 의존관계는 자동주입됨

1-4. 일반 메서드 주입

• 한번에 여러 필드를 주입 받을 수 있음
• 보통 잘 사용하지 않음

private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;

@Autowired
public void init(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

2. 옵션 처리

1. @Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨
2. org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력됨
3. Optional<> : 자동 주입할 대상이 없으면 Optional.empty 가 입력됨

3. 생성자 주입

• 생성자 주입 권장 이유
  • 대부분의 의존 관계는 애플리케이션 종료 전까지 변경할 일이 없음
  • 수성자 주입을 사용하려면 set메서드를 public으로 열어두어야 하는데, 이는 좋은 설계방법이 아님
  • 필요한 의존 관계가 누락되었을 때, 컴파일 오류가 발생하는데, IDE에서 어떤 값을 필수로 주입해야하는지 알려줌
• 롬복 라이브러리를 이용한 개발
  • @RequiredArgsConstructor : final이 붙은 필드를 모아 생성자 자동 생성

    @Component
     @RequiredArgsConstructor
     public class OrderServiceImpl implements OrderService {
         private final MemberRepository memberRepository;
         private final DiscountPolicy discountPolicy;
     }
    ``

4. 조회 빈이 2개 이상인 경우_해결방법

• @Autowired 는 타입(Type)으로 조회 -> ac.getBean(DiscountPolicy.class)과 유사한 동작
• 선택된 빈이 2개 이상이라면

[ FixDiscountPolicy ]

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

[ RateDiscountPolicy ]

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

[ 에러 발생 ]

4-1. @Autowired 필드 명 매칭

1. 타입매핑
2. 여러 빈이 있다면, 필드 이름, 파라미터 이름으로 빈이름 추가 매핑

[ 필드 명을 빈이름 추가 매핑 ]

private final MemberRepository memberRepository;
private final DiscountPolicy rateDiscountPolicy;

@Autowired  // 생성자가 딱 1개라면 생략 가능
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

[ 파라미터 이름으로 빈이름 추가 매핑 ]

private MemberRepository memberRepository;
private DiscountPolicy discountPolicy;

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

4-2. @Qualifier

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

• 추가 구분자 -> 주입 시 추가적인 방법을 제공하는 것이지, 빈이름 변경하는 것이 아님
• 빈 등록시 @Qualifier 붙이기

[ 빈 등록 ]

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

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

[ 생성자 자동 주입 ]

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

• 만약, @Qualifier("이름")을 못찾으면, 이름을 가진 스프링빈을 추가로 찾음
• 하지만, @Qualifier 는 @Qualifier 를 찾는 용도로만 사용하는 것이 좋음

4-3. @Primary

• 우선순위 정하기
• @Autowired 시에 여러 빈이 매칭되면 @Primary 가 우선권을 가짐

[ 빈 등록 ]

@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;
}

4-4. 사용 우선순위

• @Primary 는 기본값 처럼 동작, @Qualifier 는 매우 상세하게 동작
• 스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선순위가 높음 -> @Qualifier

5. 어노테이션 직접 만들기

• 직접 만드는 이유 : @Qualifier("mainDiscountPolicy")처럼 문자(mainDiscountPolicy)를 적으면 컴파일시 타입 체크가 안됨

[ 어노테이션 만들기 ]

@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 {}

6. 조회한 빈이 모두 필요할 때, List, Map

public class AllBeanTest {
    @Test
    void findAllBean() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);
        DiscountService discountService = ac.getBean(DiscountService.class);
        assertThat(discountService).isInstanceOf(DiscountService.class);
        
        Member member = new Member(1L, "userA", Grade.VIP);
        int discountPrice = discountService.discount(member, 10000, "fixDiscountPolicy");
        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;
        }
        
        public int discount(Member member, int price, String discountCode) {
            DiscountPolicy discountPolicy = policyMap.get(discountCode);
            return discountPolicy.discount(member, price);
        }
    }
}

7. 자동, 수동의 올바른 실무 운영 기준

• 스프링은 @Component 뿐만 아니라 @Controller, @Service, @Repository처럼 계층에 맞추어 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원함

• 설정 정보를 기반으로 애플리케이션을 구성하는 부분과 동작하는 부분을 명확하게 나누는 것이 이상적이지만, 스프링 빈 등록시 @Component만 넣어주면 끝나기 때문에 자동화 선호하는 추세

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

  • 업무 로직 빈
    • 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리 등
    • 비즈니스 요구사항을 개발할 때 추가되거나 변경됨
  • 기술 지원 빈
    • 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용됨
    • 데이터베이스 연결이나, 공통 로그 처리처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들
    • 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미침 + 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많음 -> 가급적 수동 빈 등록을 사용해서 명확하게 하는게 좋음