[SpringBoot] 스프링 핵심 원리 섹션 7 - 2 | 생성자 주입 | 롬복 | 조회 빈이 2개 이상일 때 | 애노테이션 직접 생성

  본 포스팅은 인프런 김영한 강사님의 스프링 부트 핵심 원리 강의 섹션 7을 수강하고 배운 점을 정리했습니다.

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

 

1. 옵션 처리 : 주입할 빈이 없는 경우

주입할 스프링 빈이 없어도 동작해야 할 때가 있다. 그런데 @Autowired 만 사용하면 required 옵션의 기본값이 true로 되어 있어서 자동 주입 대상이 없으면 오류가 발생한다.

 

자동 주입 대상을 옵션으로 처리하는 방법

1️⃣ @Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨

2️⃣ org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력된다.

3️⃣ Optional<> : 자동 주입할 대상이 없으면 Optional.empty 가 입력된다.

 

적용한 코드 

public class AutowiredTest {

    @Test
    void AutowiredOption(){
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);
    }

    static class TestBean{
    
    	// [1]
        @Autowired(required = false)
        public void setBean1(Member noBean1){
            System.out.println("noBean1 = " + noBean1);
        }

	// [2]
        @Autowired
        public void setBean2(@Nullable Member noBean2){
            System.out.println("noBean2 = " + noBean2);
        }

	// [3]
        @Autowired
        public void setBean3(Optional<Member> noBean3){
            System.out.println("noBean3 = " + noBean3);
        }

    }
}

 

테스트 출력 결과

결과 설명: 1️⃣@Autowired(required=false)는 매서드 자체가 호출이 안되므로 출력값이 나오지 않고 나머지 2️⃣,3️⃣에 대해서는 null과 empty가 출력된다.

---

2. 생성자 주입을 선택해야 하는 이유

과거에는 수정자 주입과 필드 주입을 많이 사용했지만, 최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다. 그 이유는 다음과 같다.

 

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

 

수정자 의존관계인 경우: 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;
    }
    
    ...

 

테스트 코드

@Test
void createOrder() {
     OrderServiceImpl orderService = new OrderServiceImpl();
     orderService.createOrder(1L, "itemA", 10000);
}

 

테스트 결과

에러 발생: memberRepository, discountPolicy 모두 의존관계 주입이 누락되었기 때문이다.

테스트 수행할 때까지 알 수 없는 에러라 실행해야지만 오류 부분을 확인할 수 있음.

 

➡️ 생성자 주입으로 수정하면 주입 데이터를 누락했을 때 컴파일 오류가 발생한다. 테스트 전에 미리 놓친 부분 파악 가능

 

final 키워드

생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있는데, 이는 생성자에서 혹시라도 값이 설정되지 않은 필드가 있는지 컴파일 시점에서 오류를 확인할 수 있다. 

✅ 여러 의존 관계 주입 방식 중 오직 생성자 주입 방식만 final 키워드를 사용할 수 있다.

 

생성자 의존 관계 주입으로 수정하고 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;
    }
    
    ...

잘 보면 생성자에서 필수 필드인 discountPolicy에 값을 설정해야 하는데, 이 부분을 주석 처리한 채로 테스트를 실행할 경우 자바는 컴파일 시점에 다음 오류를 발생시킨다.

java: variable discountPolicy might not have been initialized

 

🗝️ 정리

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

---

3. 롬복과 최신 트렌드

생성자 의존 주입을 구현하기 위해서는 생성자도 만들어야 하고, 주입받은 값을 대입하는 코드도 만들어야 하고..

필드 주입처럼 편리하게 사용하는 방법이 없을까? ➡️ 롬복(LomBok)

 

1️⃣build.gradle에 롬복 추가

configurations와 dependencies를 추가해 주고 코끼리 refresh 버튼을 눌러 필요한 라이브러리를 설치해 준다.

 

2️⃣ 롬복 플러그인 설치

File ➡️ Settings ➡️ Plugins에서 Lombok을 설치한다.

 

3️⃣Annotation Processing을 활성화시켜 준다. 

 'File ➡️ Settings ➡️ Build, Execution, Deployment ➡️ Compiler ➡️ Annotation Processors'에서  위의 빨간 부분을 활성화시켜 준다.

 

모든 준비는 마쳤다. 롬복을 사용한 예제 코드를 만들어보자.

@Getter
@Setter
@ToString
public class HelloLombok {

    private String name;
    private int age;

    public static void main(String[] args){
        HelloLombok helloLombok = new HelloLombok();
        helloLombok.setName("LOMBOK");

        System.out.println("helloLombok toString = " + helloLombok);
    }
}

롬복을 설치하면 @Getter 애노테이션과 @Setter 애노테이션을 붙이는 것만으로도 각 필드를 수정하고 출력하는 Getter, Setter가 자동으로 생성된다. 또한 @ToString 애노테이션을 붙이면 콘솔 출력으로 객체 정보를 출력할 수 있는 ToString 함수도 직접 구현하지 않고도 사용할 수 있다.  

 

ToString을 콘솔 출력한 모습

---

 

이제 생성자에도 적용해 보자

 

기본 코드

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

@RequiredArgsConstructor 애노테이션을 사용하면 분명 생성자를 만들지 않았는데 롬복이 자바의 애노테이션 프로세서라는 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성해 준다.

또한 생성자가 하나면 @Autowired를 생략할 수 있다.

 

이렇게 롬복을 사용하면 필요한 기능은 다 제공받으면서 코드는 깔끔하게 사용할 수 있다.

---

4.  조회 빈이 2개 이상인 경우

DiscountPolicy의 하위 타입인 FixDiscountPolicy , RateDiscountPolicy 둘 다 스프링 빈으로 선언해 보자.

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

 

그리고 의존 관계 자동 주입을 실행하면 아래와 같은 오류가 발생한다.

오류 메시지: 하나의 빈을 기대했는데 fixDiscountPolicy , rateDiscountPolicy 2개가 발견되었다고 한다.

 

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

그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 안 된다.
스프링 빈을 수동 등록해서 문제를 해결해도 되지만, 의존 관계 자동 주입에서 해결하는 여러 방법이 있다.

---

해결 방법 1️⃣: @Autowired 필드 명 매칭

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

 

기존 코드

@Autowired
private DiscountPolicy discountPolicy

 

필드 명을 빈 이름으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy

필드 명이 rateDiscountPolicy 이므로 정상 주입된다

 

➡️필드 명 매칭은 먼저 타입 매칭을 시도하고 그 결과에 여러 빈이 있을 때 추가로 동작하는 기능이다.

 

 

해결 방법 2️⃣: @Qualifier 사용

각 할인 정책에 @Qualifier로 서로 다른 이름을 붙여준다.

 

@Qualifier("FixDiscountPolicy")

 

@Qualifier("mainDiscountPolicy")

 

두 개의 할인 정책 중 "mainDiscountPolicy"로 등록된 할인 정책 스프링 빈을 찾는다. 

@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy")DiscountPolicy discountPolicy) {
	this.discountPolicy = discountPolicy;
}

 

 

@Qualifier로 주입할 때 @Qualifier("mainDiscountPolicy")를 못 찾으면 어떻게 될까?

➡️그러면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다. 하지만 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는 게 명확하고 좋다.

---

 

해결 방법 3️⃣: @Primary로 우선순위 정하기

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

 

rateDiscountPolicy 가 우선권을 가지도록 하자.

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

 

코드를 실행해 보면 문제없이 @Primary 가 잘 동작하는 것을 확인할 수 있다.

 

 

@Qualifier와 @Primary 비교

 @Qualifier의 단점은 주입받을 때 다음과 같이 모든 코드에 @Qualifier를 붙여주어야 한다는 점이다.

하지만 @Qualifier는 @Primary보다 우선순위가 높다. 그러므로 두 개를 함께 적절하게 사용하는 것이 좋다.

---

5. 애노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일 시 타입 체크가 안된다. 다음과 같은 애노테이션을 만들어서 문제를 해결할 수 있다.

 

@interface MainDiscountPolicy

package hello.core.annotation;
import org.springframework.beans.factory.annotation.Qualifier;
import java.lang.annotation.*;
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}

 

이렇게 애노테이션을 직접 구현해 두면 @Qualifier 괄호에 오타가 났을 때 자동으로 빨간 줄이 그어져 확인할 수 있다.

이렇게 애노테이션을 직접 구현하는 것은 이미 존재하는 애노테이션에 대해서도 직접 코드로 구현할 수 있을 만큼 매우 유연하지만 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의 하는 것은 유지보수에 더 혼란만 가중할 수 있다.

---

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

의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우도 있다. 예를 들어서 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정해 보자. 이는 List와 Map 자료구조를 사용해서 간단히 구현할 수 있다.

 

테스트 코드

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 rateDiscountPrice = discountService.discount(member, 20000, "rateDiscountPolicy");
        assertThat(rateDiscountPrice).isEqualTo(2000);
    }

    static class DiscountService{
        private final Map<String, hello.core.discount.DiscountPolicy> policyMap;
        private final List<DiscountPolicy> policies;

        @Autowired
        public DiscountService(Map<String, hello.core.discount.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);
            System.out.println("discountCode = " + discountCode);
            System.out.println("discountPolicy = " + discountPolicy);
            return discountPolicy.discount(member, price);
        }
    }
}

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

🔎List <DiscountPolicy> : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.

🔎만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map을 주입한다.

 

등록된 빈이 없을 경우 위와 같이 비어있는 맵과 리스트를 확인할 수 있다.

 

 

테스트 결과: policyMap과 policies(List)에 빈이 담겨있는 모습을 콘솔에서 확인할 수 있다.

 

 

The End.