스프링 핵심 원리 섹션 7. 의존관계 자동 주입

의존관계 자동 주입

다양한 의존관계 주입 방법

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

생성자 주입

생성자를 통해 의존관계를 주입받는다.

• 생성자 호출 시점에 딱 1번만 호출된다.
• 불변, 필수 의존 관계에서 사용된다.

@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를 생략해도 자동 주입된다. 이것은 스프링 빈에서만 해당된다.

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

수정자 주입

스프링빈은 크게 1) 스프링 빈을 생성하는 단계, 2) @Autowired 애노테이션이 걸린 것들을 자동으로 주입한다.
setter라 불리는 필드의 값을 변경하는 수정자 메서를 통해 의존관계를 주입한다.

• 선택, 변경 가능성이 있는 의존관계에 사용한다.
• 자바빈 프로퍼티 규약에서 수정자 메서드 방식을 사용한다.
  - 자바빈 프로퍼티: 자바에서는 이전부터 필드 값을 직접 변경하지 않고, setX, getX 메서드를 통해 값을 읽거나 수정하는 규칙을 만들었다.

+) 수정자 주입 시, final을 사용할 수 없다. final로 선언된 변수는 반드시 선언과 함께 초기화 되어야 하므로 setter 주입과 같이 의존관계를 주입할 때는 final 선언을 할 수 없다.

@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(의존성 주입) 프레임워크가 없으면 아무것도 할 수 없다.
  - 의존성 주입이란 Product product = new Pencil(); Store store = new Store(product); 처럼 두 객체 간에 관계(의존성)를 맺어주는 것을 말한다.
• 잘 사용하지 않고, 애플리케이션의 실제 코드와 관계없는 테스트코드, 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용한다.

일반 메서드 주입

일반 메서드를 통해서 한번에 여러 필드를 주입받을 수 있다. 일반적으로 잘 사용하지 않는다.
+) 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다.

옵션 처리

스프링 빈은 주입하는 것이 자동 로직으로 되어있지만, 주입할 스프링 빈이 없어도 동작해야 할 때가 있다.

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

자동 주입 여부는 다음 방법과 같이 옵션으로 처리할 수 있다.

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

생성자 주입을 선택하라!

• 불변
  의존관계는 애플리케이션 종료 전까지 변하면 안된다. 생성자 주입은 객체 생성 시, 딱 1번만 호출되고 이후에 호출되지 않아 불변하게 설계할 수 있다.
  수정자 주입을 사용하면, setXxx 메서드를 public으로 열어두기 때문에 변경될 수 있다는 위험성이 있다. 실수로 변경할 수 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다.

• 누락
  프레임워크 없이 순수한 자바 코드를 단위 테스트하는 경우에, 의존관계 누락이 발생할 수 있다.

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

• 생성자 주입 방식을 선택하는 이유는 여러가지가 있지만, 프레임워크에 의존하지 않고 순수한 자바 언어의 특징을 잘 살리는 방법이기도 하다.

• 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에만 수정자 주입 방식을 옵션으로 부여하면 된다. 생성자 주입과 수정자 주입을 유연하게 동시에 사용한다.

• 일단 생성자 주입을 선택하고, 옵션이 필요하면 수정자 주입을 사용한다. 필드 주입은 사용하지 않는다.

롬복과 최신 트렌드

• 롬복 설정

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

이처럼 Lombok을 사용하여 코드를 간결하게 작성할 수 있다. 이러한 코드는 롬복이 자바의 애노테이션 프로세서라는 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성해주기 때문에 가능하다.

장점

• 애노테이션 기반의 코드 자동 생성을 통한 생산성 향상
• 반복되는 코드 다이어트를 통해 가독성 및 유지보수성 향상
• Getter, Setter 외에 빌더 패턴이나 로그 생성 등 다양한 방면으로 활용 가능

최근에는 생성자를 딱 1개 두고, @Autowired를 생략하는 방법을 주로 사용한다. 또한 Lombok라이브러리를 사용하면 필요한 기능들은 모두 제공받고, 코드는 깔끔하게 작성할 수 있다.

조회 빈이 2개 이상 - 문제

• @Autowired는 타입으로 빈을 조회한다. 스프링 빈 조회에서 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다.

예를 들어, DiscountPolicy의 하위 타입인 FixDiscountPolicy와 RateDiscountPolicy 둘다 스프링 빈으로 선언한다. 만약 두 정책 모두 @Component 어노테이션으로 @Bean에 등록되었다면 의존관계 자동 주입을 하여 오류가 발생한다.

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

그리고 의존관계 자동 주입을 실행한다.

@Autowired
private DiscountPolicy discountPollicy;

확인해보면 NoUniqueBeanDefinitionException 오류가 발생하며, 어떤 곳에서 발생하였는지 친절하게 알려준다.

이를 하위 타입으로 지정할 수도 있지만, 하위 타입으로 지정한다면 DIP를 위배하고 유연성이 떨어진다. 이름만 다르고, 똑같은 하위 타입의 스프링 빈이 두개 있어 발생하는 문제는 어떻게 해결할 수 있을까? 스프링 빈을 수동 등록해서 문제를 해결할 수 도 있지만, 의존 관계 자동주입에는 이 외에도 여러 해결 방법들이 있다.

@Autowired 필드명, @Qualifier, @Primary

@Autowired 필드명

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

@Autowired
private DiscountPolicy discountPolicy

필드명을 이름으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy

필드명이 rateDiscountPolicy이므로 정상주입된다. 필드명 매칭은 타입 매칭을 시도하고, 결과에 여러 빈이 있을 때 추가 동작한다.

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

@Qualifier

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

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

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

주입 시에 @Qualifier를 붙여주고 등록한 이름을 적어준다.
생성자 자동 주입 시

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

@Primary 직접 사용

@Primary 우선권을 갖는다. 일단 @Primary가 붙으면 최상위로 의존관계 주입이 된다.

rateDiscountPolicy에 우선권을 부여하고 싶다면,

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

// 수정자
@Autowired
public DiscountPolicy setDiscountPolicy(DiscountPolicy discountPolicy) {
	return discountPolicy;
}    

애노테이션 직접 만들기

문자는 컴파일 타임에 오타 등을 감지할 수 없다.
예를 들어 @Qualifier("mailDiscountPolicy") 처럼 문자를 적으면 컴파일시 타입 체크가 안된다. 따라서 다음처럼 애노테이션을 만들어 문제를 해결할 수 있다.

package hello.core.annotation;

import org.springframework.beans.factory.annotation.Qualifier;

import java.lang.annotation.*;

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}
@Component
@MainDiscountPolicy 
public class RateDiscountPolicy implements DiscountPolicy {}
// 생성자 자동 주입
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @MainDiscountPolicy DiscountPolicy discountPolicy) {
	this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

// 수정자 자동 주입
@Autowired
public DiscountPolicy setDiscountPolicy(@MainDiscountPolicy DiscountPolicy discountPolicy) {
	return discountPolicy;
}    

컴파일 타임에서 오타 등을 바로 감지할 수 있다. 애노테이션에는 상속이라는 개념이 없으며, 여러 애노테이션을 모아서 사용하는 기능을 스프링이 지원해준다. @Qualifier 뿐만 아니라 다른 애노테이션들도 함께 조합해서 사용할 수 있다.

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

의도적으로 해당 타입의 스프링 빈이 필요한 경우, 스프링을 사용하면 전략 패턴을 간단하게 구현할 수 있다.

ex. 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다.

import hello.core.AutoAppConfig;
import hello.core.discount.DiscountPolicy;
import hello.core.member.Grade;
import hello.core.member.Member;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import java.util.List;
import java.util.Map;

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

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(discountPrice).isInstanceOf(DiscountService.class);
        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;
            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을 주입한다.

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

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