[스프링 기본] 7. 의존관계 자동 주입

다양한 의존관계 주입 방법

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

생성자 주입

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

지금까지 해왔던 방식

스프링 빈의 경우, 생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입 된다.

생성자 호출시점에 딱 1번만 호출되는 것이 보장된다. 불변, 필수 의존관계에 사용.

(=현재 memberRepository,discountPolicy를 set해주는 함수는 생성자밖에 없다. 그리고 생성자는 보통 한 번만 호출되므로 불변, 필수 의존관계에 사용한다는 것.)

수정자 주입

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

말 그대로 setter에 @Autowired를 붙인다.

선택, 변경 가능성이 있는 의존관계에 사용.

필드 주입

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

테스트 코드나 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용한다.

사용하기 쉬워보이지만 외부 변경이 힘들다는 점 때문에 잘 쓰이지 않는다. (=안쓰는게 좋다.)

일반 메서드 주입

일반 메서드에 @Autowired를 붙인다.

예를 들어 this.객체=파라미터로 받은 객체를 여러개 포함하는 메서드(생성자같지만 일반 메서드인..)에 Autowired를 붙일 수 있다.

역시 일반적으로 잘 쓰이지 않는다....

옵션 처리

주입할 스프링 빈이 없어도 동작해야 할 때가 있다.

이럴 때 특별한 처리가 없으면 오류가 발생한다.

처리 방법은 다음과 같다.

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

어떤 방법을 쓰느냐에 따라 출력 결과가 다른 것을 볼 수 있다.

생성자 주입을 선택해라!

다양한 의존관계 주입 방법 중 생성자 주입 방법이 가장 좋다.

불변

대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다. 생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출되는 일이 없다. 따라서 불변하게 설계할 수 있다. final 키워드를 붙여도 되는 것도 생성자 주입뿐이다.

누락

생성자 주입을 사용하면 주입 데이터를 누락 했을 때 컴파일 오류가 발생한다. 그래서 실수로 누락했더라도 금방 알아채고 고칠 수 있다.

롬복과 최신 트랜드

최근에는 생성자를 딱 1개 두고, @Autowired 를 생략하는 방법을 주로 사용한다.

그런데 개발자들은 생성자를 만드는 것마저 귀찮아서 생략하고 싶어한다.

Lombok 라이브러리의 @RequiredArgsConstructor가 이러한 기능을 제공한다.(build.gradle에 관련 설정 추가 필요)

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

이 코드는 생성자가 없지만, 롬복이 컴파일 시점에 final이 붙은 애들에 대한 생성자 코드를 자동으로 생성해준다. 그래서 위 코드는 생성자+@Autowired를 쓰던 이전 코드와 똑같이 작동한다.

생성자주입 뿐만 아니라, @Getter, @Setter, @toString 등을 붙여서 귀찮은 기본 코드들을 간편하게 생성할 수 있다.

조회 빈이 2개 이상 - 문제

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

스프링 빈 조회에서 학습했듯, 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 생긴다.

@Autowired
private DiscountPolicy discountPolicy

DiscountPolicy의 자식은 FixDiscountPolicy와 RateDiscountPolicy이다.

이런 상황에서 위와 같은 코드는 선택된 빈이 여러개라 오류가 발생한다.

그렇다고 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다.

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

스프링 빈을 수동 등록해서 문제를 해결해도 되지만, 의존 관계 자동 주입에서 해결하는 여러 방법이 있다.

@Autowired 필드 명, @Qualifier, @Primary

위 3가지가 바로 그 해결 방법이다.  

@Autowired 필드 명 매칭

필드명 매칭은 @Autowired가 타입 매칭을 먼저 시도한 후 그 결과에 여러 빈이 있으면 필드 명으로 빈 이름을 매칭하는 기능이다.

@Autowired
private DiscountPolicy discountPolicy

기존 코드

@Autowired
private DiscountPolicy rateDiscountPolicy

필드명(변수명)을 빈 이름으로 변경하면 정상적으로 주입된다.

생성자 주입이었다면 파라미터 이름을 변경하면 된다.

(객체지향 원리를 지키기 위해 타입명은 내버려두고 변수명을 바꾸면, 변수명으로 빈 매칭이 성공해서 주입되는 개념인듯 )

@Qualifier 사용

@Quilifier는 빈 이름을 변경하는 대신 빈들을 구분할 수 있는 추가적인 옵션을 제공한다.

빈 등록시 @Quilifier를 붙여서 사용한다.

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

예를 들어 이렇게 붙여줬다면,

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

문제가 되는 discoutPolicy 파라미터 앞에 @Quilifier("이름")을 붙여서 자동 주입할 수 있다.

@Qualifier 로 주입할 때 @Qualifier("mainDiscountPolicy") 를 못찾으면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다. 하지만 @Qualifier 는 @Qualifier 를 찾는 용도로만 사용하는게 명확하고 좋다.

@Primary 사용

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Primary 는 우선순위를 정하는 방법이다.

여러 빈이 매칭된다면 @Primary를 붙여서 등록한 빈이 우선권을 가진다.

 

@Primary와 @Qualifier가 있으면 @Qualifier가 우선순위가 높다.

겹치는 빈이 2개 있다면, 자주 쓰는 스프링 빈에 @Primary를 주고, 특수한 상황에 쓰는 빈에 @Quailfier을 주는 게 깔끔하다.

애노테이션 직접 만들기

@Qualifier("mainDiscountPolicy")이렇게 문자를 적으면 컴파일시 타입 체크가 안된다. mainn~이런식으로 써도 컴파일 시엔 오류가 안난다.(대신 실행 오류 발생)

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

그래서 이렇게 어노테이션을 직접 만들고 @Qualifier("mainDiscountPolicy")를 포함시킨다.

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

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

그러면 이런식으로 사용할 수 있다.

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

의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우도 있다.

클라이언트가 할인의 종류(rate,fix)를 선택할 수 있다고 가정하고 테스트 코드를 작성해보자.

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

new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class); 함수가 호출되며 해당 클래스를 자동으로 빈에 등록한다.

 

discount 함수가 호출되면 할인의 종류가 선택된다.

파라미터로 받은 키값을 Map에 넣어서 어떤 할인을 선택했는지 알아낸다.

 

이렇게 동작하기 위해서, 생성자는 DiscoutPolicy 타입의 모든 빈을 주입해야 한다.

그러므로 생성자에서 Map과 list을 파라미터로 받는다.

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

 

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

선택지는 2가지가 있다.

• 컴포넌트 스캔과 자동 주입
• 설정 정보를 통해서 수동으로 빈을 등록하고, 의존관계도 수동으로 주입

요즘에는 자동을 선호하는 추세이다.

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

 

※업무로직 빈과 기술 지원 빈

업무 로직 빈

웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리등이 모두 업무 로직이다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.

 

기술 지원 빈:

기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다. (DBUtil.java.. 이런 느낌의 애들인듯) 참고로 기술 지원 로직이라 해도 스프링이 내부적으로 등록하는 것들도 있는데, 이런 것들은 메뉴얼을 잘 참고해서 자동 등록하는 것이 좋다.

 

다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고려할 수 있다.

 @Autowired
    public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policies) {
        this.policyMap = policyMap;
        this.policies = policies;
    }

예를 들어 이 코드를 다른 개발자에게 준다면, 그 개발자는 어떤 빈들이 주입될 지, 각 빈들의 이름은 무엇일지 파악하는데 오래 걸린다. (DiscountPolicy 아래에 RateDiscoutPolicy, FixDiscountPolicy빈이 등록된 걸 파악해야 함)

 

이런 경우 수동 빈으로 등록하거나, 자동으로 하되 특정 패키지에 같이 묶어두는게 좋다.

 

이 포스팅은 인프런 김영한님의 '스프링 핵심 원리 기본편'을 듣고 정리한 것입니다.
강의 링크: https://url.kr/udopsk