[Spring] 의존관계 자동 주입

출처 :  김영한님의 스프링 핵심 원리 - 기본편 인프런 강의

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

 

다양한 의존관계 주입 방법

 

1. 생성자 주입

지금까지 했던 방법으로 생성자에 @Autowired를 붙여 의존관계를 주입하는 방법이다. 생성자 호출 시점에 딱 1번만 호출되는 것이 보장되고 불변, 필수 의존관계에서 사용한다.

 

생성자 호출 시점에 모든 연관 관계 그림을 다 만들고 끝내놓으려는 의도 -> 공연 전 배우 미리 다 캐스팅해둔다. 배우는 무조건 있어야 하고(필수) 바뀌어선 안된다(불변).

• 불변 : 처음 1번 호출될 때를 제외하고 그 다음부터는 이 값을 바꿀 수 없도록 막아준다
• 필수 : private final 값이라서 생성자로 들어오는 값이 무조건 필수적으로 있어야 한다. 

생성자가 단 하나인 경우엔 @Autowired를 생략 가능!

 

 

 

2. 수정자 주입 (setter 주입)

자바빈 프로퍼티 규약의 수정자 메서드(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;
    }
}

스프링 컨테이너는 크게 2가지 라이프 사이클이 있다. 

1. 스프링 빈 등록
2. 연관관계 자동주입

생성자 주입이 일어나는 시기는 스프링 컨테이너가 new로 OrderServiceImpl을 등록할 때 생성자이기 때문에 어쩔 수 없이 호출하게 되어서 1단계인 스프링 빈 등록 시에 발생한다.

반면 수정자 주입은 의존관계 2단계인 연관관계 자동 주입 시에 일어난다. 

 

 

@Autowired의 기본 동작은 주입할 대상이 없으면 오류가 발생하는데 이를 방지하려면 required 설정을 false로 해주면 된다.

@Autowired(required = false)

 

 

3. 필드 주입

필드에 바로 주입하는 방법

• private에도 가능
• 직관적이고 간결해서 편하지만 외부에서 변경이 불가능해 테스트가 어려움
• 외부에서 변경하려면 또 setter를 만들어줘야함;; 이럴바엔 setter 주입을 쓰지..;;;
• DI 프레임워크가 없으면 말짱 도루묵이므로 사용하지 말자
  • 순수한 자바 테스트 코드에는 당연히 @Autowired가 동작하지 않고 스프링에서 실행해줘야만 동작한다.

 

 

4. 일반 메서드 주입

일반 메서드를 통해서 주입받는 방법으로 한번에 여러 필드를 주입 받을 수 있지만 거의 사용 안한다. 

setter 주입과 비슷한 타이밍에 의존관계를 주입해준다.

 

참고로 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다. 스프링 빈이 아닌 Member에서 @Autowired를 적용해도 주입해주려고 찾아봐도 등록된 게 없으니 동작하지 않는게 당연!

 

옵션처리

스프링 빈 등록을 안해서 주입할 빈이 없더라도 기본 로직으로 동작하게 하려면 옵션처리를 해야한다.

• @Aoutowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 호출 X
  • Member은 스프링 빈이 아니라서 호출 X
• @Nullable : 자동 주입할 대상이 없으면 Null
• Optional<> : 자동 주입할 대상이 없으면 Optional.empty
  • required 속성이 false인 경우 대상 빈이 존재하지 않으면 메서드를 호출하지 않는데 Optional은 empty 상태로 존재하기 때문에 호출된다.

 

@Autowired(required = false)
public void setNoBean1(Member noBean1) {
    System.out.println("noBean1 = " + noBean1);
}

@Autowired
public void setNoBean2(@Nullable Member noBean2) {
    System.out.println("noBean2 = " + noBean2);
}

@Autowired(required = false)
public void setNoBean3(Optional<Member> noBean3) {
    System.out.println("noBean3 = " + noBean3);
}

[실행 결과]

 

생성자 주입을 선택하라

스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 원한다.

 

불변

• 의존관계 주입은 한번 일어나면 종료시점까지 불변해야 한다.
• 수정자 주입은 public으로 변경할 수 있도록 열어둬야 한다.
• 딱 1번 호출 후 호출될 일이 없어서 변할 일도 없다.

 

누락

프레임워크 없이 순수한 자바 코드로 단위 테스트를 할 때 setter 주입을 사용하면 가짜 객체라도 만들어서 넣어줘야 테스트가 가능하다. 테스트를 짜는 입장에서 코드를 까보기 전까지 생성자 주입인지 세터 주입인지 알 수가 없어서 실수로 누락하는 경우가 많이 생긴다.

 

그런데 생성자 주입을 사용할 경우 final 키워드를 넣을 수 있어서 외부에서 수정하는 것을 막을 수 있고, 누락이 발생했을 경우 컴파일 에러로 쉽게 인지할 수 있도록 해준다. 

 

바로 IDE에서 어떤 값을 필수로 주입해야 하는지 컴파일 오류를 통해 알 수 있어서 누락에 대처가 가능해진다.

 

이렇게 바로 알 수 있다! 너무 좋다! 순수한 자바 언어의 특징으로 컴파일 에러 내기!

항상 생성자 주입을 선택하고 가끔 필수 값이 아닌 경우에 옵션이 필요하면 수정자 주입을 선택하자!

 

참고로 수정자 주입을 포함한 나머지 주입은 모두 생성자 이후에 호출되므로 필드에 fianl 키워드를 사용할 수 없다.

 

 

롬복과 최신 트랜드

반복되는 기존의 의존관계 자동 주입 코드를 롬복 라이브러리의 어노테이션으로 최적화할 수 있다.

 

롬복 라이브러리 추가

1. build.gradle 추가

...

configurations {
	compileOnly {
	extendsFrom annotationProcessor
	}
}


...

dependencies {
	...

	compileOnly 'org.projectlombok:lombok'
	annotationProcessor 'org.projectlombok:lombok'
	testCompileOnly 'org.projectlombok:lombok'
	testAnnotationProcessor 'org.projectlombok:lombok'
	
	...
 }
}

...

 

2. File -> Settings -> plugin -> lombok  설치

3. Preferences -> Annotation Processors 검색 -> Enable annotation processing 체크

 

 

 

롬복 적용

@RequiredArgsConstructor 기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다.

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

 

롬복이 자바의 애노테이션 프로세서라는 기능을 이용해 컴파일 시점에 생성자 코드를 자동으로 생성해준다.

 

최근에는 생성자를 1개 두고 @Autowired를 생략+ @RequiredArgsConstructor로 최적화한다.

 

 

조회 빈이 2개 이상인 경우

이전에도 말했듯이 @Autowired는 타입으로 조회하기 때문에 .getBean(xxx.class)와 유사하게 동작한다. 하지만 타입으로 조회하면 같은 타입의 빈이 2개 이상일 때 문제가 발생한다.

 

둘 다 등록이 되어 있는 상태에서 의존관계 자동 주입을 실행하면 친절하게도 NoUniqueBeanDefinitionException 오류를 발생시켜주고, 하나의 빈을 기대했는데 fixDiscountPolicy , rateDiscountPolicy 2개가 발견되었다고 알려준다.

 

그럼 하위 타입으로 정확하게 자동 주입을 실행하면 되지 않을까? 

되기는 하지만, 구체적인 하위 타입을 의존하면 DIP를 위반하게 된다. 또 여러가지 문제가 생긴다.

 

의존관계 자동 주입에서 해결하는 방법을 알아보자

 

1. @Autowired 필드 명

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

@Autowired
// private DiscountPolicy discountPolicy;
private DiscountPolicy rateDiscountPolicy;

스프링은 먼저 타입 매칭을 시도하고 타입 매칭의 결과가 2개 이상일 때 같은 타입이거나 또는 그 타입의 자식들을 다 끌고와서 필드명 or 파라미터명으로 주입해준다.

 

2. @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("mainDiscountPolicy")를 찾지 못하면 mainDiscountPolicy라는 스프링 빈을 추가로 찾는 기능이 있긴 하지만 @Qualifier는 @Qualifier와 짝지어 짝을 찾는 용도로만 사용하는 것이 좋다.

 

이때 매칭되는 빈도 없다면 NoSuchBeanDefinitionException 예외가 발생한다.

3. @Primary

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

 

그럼, @Primary와 @Qualifier중에 어떤 것을 사용하면 좋을까?

@Qualifier의 단점은 주입 받을 때 모든 코드에 @Qualifier를 붙여줘야 하는 점이다. 

 

@Primary vs @Qualifier

코드에서 자주 사용하는 메인 DB의 커넥션을 획득하는 스프링 빈은 @Primary를 통해 @Qualifier 붙여야 하는 번거로움 없이 편리하게 조회하고 서브 DB 커넥션 빈을 선택할 때에는 @Qualifier를 지정해 명시적으로 획득하도록 하는 방법이 권장된다.

 

@Primary는 기본값처럼 자동으로 동작하고 @Qualifier은 매우 상세하게 수동으로 동작하기 때문에 스프링에서는 자동보다 수동이 우선권을 가진다. 

 

애노테이션 직접 만들기

@Qualifier("xxxx")는 "xxxx" 문자를 적어서 매칭을 하는 것이기 때문에 컴파일 시 타입 체크가 안된다. 문자열이기에 잘못 작성해도 컴파일시 타입 체크가 안돼서 컴파일이 잡을 수가 없다.

 

애노테이션을 새로 만들어서 해결하자 

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

}

@MainDiscountPolicy을 주입해줄 빈에 붙여주면 컴파일이 잡을 수 있게 된다.

 

 

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

의도적으로 여러개의 빈이 모두 필요한 경우가 있는데 (ex: 할인정책을 클라이언트가 선택) 이럴 때엔 List, Map 타입을 이용한다.

 

 

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

스프링이 나오고 점점 편리한 자동 기능을 기본으로 사용하는 추세다. 

 

그렇다면 수동 빈 등록은 언제 사용할까?

애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나뉜다.

• 업무 로직 빈 : 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리 등으로 보통 비즈니스 요구사항을 개발할 때 추가/변경 된다.
• 기술 지원 빈 : 기술적인 문제가 공통 관심사(AOP)를 처리할 때 사용된다. DB 연결이나 공통 로그 처리처럼 업무 로직을 지원하는 하부 기술들이다. 

업무 로직은 매우 많고 반복되는 작업이 많아서 자동 기능을 적극 사용하는 것이 좋고, 기술 로직은 수가 적고 광범위한 영향을 미치기 때문에 수동 빈 등록으로 설정 정보에 바로 명확하게 들어나게 하는 것이 유지보수하기 좋다. 

 

비즈니스 로직 중에서 다형성을 적극 활용할 때 (DiscountPolicy가 의존관계 자동 주입으로 Map<String, DiscountPolicy> 주입받는 상황) 자동 등록을 사용하고 있기 때문에 여러 코드들 까봐야 한다. 이런 경우 수동 빈으로 등록해서 명확하게 표시하거나 자동으로 할거면 특정 패키지에 같이 묶어두어 딱 보고 이해할 수 있도록 설계하는 것이 좋다. 

 

• 자동

• 수동

@Configuration
public class DiscountPolicyConfig {

    @Bean
    public DiscountPolicy rateDiscountPolicy() {
        return new RateDiscountPolicy();
    }
    @Bean
    public DiscountPolicy fixDiscountPolicy() {
        return new FixDiscountPolicy();
    }
    
}

 

참고로 스프링, 스프링 부트가 자동으로 등록하는 수많은 빈들은 예외이다. 이런 것들은 스프링의 의도대로 사용해야 한다. 스프링 부트의 경우 DataSource같은 DB 연결에 사용하는 기술 지원 로직까지 내부에서 자동으로 등록하는 데 이런 부분은 메뉴얼을 잘 참고해 사용하면 된다. 

 

반면 내가 만든 기술 지원 객체는 수동으로 명확하게 드러내서 빈으로 등록하자