의존관계 자동 주입

YH·2023년 4월 13일

✅ 의존관계 주입 방법

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

생성자 주입

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

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

수정자 주입

setter라는 수정자 메소드를 통해서 의존관계를 주입받는 방식이다.
선택, 변경 가능성이 있는 의존관계에 사용
자바 프로퍼티 규약(필드 값을 직정 변경하지 않고 getXXX, setXXX의 별도 메소드로 값을 읽거나 수정하는 규칙)의 수정자 메소드 방식을 사용하는 방법

@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 프레임워크가 없으면 사용이 불가하다.
애플리케이션의 실제 코드와 관계 없는 테스트 코드에만 사용하며, @Configuration 같은 스프링 설정 부분에서만 특별한 용도로 사용

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

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

일반 메소드 주입

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

@Component
public class OrderServiceImpl implements OrderService {
	private MemberRepository memberRepository;
	private DiscountPolicy discountPolicy;
    
	@Autowired
	public void init(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
		this.memberRepository = memberRepository;
		this.discountPolicy = discountPolicy;
	}
}
>

❗ 참고: 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다.

✅ 옵션 처리

@Autowired 사용 시, 주입할 대상이 없으면 오류가 발생한다.
자동 주입 대상을 옵션으로 처리하는 방법은 아래와 같다.
- @Autowired(required - false) : 자동 주입할 대상이 없으면 수정자 메소드 자체가 호출되지 않는다.
- org.springframework.lang.@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);
}

✅ 생성자 주입을 사용하자

생성자 주입을 권장하는 이유는 아래와 같다.
✔ 불변

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

final 키워드

생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있다. 그래서 생성자에 혹시라도 값이 설정되지 않으면 컴파일 오류를 통해 컴파일 시점에 막아준다.
생성자 주입 외에 다른 주입 방식들은 모두 생성자 이후에 호출되므로 final 키워드를 사용할 수 없다.

정리

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

@RequiredArgsConstructor

@RequiredArgsConstructor은 Lombok 라이브러리가 제공하는 어노테이션으로 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다.
생성자 코드를 작성할 필요가 없어진다.
최근에는 생성자를 딱 1개 두고 @Autowired를 생략하는 방법을 주로 사용한다. 여기에 @RequredArgsConstructor를 사용하면 깔끔하게 코드 작성이 가능하다.

✅ 조회 빈이 2개 이상일 경우

@Autowired는 타입으로 조회를 하는데 ac.getBean(DiscountPolicy.class) 와 같이 동작한다. (실제로는 더 많은 기능을 제공)
이 때 DiscountPolicy 타입의 빈이 2개 이상 있을 때는 NoUniqueBeanDefinitionException 오류가 발생한다.

조회 빈이 2개 이상일 때 해결 방법

1. @Autowired 필드 명 매칭

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

//기존 코드
@Autowired
private DiscountPolicy discountPolicy

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

2. @Qualifier 사용

@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는 @Qualifier 끼리 매칭한다.
매칭되는 @Qualifier가 없는 경우, 해당 빈 이름을 가진 스프링 빈을 추가로 찾는다.
매칭되는 빈 이름의 스프링 빈도 없을 경우, NoSuchBeanDefinitionException 예외 발생

3. @Primary 사용

@Primary는 우선 순위를 정하는 방법으로 @Autowired 시에 여러 빈이 매칭되면 @Primary를 가진 빈이 주입된다.

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

@Primary, @Qualifier 활용

두 어노테이션을 활용하는 예시로, 주로 사용하는 메인 데이터베이스 커넥션을 획득하는 스프링 빈이 있고, 가끔 사용되는 서브 데이터베이스 커넥션을 획득하는 스프링 빈이 있을때, 메인 데이터베이스의 스프링 빈은 @Primary를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고, 서브 데이터베이스 스프링 빈을 획득할 때는 @Qualifier를 지정해서 명시적으로 획득하는 방식을 사용하면 코드를 깔끔하게 유지할 수 있다.

우선순위

스프링의 우선순위는 자동보다는 수동이, 넓은 범위 보다는 좁은 범위의 선택권이 우선 순위가 높다. 따라서 @Primary보다 @Qualifier가 우선순위가 높다.

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

의도적으로 어떤 타입의 스프링 빈이 모두 필요한 경우가 있다.
아래의 예시로, 할인 서비스를 제공하는데, 클라이언트가 할인의 종류를 선택할 수 있다고 가정해보자.

package hello.core.autowired;
import hello.core.AutoAppConfig;
import hello.core.discount.DiscountPolicy;
import hello.core.member.Grade;
import hello.core.member.Member;
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(discountService).isInstanceOf(DiscountService.class);
        assertThat(discountPrice).isEqualTo(1000);
    }

	//DiscountService는 Map으로 모든 DiscountPolicy를 주입 받는다. (fixDiscountPolicy, rateDiscountPolicy)
    static class DiscountService {
    	//map의 키에 스프링 빈의 이름을 넣어주고, 그 값으로 DiscountPolicy 타입으로 조회된 모든 스프링 빈을 담아준다.
        //만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map을 주입한다.
        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);
        }

		//discount()는 discountCode로 주입받을 스프링 빈의 이름을 받아서 해당 빈을 찾아서 실행한다.
        public int discount(Member member, int price, String discountCode) {
            DiscountPolicy discountPolicy = policyMap.get(discountCode);
            System.out.println("discountCode = " + discountCode);
            System.out.println("discountPolicy = " + discountPolicy);

        return discountPolicy.discount(member, price);
        }
    }
}

✅ 의존관계 주입의 자동 또는 수동의 올바른 실무 운영 기준

❓ 어떤 경우에 컴포넌트 스캔과 자동 주입을 사용해야 하고, 어떤 경우에 설정 정보를 통해 수동으로 빈을 등록하고, 의존관계도 수동으로 주입해야 할까?

스프링은 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다. 또한 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계되어 있다.
또한, 관리할 빈이 많아서 설정 정보가 커지면, 수동으로 관리하는 것 자체가 부담이 될 수 있다.
자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있으므로 일반적으로 자동 등록 및 주입을 사용하는 것이 편리하다.

수동 빈 등록이 필요한 경우

애플리케이션에는 크게 업무 로직과 기술 지원 로직으로 나눌 수 있다.
- 업무 로직 빈 : 컨트롤러, 비지니스 로직(서비스), Repository 등 비지니스 요구사항을 개발할 때 사용된다.
- 기술 지원 빈 : 기술적인 문제나 공통적인 관심사(AOP)를 처리할 때 주로 사용되며, 데이터베이스 연결이나 공통 로그 처리 등 업무 로직을 지원하기 위한 하부 또는 공통 기술들이다.
애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 설정 정보에 바로 나타나게 하는 것이 유지보수에 좋다.
다형성이 적극적으로 활용되는 부분에서는 수동 등록이나 같은 패키지에 묶어두어 어떤 빈들이 주입되는지 파악하기 쉽도록 하는 것이 좋다.

참고 Refernce

인프런 강의
https://catsbi.oopy.io/72475b41-f527-4e64-867c-7cbdc5a04d69

하루하루 꾸준히 포기하지 말고

이전 포스트

Spring Container(싱글톤 컨테이너)

다음 포스트