스프링 핵심원리 기본편 - Ch07. 의존관계 자동 주입

목록

1. 포스팅 개요
2. 본론
     2-1. 다양한 의존관계 주입 방법
     2-2. 옵션 처리
     2-3. 생성자 주입을 선택하라!
     2-4. 롬복과 최신 트렌드
     2-5. 조회 빈이 2개 이상 - 문제
     2-6. @Autowired 필드명, @Qualifier, @Primary
     2-7. 애노테이션 직접 만들기
     2-8. 조회한 빈이 모두 필요할 때, List, Map
     2-9. 자동, 수동의 올바른 실무 운영 기준
3. 요약

1. 포스팅 개요

인프런에서 영한님의 스프링 핵심 원리 기본편 Section07 의존관계 자동 주입을 학습하며 정리한 포스팅이다.

| 참고 이전 포스팅

2. 본론

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

의존관계 주입은 크게 4가지 방법이 있다.

• 생성자 주입
• 수정자 주입(setter 주입)
• 필드 주입
• 일반 메서드 주입

생성자 주입

이름 그대로 생성자를 통해 의존관계를 주입받는 방법이다.
예시는 다음과 같다.

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

생성자 주입 특징은 다음과 같다.

• 생성자 호출시점에 1번만 호출되는 것이 보장된다.
• 불변, 필수 의존관계에 사용한다.
  • 강제로 수정하는 메서드를 만들지 않는 한 불변이다.
  • final 키워드를 붙여줌으로써 무조건 있어야하는 것을 의미한다.

참고로 생성자가 하나만 있으면 @Autowired를 붙여줄 필요가 없다.
만약 두 개 이상이면, @Autowired를 명시해줘야 한다.

OrderServiceImpl 클래스를 다음과 같이 작성해보고, AutoAppConfigTest의 test를 돌려본다.

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        System.out.println("memberRepository = " + memberRepository);
        System.out.println("discountPolicy = " + discountPolicy);
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

결과는 다음과 같다.

@Autowired를 붙여도 결과는 똑같다.
따라서 생성자가 하나일 때는 @Autowired가 자동으로 적용된다.

수정자 주입(setter 주입)

setter를 사용하려면, 일단 final 키워드를 빼야한다.
그리고 각 필드마다 Setter를 통해 변경되도록 한다.

그리고 그 수정자마다 @Autowired를 붙여주면 된다.

OrderServiceImpl 클래스를 다음과 같이 작성해서 테스트 해보자.

@Component
public class OrderServiceImpl implements OrderService {

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

    @Autowired
    public void setMemberRepository(MemberRepository memberRepository) {
        System.out.println("memberRepository = " + memberRepository);
        this.memberRepository = memberRepository;
    }

    @Autowired
    public void setDiscountPolicy(DiscountPolicy discountPolicy) {
        System.out.println("discountPolicy = " + discountPolicy);
        this.discountPolicy = discountPolicy;
    }

결과는 다음과 같다.

반면에 @Autowired를 빼면 호출되지 않는다.

결과는 다음과 같다.

스프링 컨테이너는 두 가지의 라이프 사이클이 있다.

첫째 스프링 빈을 다 등록한다.
두 번째 @Autowired를 통해 연관관계를 자동으로 주입한다.

사실 수정자 주입을 하더라도 생성자 주입이 발생한다.
그래서 다음과 같이 코드를 수정하고 돌려보면,

@Component
public class OrderServiceImpl implements OrderService {

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

    @Autowired
    public void setMemberRepository(MemberRepository memberRepository) {
        System.out.println("memberRepository = " + memberRepository);
        this.memberRepository = memberRepository;
    }

    @Autowired
    public void setDiscountPolicy(DiscountPolicy discountPolicy) {
        System.out.println("discountPolicy = " + discountPolicy);
        this.discountPolicy = discountPolicy;
    }

    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        System.out.println("memberRepository = " + memberRepository);
        System.out.println("discountPolicy = " + discountPolicy);
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

결과는 다음과 같다.

왜냐하면 OrderServiceImpl을 스프링 빈으로 등록하기 위해 생성자를 한번은 호출해야한다.
그렇기 때문에 빈을 등록하면서 의존관계 주입이 자동으로 이루어진다.

따라서

1. 생성자는 스프링 라이프 사이클 중 빈을 등록할 때 자동주입이 일어난다.
2. 수정자 주입은 의존 관계 두 번째 단계에서 일어난다.

이처럼 생성자 주입이 먼저 호출되고, 수정자 주입이 호출됨을 알 수 있다.

수정자 주입을 사용하려면 최종 코드는 다음과 같다.

@Component
public class OrderServiceImpl implements OrderService {

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

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

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

보는 바와 같이 생성자를 없애주면 된다.

특징은 다음과 같다.

• 선택, 변경 가능성이 있는 의존관계에 사용한다.
• 자바 빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.

참고로 @Autowired의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 주입 할 대상이 없어도 동작하게 하려면 다음과 같디 하면된다.

@Autowired(required = false)

자바빈 프로퍼티 규약

그냥 Setter, Getter를 통해서 필드에 접근하는 것이 프로퍼티 규약이다.

필드 주입

• 이름 그대로 필드에 바로 주입하는 방법이다.

코드는 다음과 같다.

@Component
public class OrderServiceImpl implements OrderService {

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

   @Override
   public Order createOrder(Long memberId, String itemName, int itemPrice) {
       Member findMember = memberRepository.findById(memberId);
       int discountPrice = discountPolicy.discount(findMember, itemPrice);

       return new Order(memberId, itemName, itemPrice, discountPrice);
   }

다음은 테스트 코드다.

public class AutoAppConfigTest {

    @Test
    void basicScan() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);

        OrderServiceImpl bean = ac.getBean(OrderServiceImpl.class);
        MemberRepository memberRepository = bean.getMemberRepository();
        System.out.println("memberRepository = " + memberRepository);
    }
}

결과는 다음과 같다.

접근제한자가 private 임에도 불구하고, 필드에 의존관계를 넣어준다.
하지만 현재 필드 주입자를 권장하지 않는다.

특징은 다음과 같다.

• 코드가 간결하지만 외부에서 변경이 불가능하여 테스트하기 힘든 단점이 있다.

  임의의 테스트 코드를 작성하고 실행해보자.

     @Test
     void fieldInjectionTest() {
        OrderServiceImpl orderService1 = new OrderServiceImpl();
        orderService.createOrder(1L, "itemA", 10000);
     }

  당연히 NullPointException이 발생한다.

  java.lang.NullPointerException: Cannot invoke "hello.core.order.OrderService.createOrder(java.lang.Long, String, int)" because "this.orderService" is null

  따라서 값을 넣어주려면 Setter를 열어줘야 한다.

  ...
     public void setMemberRepository(MemberRepository memberRepository) {
       this.memberRepository = memberRepository;
   }
  
   public void setDiscountPolicy(DiscountPolicy discountPolicy) {
       this.discountPolicy = discountPolicy;
   }
  ...
  

  필드 주입은 Setter를 만들어줘야하는데, 그럴 바엔 그냥 Setter에서 @Autowired를 사용하는 것이 더 낫다. 그럼 컨테이너세어 쓸 수도 있고, 테스트할 때도 쓸 수 있다.

• DI 프레임워크가 없으면 아무것도 할 수 없다.

• 그냥 사용하지 말자!

• 다음은 사용 가능하다.

  • 애플리케이션의 실제 프로덕션 코드와 관계 없는 테스트 코드
  • 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

참고로 순수한 자바 테스트 코드는 @Autowired가 동작하지 않는다.
@SpringBootTest과 같이 스프링 컨테이너를 테스트에 통합한 경우에만 동작한다

일반 메서드 주입

• 일반 메서드를 통해서 주입 받을 수 있다.
• 한번에 여러 필드를 주입 받을 수 있다는 특징이 있다.
• 일반적으로 잘 사용하지 않는다.

다음과 같이 사용한다.

@Component
public class OrderServiceImpl implements OrderService {

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

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

    @Autowired // 일반 메서드 주입
    public void init(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

사실 이 부분은 생성자 주입과 수정자 주입에서 다 해결하기 때문에 사용할 일은 거의 없다.
일반적으로 잘 사용하지 않는다.

참고로 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다.
스프링 빈이 아닌 Member 같은 클래스에서 @Autowired코드를 적용해도 아무 기능도 동작하지 않는다.

2-2. 옵션 처리

주입할 스프링 빈이 없어도 동작해야 할 때가 있다. 그런데 @Autowired만 사용하면 required옵션(값이 필수)의 기본값이 true로 되어 있어서 자동 주입 대상이 없으면 오류가 발생한다.

자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다.

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

다음은 옵션처리에 대한 테스트 코드다.

import hello.core.member.Member;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.lang.Nullable;

import java.util.Optional;

public class AutowiredTest {

    @Test
    void AutowiredOption() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);
    }

    static class TestBean {
        @Autowired(required = false) // 의존관계 주입이 필수가 아님 // 자동 주입할 대상이 아님으로 메서드 자체가 호출 안됨
        public void setNoBean1(Member noBean1) {
            System.out.println("noBean1 = " + noBean1);
        }

        @Autowired
        public void setNoBean2(@Nullable Member noBean2) {
            System.out.println("noBean2 = " + noBean2);
        }

        @Autowired
        public void setNoBean3(Optional<Member> noBean3) {
            System.out.println("noBean3 = " + noBean3);
        }
    }
}

결과는 다음과 같다.

noBean2 = null
noBean3 = Optional.empty

noBean1에서 주석에 나온 것처럼
자동 주입할 대상이 없으므로 메서드 자체가 호출이 되지 않았다.

noBean2는 @Nullable을 붙여줌으로 null이 나왔다.
noBean3은 자바 8의 Optional<Member> 이 들어왔을 때 빈이 있으면 Optional안에 값이 있겠지만, 없으면 Optional.empty를 반환한다.

| 참고로 @Nullable, Optional은 스프링 전반에 걸쳐서 지원된다.
| 예를 들어서 생성자 자동 주입에서 특정 필드에만 사용해도 된다. (파라미터 3개 중 2개만 주입하고, 하나는 @Nullable을 사용한다는가 하는 등..)

2-3. 생성자 주입을 선택하라!

생성자 주입의 특징은 다음과 같다.

불변

• 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다.(불변해야 한다.)
• 수정자 주입을 사용하면, setter를 public으로 열어두어야 한다.
  • 누군가 실수로 변경할 수 도 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다.
• 생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출되는 일이 없다. 따라서 불변하게 설계할 수 있다.

누락

프레임워크 없이 순수한 자바 코드를 단위 테스트 하는 경우에 다음 코드와 같이 수정자 의존관계인 경우

@Component
public class OrderServiceImpl implements OrderService {

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

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

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

다음과 같이 테스트 코드를 작성한다.

class OrderServiceImplTest {

    @Test
    void createOrder() {
        OrderServiceImpl orderService = new OrderServiceImpl();
        orderService.createOrder(1L, "itemA",10000);
    }

}

// 중간에 AppConfig.java에서는 다음과 같이 살짝 변경해준다.
    @Bean
    public OrderService orderService() {
//        return new OrderServiceImpl(memberRepository(), discountPolicy());
        return null;
    }

결과는 다음과 같다.

OrderServiceImpl 테스트만 하고싶다해도, memberRepository와 discountPolicy가 필요하다.
필요한데 지금 테스트 코드를 보면 memberRepository와 discountPolicy가 누락이 되어있다.

방금의 수정자 주입 코드를 다시 지우고, 생성자 주입으로 바꿔보자.
바꾸는 순간 컴파일 오류가 발생한다.

이처럼 생성자 주입을 사용하면 누락을 방지할 수 있다.

테스트 코드를 마저 짜면 다음과 같다.

    @Test
    void createOrder() {
        MemoryMemberRepository memberRepository = new MemoryMemberRepository();
        memberRepository.save(new Member(1L, "name", Grade.VIP));


        OrderServiceImpl orderService = new OrderServiceImpl(memberRepository, new FixDiscountPolicy());
        Order order = orderService.createOrder(1L, "itemA", 10000);
        assertThat(order.getDiscountPrice()).isEqualTo(1000);
    }

final

final 키워드를 사용하면 초기 값을 넣어주거나, 아니면 생성자에서만 값을 주입할 수 있다.

final을 선언하지 않고, 실수로 다음과 같이 누락되었다고 하자.

@Component
public class OrderServiceImpl implements OrderService {

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
//        this.memberRepository = memberRepository;
//        this.discountPolicy = discountPolicy;
    }

테스트 코드는 문제없지만, 실행 시점에 오류가 난다.

이를 막을 수 있는 방법이 final 키워드이다.

이처럼 컴파일 오류가 발생한다.

참고로 수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출되므로, 필드에 final 키워드를 사용할 수 없다. 오직 생성자 주입 방식만 final 키워드를 사용할 수 있다.

정리하자면,

• 생성자 주입 방식은 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법이다.
• 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다. 생성자 주입과 수정자 주입을 동시에 사용할 수 있다.
• 항상 생성자 주입을 선택하자. 옵션이 필요할 때 수정자 주입을 선택하면 된다. 필드 주입은 사용하지 않는게 좋다.

2-4. 롬복과 최신 트렌드

개발을 편하게 해주는 롬복들을 적용해보자.

롬복 라이브러리가 제공하는 @RequiredArgsConstructor을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다.

build.gradle에 다음 코드들을 추가한다.

//lombok 설정 추가 시작
configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
}

dependencies {
    ...

    //lombok 라이브러리 추가 시작
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'

    testCompileOnly 'org.projectlombok:lombok'
    testAnnotationProcessor 'org.projectlombok:lombok'
    //lombok 라이브러리 추가 끝

}
...

여기에 plugin을 설정해주면 된다.

참고

인텔리제이 최신 버전부터 lombok이 내장되어있으니 참고하자.

롬복을 사용하면, Getter와 Setter를 코드없이 애너테이션 하나로 사용가능하다.

@Getter
@Setter
public class HelloLombok {

    private String name;
    private int age;

    public static void main(String[] args) {
        HelloLombok helloLombok = new HelloLombok();
        helloLombok.setName("asdf");

        String name = helloLombok.getName();
        System.out.println("name = " + name);
    }
}

롬복을 적용하자.

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

// 생성자 삭제
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

    ...
}

참고로 ctrl + f12를 누르면, 메서드 정보를 볼 수 있는데, 생성자가 있는 것을 확인할 수 있다.

다음은 MemberServiceImpl이다.

@Component
@RequiredArgsConstructor
public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

// 생성자를 삭제한다.
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    ...
}

그리고 private fianl 필요한_객체_타입 변수; 만 선언해주면 된다.

2-5. 조회 빈이 2개 이상 - 문제

@Autowired는 기본적으로 타입으로 조회한다. 타입으로 조회하기 때문에, 마치 다음 코드와 유사하게 동작한다.
ac.getBean(DiscountPolicy.class)

스프링 빈 조회에서 봤듯이 타입으로 조회시 선택된 빈이 2개 이상일 때 문제가 발생한다.

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

@Component
public class FixDiscountPolicy implements DiscountPolicy {
    ...
}

@Component
public class RateDiscountPolicy implements DiscountPolicy {
    ...
}

그리고 AutoAppConfigTest에서 basicScan() 테스트를 돌려보면 다음과 같은 오류가 발생한다.

Caused by: org.springframework.beans.factory.NoUniqueBeanDefinitionException: No qualifying bean of type 'hello.core.discount.DiscountPolicy' available: expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy

빈 하나의 매칭을 기대했는데, 두개가 매칭되고 있다는 메세지다.

이때 하위 타입으로 지정할 수 도 있지만, 하위 타입으로 지정하면 DIP를 위배하고 유연성이 떨어진다. 그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 안 된다.
스프링 빈을 수동 등록해서 문제를 해결할 수 있지만, 의존 관계 자동 주입에서 해결하는 여러 방법이 있다.

2-6. @Autowired 필드명, @Qualifier, @Primary

헤결 방법은 다음과 같다.

• @Autowired 필드 명 매칭
• @Qualifier를 @Qualifier끼리 매칭하여 빈 이름을 매칭한다.
• @Primary 사용

@Autowired 필드 명 매칭

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

코드를 OrderServiceImpl에서 다음과 같이 코드를 수정해준다.

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

이전에 실패했던 테스트를 돌려보면 결과는 다음과 같다.

    @Autowired
    private DiscountPolicy rateDiscountPolicy;

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

위와 같이 필드 주입을 해줘도 된다.

@Autowired 매칭 정리

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

@Qualifier 사용

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

다음과 같이 코드를 변경해주자.

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

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

적용은 다음과 같이 하면 된다.

@Component
public class OrderServiceImpl implements OrderService {

    ...

    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 ...
}

@Qualifier 정리

1. @Qualifier끼리 매칭
2. 빈 이름 매칭
3. 매칭을 못 찾으면 NoSuchBeanDefinitionException 예외 발생

@Primary 사용

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

적용하는 코드는 다음과 같다.

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
    ...
}

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {...}

@Component
public class FixDiscountPolicy implements DiscountPolicy {...}

결과는 다음과 같다.

이처럼 여러 빈이 조회될 떄 @Primary가 우선권을 가지게된다.
현재 OrderServiceImpl은 현재 @Primary가 등록된 RateDiscountPolicy가 적용되었을 것이다.

(실무에서 메인 DB와 서브 DB가 있을 때 메인 DB에는 @Primary를 서브 DB에는 @Qualifier나 직접 이름을 지정하도록 해서 쓰도록 하기도 한다고 한다.)

@Qualifier의 단점은 주입 받을 때 다음과 같이 모든 코드에 @Qualifier를 붙여주어야 한다는 점이다. 반면에 @Primary를 사용하면 @Qualifier를 붙일 필요가 없다.

우선순위
@Primary는 기본값처럼 동작하는 것이고, @Qualifier는 매우 상세하게 동작한다.
스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선순위가 높다. 따라서 @Qualifier가 우선권이 높다.

2-7. 애노테이션 직접 만들기

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

package hello.core.annotaion;


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)
@Inherited
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {

}

// 애너테이션 적용
@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {...}


@Component
public class OrderServiceImpl implements OrderService {

    ...

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

    ...
}

테스트 결과는 다음과 같다.

애노테이션에는 상속이라는 개념이 없다.
이처럼 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다.
@Qulifier 뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다.
(단적으로 @Autowired도 재정의 할 수 있다.)
스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의 하는 것은 유지보수에 더 혼란만 가중할 수 있다.

2-8. 조회한 빈이 모두 필요할 때, List, Map

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

다음과 같이 테스트 코드를 작성해보고 확인해보자.

public class AllBeanTest {

    @Test
    void findAllBean() {
       ApplicationContext ac = new AnnotationConfigApplicationContext(DiscountService.class);

    }



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

결과는 다음과 같다.

현재 아무 값이 없다. DiscountService만 땡겨왔기 때문이다.

09:51:01.121 [Test worker] DEBUG o.s.b.f.s.DefaultListableBeanFactory -- Creating shared instance of singleton bean 'allBeanTest.DiscountService'

일단 DiscountPolicy를 땡겨오자.
코드를 다음과 같이 수정하자

public class AllBeanTest {

    @Test
    void findAllBean() {
       ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class); // AutoAppConfig.class 추가
    }



    static class DiscountService {

        ...

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

출력 결과는 다음과 같다.

...

policyMap = {fixDiscountPolicy=hello.core.discount.FixDiscountPolicy@48b0e701, rateDiscountPolicy=hello.core.discount.RateDiscountPolicy@241a0c3a}
policies = [hello.core.discount.FixDiscountPolicy@48b0e701, hello.core.discount.RateDiscountPolicy@241a0c3a]

...

그리고 다음과 같이 한번에 스프링 빈을 쫙 받아서 할인정책(빈 이름)을 선택함에 따라 전략 패턴을 구현해볼 수 있다.

import static org.assertj.core.api.Assertions.*;

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);

        int rateDiscountPrice = discountService.discount(member, 20000, "rateDiscountPolicy");
        assertThat(rateDiscountPrice).isEqualTo(2000);
    }

    static class DiscountService {
        private final Map<String, DiscountPolicy> policyMap;
        private final List<DiscountPolicy> policies;

        @Autowired
        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);
            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을 주입한다

2-9. 자동, 수동의 올바른 실무 운영 기준

편리한 자동 기능을 기본으로 사용하자

• 스프링은 시간이 갈 수록 점점 자동을 선호하는 추세
  • 스프링은 @Component 뿐 아니라 @Controller , @Service , @Repository 처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원
  • 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용
  • 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계
• 설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 이상적이다.
  • 개발자 입장에서 스프링 빈을 하나 등록할 때 @Component만 넣어주면 끝나는 일을 @Configuration설정 정보에 가서@Bean 을 적고, 객체를 생성하고, 주입할 대상을 일일이 적어주는 과정은 번거롭다.
  • 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담
• 결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.

수동 빈 등록은 언제 사용?

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

• 업무 로직 빈: 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리등이 모두 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
  • 업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있다. 이런 경우 자동 기능을 적극 사용하는 것이 좋다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽다.
• 기술 지원 빈: 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.
  • 기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미친다. 그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 드러나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많다. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋다.

애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 딱! 설정 정보에 바로 나타나게 하는 것이 유지보수 하기 좋다.

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

이전의 List, Map을 다시 보면, DiscountService 가 의존관계 자동 주입으로 Map<String, DiscountPolicy>에 주입을 받는 상황을 생각해보자.
여기에 어떤 빈들이 주입될 지, 각 빈들의 이름은 무엇일지 코드만 보고 한번에 쉽게 파악할 수 있을까??
내가 개발했으니 크게 관계가 없지만, 만약 이 코드를 다른 개발자가 개발해서 나에게 준 것이라면??
자동 등록을 사용하고 있기 때문에 파악하려면 여러 코드를 찾아봐야 한다.
이런 경우 수동 빈으로 등록하거나 또는 자동으로 하면 특정 패키지에 같이 묶어두는게 좋다
핵심은 딱 보고 이해가 되어야 한다!

참고로 수동으로 등록한다면 다음과 같다.

@Configuration
public class DiscountPolicyConfig {

@Bean
    public DiscountPolicy rateDiscountPolicy() {
        return new RateDiscountPolicy();
    }
@Bean
    public DiscountPolicy fixDiscountPolicy() {
        return new FixDiscountPolicy();
    }
}

설정 정보를 보면 한눈에 빈의 이름은 물론이고, 어떤 빈들이 주입될지 파악할 수 있다.
그래도 빈 자동 등록을 사용하고 싶으면 파악하기 좋게 DiscountPolicy의 구현 빈들만 따로 모아서 특정 패키지에 모아두자.

참고

스프링과 스프링 부트가 자동으로 등록하는 수 많은 빈들은 예외다.
이런 부분들은 스프링 자체를 잘 이해하고 스프링의 의도대로 잘 사용하는게 중요하다.
스프링 부트의 경우 DataSource 같은 데이터베이스 연결에 사용하는 기술 지원 로직까지 내부에서 자동으로 등록하는데, 이런 부분은 메뉴얼을 잘 참고해서 스프링부트가 의도한 대로 편리하게 사용하면 된다.
반면에 스프링 부트가 아니라 내가 직접 기술 지원 객체를 스프링 빈으로 등록한다면 수동으로 등록해서 명확하게 드러내는 것이 좋다.

정리하자면

• 편리한 자동 기능을 기본으로 사용하자.
• 직접 등록하는 기술 지원 객체는 수동 등록
• 다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민

3. 요약

의존관게 자동주입에 대해 미친듯이 자세하게 알아봤다.
(살짝 변태같기도 했다...그만큼 대단하시다. 우리 영한이형..)

다음은 빈 생명주기 콜백에 대해 알아보자.