[Spring] 의존관계 자동 주입

스프링 핵심 원리 - 기본편

스프링 핵심 원리 - 기본편 - 인프런

강의를 들으며 생각 정리

 

의존관계 주입 방법

---

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

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

일반적으로 생성자 주입을 주로 사용하고 가끔 수정자 주입을 사용한다. 필드 주입과 일반 메서드 주입은 거의 사용하지 않는다.

 

생성자 주입

이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법이다.

• 생성자 호출시점에 딱 1번만 호출되는 것이 보장된다.
• 불변(setter가 따로 없는), 필수(final 키워드) 의존관계에 사용된다.
• 객체 생성시 생성자가 자동 수행되기 때문에, 스프링 빈으로 등록할 때 자동으로 의존관계가 생성된다.

@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개만 있으면 @Autowired를 생략 가능한다.)

 

수정자 주입(setter 주입)

setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법이다.

• 선택, 변경 가능성이 있는 의존관계에 사용한다.(생성자 주입과 반대)
• 스프링 빈으로 등록하고 그 후에 의존관계가 설정된다.

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

 

이외에 필드 주입, 일반 메서드 주입이 있지만 최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다. 그 이유는 다음과 같다.

 

- 불변

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

 

- 누락

수정자 주입을 사용하는 경우 테스트 수행 시 객체를 생성하고 해당 객체의 인자들을 setter로 따로 넣어줘야 하지만 생성자 주입은 한 번에 생성과 의존관계 주입을 할 수 있다. 따라서 생성자 주입은 필드에 값이 누락되는 경우 컴파일 에러로 잡아주기 때문에 편리하다.

 

-> 정리하자면 항상 생성자 주입을 선택하는 것이 좋다. 가끔 옵션이 필요하면 수정자 주입을 선택한다. 필드 주입은 사용하지 않는게 좋다.

 

- 필수

생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있다. 그래서 생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에 막아준다.

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

 

 

옵션 처리

---

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

@Autowired는 required 옵션의 기본값이 true로 되어 있어서 자동 주입 대상이 없으면 오류가 발생한다.

이를 에러가 나지 않고 실행할 수 있게 하는 방법은 다음과 같다.

• @Autowired(required=false) : 자동 주입할 대상이 없으면 의존관계 주입 자체가 호출 안됨
• @Nullable : 자동 주입할 대상이 없으면 null이 입력된다.
• Optional<> : 자동 주입할 대상이 없으면 Optional.empty가 입력된다.

//호출 안됨
@Autowired(required = false)
public void setNoBean1(Member member) {
 System.out.println("setNoBean1 = " + member);
}

//null 호출
@Autowired
public void setNoBean2(@Nullable Member member) {
 System.out.println("setNoBean2 = " + member);
}

//Optional.empty 호출
@Autowired(required = false)
public void setNoBean3(Optional<Member> member) {
 System.out.println("setNoBean3 = " + member);
}

출력결과

setNoBean2 = null
setNoBean3 = Optional.empty

(@Nullable, Optional은 생성자 자동 주입에서 특정 필드에만 사용해도 된다.)

 

롬복

---

막상 개발을 해보면, 대부분이 다 불변이고, 그래서 생성자에 final 키워드를 사용하게 된다. 이에 따라 생성자도 만들어야 하고 주입 받은 값을 대입하는 코드도 만들어야 하는데 이를 보다 편리하게 사용하는 방법이 롬복 라이브러리이다.

 

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

위 코드를 롬복 라이브러리를 사용하면 다음과 같이 보다 간결하게 나타낼 수 있다.

 

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

위 코드와 이전의 코드는 완전히 동일하다. 롬복이 자바의 애노테이션 프로세서라는 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성해준다.

(롬복은 따로 라이브러리를 build.gradle에 적용해야한다. 자세한 사항은 구글 검색을 통해 알 수 있다.)

 

조회 빈 중복 문제

---

@Autowired는 타입(Type)으로 조회하기 때문에 다음 코드와 유사하게 동작한다.

ac.getBean(DiscountPolicy.class)

이 때, DiscountPolicy를 의존하는 두 클래스 모두 @Component를 통해 스프링 빈으로 등록이 되어 있다면 문제가 발생한다. (NoUniqueBeanDefinitionException)

이 때, 하위 타입으로 지정할 수도 있지만, 이는 DIP를 위배하고 유연성이 떨어진다.

이를 해결하는 여러 방법이 있다.

• @Autowired 필드 명
• @Qualifier
• @Primary

하나씩 알아보자.

 

@Autowired 필드 명

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

@Autowired
private DiscountPolicy rateDiscountPolicy

만약 위와 같은 자동 주입이 있으면 DiscountPolicy에서 빈 중복이 발생하기 때문에 필드 명을 확인한다. 따라서 rateDiscountPolicy로 빈 이름을 매칭하기 때문에 정상 주입된다.

-> 정리

1. 타입 매칭

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

 

@Qualifier

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

 

빈 등록시 @Qualifier를 붙여 준다.

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

생성자 자동 주입 예시

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

만약 @Qualifier("mainDiscountPolicy")를 못찾으면 어떻게 될까? 그러면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다. 하지만 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는게 명확하고 좋다.

-> 정리

1. @Qualifier끼리 맴칭

2. 빈 이름 매칭

 

@Primary

@Autowired 시에 여러 빈이 매칭되면 @Primary가 우선권을 가진다.

 

rateDiscountPolicy에 우선권 부여

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

 

-> 정리

코드에서 자주 사용하는 스프링 빈이 있고 가끔 사용하는 스프링 빈이 있다고 생각해보자. 주로 사용하는 스프링 빈은 @Primary를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고, 서브 스프링 빈을 획득할 때는 @Qualifier를 지정해서 명시적으로 획득하는 방식을 사용하면 코드를 깔끔하게 유지할 수 있다.

여기서 @Qualifier가 @Primary보다 우선권이 높기 때문에 유의하자.

 

애노테이션 직접 만들기

---

@Qualifier("mainDiscountPolicy")의 경우 "mainnDiscountPolicy"와 같이 사소한 문자 입력 오류 시 컴파일 타입 때 체크가 안된다. 이 때, 다음과 같은 애노테이션을 만들어서 사용하면 보다 편리하다.

 

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

애노테이션에는 상속이라는 개념이 없다. 이렇게 여러 애노테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다. 따라서 @Qualifier에 필요한 @Target, @Retention과 같은 애노테이션도 따로 명시해준다. 물론 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의 하는 것은 유지보수에 더 혼란만 가중할 수 있다.

 

조회한 빈이 모두 필요할 때

---

앞서 어떤 타입의 스프링 빈이 중복될 때 문제와 해결방안을 알아봤다. 그러나 의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우도 있다.

예를 들어, 클라이언트가 할인 정책을 선택할 수 있는 경우(fix or rate) 중복되는 빈을 모두 조회해서 제공하는 서비스가 필요하다.

이는 다음과 같이 구현할 수 있다.

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 rateDiscountPolicy = discountService.discount(member, 20000, "rateDiscountPolicy");
        assertThat(rateDiscountPolicy).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 또는 List로 중복되는 빈을 전부 주입받을 수 있다.

Map의 경우 키에 스프링 빈의 이름을 넣어주고, 그 값으로 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.

여기서 discount 메서드는 discountCode에 따라 할인 정책을 각각 달리 할 수 있다.

 

자동, 수동 빈

---

지금까지 스프링 컨테이너에 스프링 빈을 설정하는 다양한 방법(수동, 자동)에 대해 알아봤다. 그렇다면 어떤 방법을 사용하는 것이 효율적일까?

 

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

스프링이 나오고 시간이 갈수록 점점 자동을 선호하는 추세다. 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했다.

설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 이상적이지만, 개발자 입장에서 스프링 빈을 하나 등록할 때 @Component만 넣어주면 끝나는 일을 @Configuration 설정 정보에 가서 @Bean을 적고, 객체를 생성하고, 주입할 대상을 일일이 적어주는 과정은 상당히 번거롭다.

 

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

 

- 기술 지원 로직

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

• 업무 로직 빈  : 컨트롤러, 서비스, 리포지토리 등 비즈니스 요구사항을 개발할 때 추가하거나 변경되는 로직이다.
• 기술 지원 빈 : 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 업무로직을 지원하는 공통 로직이다.

업무 로직은 숫자도 매우 많고, 한번 개발하면 컨트롤러, 서비스 ,리포지토리처럼 어느정도 유사한 패턴이 있다. 이런 경우 자동 기능을 적극 사용하는 것이 좋다.

기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐 광범위하게 영향을 미치기 때문에 문제가 발생했을 때 찾기 어려운 경우가 많다. 그래서 이런 기술 지원 로직은 가급적 수동 빈 등록을 사용해서 명확하게 볼 수 있게 들어내는 것이 유지보수하기에 좋다.

 

- 다형성을 적극 활용할 때

앞서 조회한 빈을 모두 사용하는 경우, 여기에 어떤 빈들이 주입될지, 각 빈들의 이름은 무엇일지 코드만 보고 한번에 쉽게 파악하기 힘들다. 이런 경우 수동 빈으로 등록하거나 또는 자동으로하면 특정 패키지에 같이 묶어두는 것이 좋다. 핵심은 딱 보고 이해하기 쉽게 만드는 것이다.

 

-> 정리

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

2. 기술 지원 객체는 수동 등록.

3. 다형성을 적극 활용하는 경우 수동 등록하거나 같은 패키지에 묶어둔다.