[Spring 핵심원리 기본편] 의존관계 자동 주입! ✨

 

7. 의존관계 자동 주입

 

스프링 기본 원리인 만큼 

정말 기본에 충실한 강의다. 

스프링으로 작업하고 싶다! 넘넘 재밌다 😖

 

---

다양한 의존관계 주입 방법

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

 

 

생성자 주입

생성자 호출할 때, @Autowired 있을 때, 의존관계를 주입 받는 방식
특징 : 생성자 호출시점에 딱 1번만 호출되는 것이 보장된다. 코드만 잘 짜면 이후 다시 호출되는 것을 막을 수 있다. 
불변, 필수 의존관계에 사용한다. 

 

🔥 중요! 생성자가 딱 1개만 있으면, @Autowired 를 생략해도 자동 주입이다. (물론 스프링 빈에만 해당된다)

@Component
//@RequiredArgsConstructor
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 주입)
setter 라고 불리는 필드의 값을 변경하는 수정자 메서드 
빈을 등록 후 -> 연관관계를 주입
특징 : 선택, 변경 가능성이 있는 의존관계를 사용하면 된다. (required = false) 

@Component
//@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService{

    private  MemberRepository memberRepository;
    private  DiscountPolicy discountPolicy;

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

    public void setDiscountPolicy(DiscountPolicy discountPolicy) {
        this.discountPolicy = discountPolicy;
    }
}

📝 참고
@Autowired 의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false) 로 지정하면 된다!

 

📝 참고
자바에서는 과거부터 필드의 값을 직접 변경하지 않고 set, get 메서드를 통해서 값을 읽거나 수정하였는데, 그것이 자바빈 프로퍼티 규약이다. 

 

필드 주입

이름 그대로 필드에 바로 주입하는 방식이다. 
코드가 간결해서 개발자들을 유혹하지만, 외부에서 변경이 불가해서 안좋다. 
DI 프레임워크 없으면 아무것도 할 수 없다. 
사용하지 말자....! 테스트 코드 정도로만 사용하자 

 

 

일반 메서드 주입

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

 

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

 

---

생성자 주입을 선택해야할 이유

 

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

 

🔥 불변

대부분의 의존관계는 변경할 일이 없다. 그러므로 생성자 주입이 최적의 선택이 된다.

 

🔥 누락 막기
프레임워크 없이 순수한 자바 코드를 단위 테스트 하는 경우

 

🔥 final 키워드

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

✨✨✨ 컴파일 오류는 세상에서 가장 빠르고, 좋은 오류다. 

생성자 주입은 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법이기도 하다. 항상 생성자 주입을 선택하고, 가끔 옵션이 필요할 때면 수정자 주입을 선택하자. 필드 주입은 사용하지 말자.

 

---

롬복과 최신 트렌드

위와 같은 과정도 번거로운 경우를 좀 더 편리하게 사용하도록 하는 것이 롬복이란 라이브러리다. 

롬복 라이브러리가 제공하는 @RequiredArgsConstructor 기능을 사용하면 final 이 붙은 필드를 모아서 생성자를 자동으로 생성해준다. 

 

최근에는 생성자를 딱 1개만 두고, @Autowired 를 생략하는 방법을 사용한다. 여기에 Lombok 라이브러리의 @RequiredArgsConstructor  를 함께 사용하면 기능은 다 제공하면서 코드는 깔끔하게 사용할 수 있다. 

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
}

 

✨ 롬복 라이브러리 적용 방법

//lombok 설정 추가 시작
configurations {
 compileOnly {
 extendsFrom annotationProcessor
 }
}
//lombok 설정 추가 끝

build.gradle 에 라이브러리 및 환경 추가

1. Preferences(윈도우 File Settings) plugin lombok 검색 설치 실행 (재시작)
2. Preferences Annotation Processors 검색 Enable annotation processing 체크 (재시작)
3. 임의의 테스트 클래스를 만들고 @Getter, @Setter 확인

 

---

@Autowired 필드 명, @Qualifier, @Primary

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

- @Autowired 의 필드명 매칭
- @Qualifier-> @Qualifier끼리 미챙 -> 빈 이름 매칭
- @Primary 사용

 

@Autowired 의 필드명 매칭

필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.

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

 

1. 타입 매칭

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

@Autowired
private DiscountPolicy rateDiscountPolicy

 

@Qualifier 사용

해당 애노테이션은 추가 구분자를 붙여주는 방법이다. (빈 이름을 변경하는 것은 아니다.)

 

1. @Qualifier 끼리 매칭

2. 빈 이름으로 매칭

3. NoSuchBeanDefinitionException 예외 발생

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

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

@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
	@Qualifier("mainDiscountPolicy") DiscountPolicy 
discountPolicy) {

    this.memberRepository = memberRepository;
 	this.discountPolicy = discountPolicy;
}

 

@Primary 사용

우선 순위를 정하는 방법이다. @Autowired 시에 여러 빈이 매칭되면 @Primary 가 우선권을 가진다. 

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

우선순위는 누구에게?
@Primary 는 기본값 처럼 동작하고, @Qualifier는 매우 상세하게 동작한다. 스프링은 자세한 것이 우선순위가 높다. 따라서 @Qualifier가 우선권이 높다.

 

---

애노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일시 타입 체크가 안된다. 
= 그래서 해보는 애노테이션 만들어보기 

 

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 {

}

 

직접 만든 애노테이션을 사용해보았다. 

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

 

애노테이션에는 상속이란 개념이 없다. 이렇게 여러 애노테이션을 모아 사용하는 기능은 스프링이 지원해주는 기능이다. 물론, 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의해서 사용하는 것은 유지보수에 혼란을 가중시킬 수 있다. 

 

---

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

특정 타입의 스프링 빈이 모두! 필요할 때가 있다. 예를 들어 클라이언트가 할인의 종류를 선택할 수 있다고 가정해보자. fix 할인 정책과 rate 할인 정책이 모두 필요할 때, 스프링을 사용하면 소위 말하는 전략 패턴을 매우 간단하게 구현할 수 있다.

 

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, "USER1", 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;
        
        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);

            System.out.println("discountCode = " + discountCode);
            System.out.println("discountPolicy = " + discountPolicy);
            
            return discountPolicy.discount(member, price);
        }
    }
}

 

로직 분석

DiscountService 는 Map 으로 모든 DiscountPolicy 를 주입 받는다. 이때, fix 정책과 rate 정책이 주입된다. 

discount() 메서드는 "할인 정책 코드" discountCode 로, fix 와 rate 할인 정책을 파라미터로 넘긴다. map 에서는 넘어온 discountCode 가 fixDiscountPolicy 라서 해당 스프링 빈을 찾아서 실행한다. 

 

주입 분석

Map <String, DiscountPolicy> : map 의 키에 스프링 빈의 이름을 넣어주고 , 그 값으로 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다. List 도 마찬가지로 실행된다. 

 

📝 참고 - 스프링 컨테이너를 생성하면서 스프링 빈 등록하기

new AnnotationConfigApplicationContext() 를 통해 스프링 컨테이너를 생성한다.

AutoAppConfig.class , DiscountService.class 를 파라미터로 넘기면서 해당 클래스를 자동으로 스프링 빈으로 등록한다.

new AnnotationConfigApplicationContext(AutoAppConfig.class,DiscountService.class);

 

---

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

✨ 편리한 자동 기능을 기본으로 사용하자. (뭘 만들지 말자)
스프링이 나오고 시간이 지날수록 점점 자동을 선호하는 추세이다. 

 

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

 

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

기술 지원 빈 : 기술적인 문제나 공통 관심사를 처리할 때 주로 사용된다. DB 연결이나 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다! 

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

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

빈은 파악하기 좋게 특정 패키지에 같이 묶어두는 것이 좋다! 
딱 보고 이해가 되어야한다!