[Spring] 의존관계 주입에 대해

의존관계 주입에 대해

본 내용은 김영한 님의 스프링 핵심 원리 강의 내용을 토대로 정리했습니다.

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

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

@Autowired의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 대상이 없어도 동작하게 하려면 @Autowired(required=false) 지정
순수한 자바 테스트 코드에는 @Autowired가 동작하지 않는다. @SpringBootTest처럼 스프링 컨테이너를 테스트에 통한 경우에만 가능

---

생성자 주입

@Component
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

생성자 호출시점에 딱 1번만 호출하는 것이 보장되는 방법이고, 불변, 필수 의존관계에 사용된다.
생성자가 1개만 있으면 @Autowired생략해도 자동 주입된다. 스프링 빈에 한해서만!
lombok의 @RequiredArgsConstructor를 이용하면 생성자 또한 생략이 가능하다.

수정자 주입(setter)

@Component
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

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

수정자를 통한 주입 방법이고 선택, 변경 가능성이 있는 의존관계에 사용된다.

필드 주입

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

코드가 간결하지만 외부에서 변경이 불가능해서 테스트하기가 힘들고, DI 프레임워크가 없으면 아무것도 할 수 없다.
테스트 코드나 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용된다.

일반 메서드 주입

@Component
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

일반 메서드를 통해서 주입 받을 수 있으나 일반적으로 잘 사용하지 않는다.

---

옵션 처리

@Autowired는 자동 주입 대상이 없으면 오류가 나기 때문에 조치를 취해주어야 한다.(required = true)가 default 값이다.

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

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

첫 번째는 아예 호출이 안되고 두 번째는 null이 입력되고 세 번째는 Optional.empty가 입력 된다.

noBean2 = null
noBean3 = Optional.empty

다음과 같이 말이다.

---

주입 방법은 생성자 주입을 택하는 것이 좋다. 왜냐하면 불변의 성질 때문이다.

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

생성자 주입을 이용하고 final키워드를 이용한다면 생성자에서 값 설정이 안된 오류를 컴파일 시점에서 막아준다.

---

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

@Autowired
private DiscountPolicy discountPolicy;

이 코드는 마치 ac.getBean(DiscountPolicy.class)와 유사하게 동작한다.(실제로는 더 많은 기능을 제공하지만)

@Component
public class FixedDiscountPolicy implements DiscountPolicy{
}

@Component
public class RateDiscountPolicy implements DiscountPolicy{
}

다음의 경우를 실행하게 되면 NoUniqueBeanDefinitionException오류가 발생하게 된다.
타입으로 조회했기 때문에 2개의 빈이 발견되기 때문이다.

하위 타입으로 지정할 수도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성을 떨어트리는 방법이다.
이를 위한 방법들이 있다.

• @Autowired 필드 명 매칭
• @Qualifier -> @Qualifier끼리 매칭 -> 빈 이름 매칭
• @Primary 사용

@Autowired 필드 명

//기존의 코드
@Autowired
private DiscountPolicy discountPolicy;

//필드 명을 빈 이름으로 변경 코드
@Autowired
private DiscountPolicy rateDiscountPolicy;

필드 명이 rateDiscountPolicy이므로 정상적으로 주입이 된다.
필드 명 매칭은 먼저 타입 매칭을 시도하고 그 결과에 따라 여러 빈이 있을 때 추가로 동작하는 기능이다.
@Autowired는 1.타입으로 매칭하고, 2.그 결과가 2개 이상일 시에 파라미터 명으로 빈 이름을 매칭하는 것을 알 수 있었다.

@Qualifier

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

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

//생성자 자동 주입 시
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
                        @Qualifier("mainDiscountPolicy")DiscountPolicy discountPolicy){
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

//수정자 자동 주입 시
@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy")DiscountPolicy discountPolicy){
    return discountPolicy;
}

다음과 같은 방법으로 매칭시킨다.
그러면 만약 @Qualifier("mainDiscountPolicy")를 못찾으면 어떻게 되는지 궁금할 것이다.
이 때에는 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다.
이 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는 것이 좋다.

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

다음과 같이 @Bean을 직접 등록할 때에도 사용이 가능하다.
@Qualifier는 @Qualifier끼리 매칭되고, 못 찾으면 빈 이름으로 매칭하고, 못 찾으면 NoSuchBeanDefinitionException 발생한다.

@Primary

@Primary는 우선권을 가지게하는 어노테이션이다. 여러 빈이 매칭이 되면 해당 어노테이션을 가지고 있는 빈이 우선 시 된다.

@Component
@primary
public class FixedDiscountPolicy implements DiscountPolicy{
}

@Component
public class RateDiscountPolicy implements DiscountPolicy{
}

그렇다면 @Primary와 @Qualifier 중 어느 것이 좋을까?
@Qualifier는 주입 받을 때에 모든 코드에 붙여주어야 한다는 단점이 있지만, @Primary는 그렇게 붙여줄 필요가 없다.

예를 들어, 메인 데이터베이스의 커넥션을 획득하는 스프링 빈은 @Primary를 사용해서 간단하게 조회하면 될 것이고,
서브 데이터베이스 커넥션을 획득할 때에는 @Qualifier를 지정해서 명시적으로 획득하는 방식을 사용하면 될 것이다.

@Qualifier는 매우 상세하게 동작하기 때문에, @Primary보다 우선순위가 더 높다.

---

어노테이션을 직접 만들어 사용할 수도 있다. 일반적으로 @Qualifier("mainDiscountPolicy")이렇게 사용을 하게되는데,
컴파일 시에 타입 체크가 안된다. 무슨 말이냐면 main을 mainn 뭐 이렇게 오타가 나도 컴파일 단계에서 체크를 못해준다는 것이다.

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

그래서 다음과 같이 직접 만들어 주었다. @Qualifier안에 있는 어노테이션 4개를 들고와 붙여주고, @Qualifier를 추가로 붙여주었다.

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy{

그리고 다음과 같이 사용해 주었다. 여기서는 이제 오타를 내면 컴파일 오류가 날 것이다.
주입 시에도 @Qualifier대신 @MainDiscountPolicy를 사용해주면 된다.
어노테이션에는 상속이라는 개념이 없는데 이렇게 어노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다.
@Qualifier뿐만 아니라 다른 어노테이션들도 동일하게 재정의 할 수 있다. 그러나 뚜렷한 목적이 없다면 유지보수에 혼란을 가중할 것이다.

---

지금까지 빈 이름이 중복될 경우에 대한 방안을 해결했었는데, 모든 빈이 다 필요한 경우도 있다.
예를 들면 할인 서비스의 종류를 선택한다거나 하는 경우에 말이다.

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, 20000, "rateDiscountPolicy");

        assertThat(discountService).isInstanceOf(DiscountService.class);
        assertThat(discountPrice).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 클래스의 생성자를 보면 DiscountPolicy를 Map과 List의 형태로 받아주고 있다.(@RequiredArgsConstructor)사용가능
그리고 DiscountService 자체를 빈으로 등록을 해주었다. 해당 Map과 List에 원활한 주입을 위해 AutoAppConfig 또한 같이 주입해주었다.
AutoAppConfig는 @ComponentScan이 달려있고, DiscountPolicy 타입을 받는 클래스들을 빈 등록 해주는 클래스이다.

생성자에서 출력한 값을 보면 다음과 같다.

policyMap = {fixedDiscountPolicy=hello.core.discount.FixedDiscountPolicy@37052337, rateDiscountPolicy=hello.core.discount.RateDiscountPolicy@2320fa6f}
policies = [hello.core.discount.FixedDiscountPolicy@37052337, hello.core.discount.RateDiscountPolicy@2320fa6f]

이제 로직을 보면 스프링 컨테이너에서 DiscountService를 가져온다. 그리고 discount()메서드에 "rateDiscountPolicy"를 적었는데,

        public int discount(Member member, int price, String discountCode) {
            DiscountPolicy discountPolicy = policyMap.get(discountCode);
            return discountPolicy.discount(member, price);
        }

보면 해당 맵에서 찾아서 받아와 discount(member,price)를 해버리고 리턴한다.
감탄이 절로 나오는 방법이다...

---

자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.

업무 로직의 경우는 자동 빈 등록을 사용하는 것이 좋다.
기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 애플리케이션 전반에 광범위하게 영향을 미친다.
이러한 이유 때문에, 기술 지원 로직은 적용지 잘 되고 있는지 파악이 어려워 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋다.

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

마지막 코드 예제처럼 다형성을 활용하는 경우에, 내가 내 코드를 보는 것은 상관없지만 다른 개발자한테서 받은 코드라면,
자동 빈 등록을 사용하고 있기 때문에 파악하려면 여러 코드를 찾아봐야 한다.

따라서, 이런 경우에는 수동 빈으로 등록하거나 자동 빈을 사용할 경우에는 특정 패키지에 같이 묶어두는 것이 좋다.

---