Spring 의존관계 자동 주입

다양한 의존관계 주입 방법

의존관계 주입은 크게 다음과 같이 4가지가 있다.

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

생성자 주입

• 이름 그대로 생성자를 통해서 의존관계를 주입 받는 방식이다.
• 생성자 호출 시점에 딱 1번만 호출되는 것이 보장된다.
• 불변, 필수 의존 관계에 사용된다.

생성자 주입

참고
✓ 생성자가 딱 1개만 있으면 @Autowired 를 생략해도 자동 주입이 된다. (스프링 빈에만 해당)
✓ 생성자에선 null 값을 허용하지 않기 때문에 불변 및 필수 관계에 있어 사용한다. (자바 컨벤션)
✓ 생성자 주입은 해당 빈을 등록(생성)하는 단계에서 생성자가 호출되기에 해당 과정에서 의존 관계 주입이 된다. (자바 코드 생성자 호출)

 

수정자 주입

• Setter 라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법이다.
• 선택, 변경 가능성이 있는 의존관계에 사용 (required = false, 외부에서 호출하여 저장 - 거의 없는 경우)
• 자바 빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.

수정자 주입

[참고 사항]
※ @Autowired 의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false) 로 지정하면 된다.
※ 자바 빈 프로퍼티, 자바에서는 과거부터 필드의 값을 직접 변경하지 않고, setXxx, getXxx 라는 메서드를 통해서 값을 읽거나 수정하는 규칙을 만들었는데, 그것이 자바빈 프로퍼티 규약이다. 더 자세한 내용이 궁금하면 자바빈 프로퍼티로 검색해보자.

스프링 컨테이너 주요한 2가지 라이프 사이클 빈 생성, 의존 관계 주입(의존 관계 설정 단계)
Setter 수정자의 경우 생성 단계를 거쳐 2번째 의존 주입 설정 단계에서 주입 받는다.
생성자 주입은 빈을 생성하는 단계에서 의존 관계 주입도 같이 발생한다.

 

필드 주입

• 이름 그대로 필드에 바로 주입하는 방법이다.
• 코드가 간결해서 많은 개발자들을 유혹하지만 외부에서 변경이 불가능해서 테스트하기 힘들다는 치명적인 단점이 있다.
• DI 프레임워크가 없으면 아무것도 할 수 없다. (순수 자바로 된 테스트 코드 작성시 작동하지 않는다. - 결과적으로 수정자가 필요함)

필드 주입

※ 주의 사항
사용하지 말자. 단 사용한다면 다음 2가지 경우에만 사용하는 것을 추천한다.
- 애플리케이션의 실제 코드와 관계 없는 테스트 코드 (@SpringBootTest 등)
- 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

 

일반 메서드 주입

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

일반 메서드 주입

의존 관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다.
스프링 빈이 아닌 다른 클래스에서 @Autowired 어노테이션을 사용하여도 아무 기능도 동작하지 않는다.

 

옵션 처리

주입할 스프링 빈이 없어도 동작해야할 때가 있다.

그런데 @Autowired 만 사용하면 required 옵션이 기본값으로 true 로 되어 있어서 자동 주입 대상이 없으면 오류가 발생한다.

 

자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다.

• @Autowired( required = false ) - 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됌
• org.springframework.lang.@Nullable - 자동 주입할 대상이 없으면 null 이 주입된다.
• Optional<> - 자동 주입할 대상이 없으면 "Optional.empty" 가 입력된다.

옵션 처리 예시 테스트

옵션 처리 테스트 결과

1번의 경우 의존 관계 빈이 없기 때문에 호출 자체가 되지 않았다.
2번의 경우 자동 주입할 대상이 없기 때문에 null 이 출력 되었다.
3번의 경우 자동 주입할 대상이 없기 때문에 Opional.emtpy 가 출려 되었다.

 

생성자 주입을 사용해야하는 이유

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

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

< final 키워드 >
생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있다. 따라서, 생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에 막아준다.
"컴파일 오류는 세상에서 가장 빠르고, 좋은 오류이다!"

프레임워크 없이 순수한 자바 코드를 단위 테스트 하는 경우에 다음과 같이 수정자 의존관계인 경우 런타임 오류가 발생(NPE)하지만, 생성자 주입을 사용하면 해당 자바 클래스를 생성하는 과정에서 컴파일 오류를 발생시켜 의존 관계가 필요함을 명확하게 알 수 있다. 이 뿐만 아니라, 자바의 final 키워드를 사용할 수 있다. final 을 사용하게 되면 개발자의 실수로 누락하게 되는 경우 컴파일 오류를 통해 문제점을 빠르게 확인할 수 있다.

생성자 주입을 사용하는 이유 정리

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

※ 항상 생성자 주입을 선택하자, 그리고 가끔 옵션이 필요하면 수정자 주입을 선택하여 해결하자. (필드 주입은 되도록 사용하지 말자)

 

조회 빈이 2개 이상인 경우

@Autowired 는 타입(Type) 으로 조회한다.

타입으로 조회하기 때문에, 마치 다음 코드와 유사하게 동작한다. (실제로는 더 많은 기능 제공)

applicationContext.getBean(DiscountPolicy.class)

스프링 빈 조회해서 학습했듯이 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다.

NoUniqueBeanDefinitionException 발생

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

그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 안된다.

스프링 빈을 수동 등록해서 문제를 해결해도 되지만, 의존관계 자동 주입에서 해결하는 여러 방법이 존재한다.

 

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

• @Autowired 필드 명 매칭
• @Qulifier → @Qulifier 끼리 매칭 → 빈 이름 매칭
• @Primary 사용

@Autowired 필드 명 매칭

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

 

예시) DiscountPolicy 인터페이스 구현하는 구현체 두개가 있고 모두 빈으로 등록된 경우 (RateDiscountPolicy, FixDiscountPolicy)

파라미터 명으로 빈 이름 매칭

필드 명으로 빈 이름 매칭

@Qulifier 사용

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

빈 등록시 @Qulifier 사용

빈 조회시 @Qulifier 사용

@Qulifier 사용은 생성자 뿐만 아니라 수정자 메서드, 필드에도 사용 가능하다.

만약, @Qulifier 로 주입할 때 @Qulifier("mainDiscountPolicy") 를 못 찾으면 어떻게 될까?
그런 경우 mainDiscountPolicy 라는 이름의 스프링 빈을 추가로 찾는다.
하지만 @Qulifier 는 @Qulifier 를 찾는 용도로만 사용하는게 명확하고 좋다.

@Qulifier 정리

• @Qulifier 끼리 매칭
• 빈 이름 매칭
• NoSuchBeanDefinitionException 예외 발생

 

@Primary 사용

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

빈 등록 시 @Primary 선언

@Primary, @Qulifier 의 활용
✓ @Qulifier 는 등록과 호출 시에 반드시 @Qulifier 를 모두 작성되어있어야 한다. 반면에, @Primary의 경우 등록시 기재하면 기본적으로 동작한다.
✓ 스프링은 자동보다는 수동이, 넓은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다. 따라서 여기서도 @Qulifier 가 @Primary 보다 우선 순위가 높다.

 

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

기본적으론 편리한 자동 기능을 기본으로 사용하자

스프링 부트가 자동으로 등록하는 수 많은 빈들은 해당 부분에 대한 이해를 잘하고 스프링이 의도한대로 잘 사용하는 게 중요하다.

ex) DataSource

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

• 업무 로직 빈 - 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포리토리 등
  • 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경된다.
  • 이런 경우는 자동 기능을 적극적으로 사용

단, 비즈니스 로직 중에서 다형성을 적극 활용할 때에는 수동 등록하거나,
자동 등록 시 특정 패키지에 같이 묶어 관리하면 유지보수에 좋다. ex) List, Map

수동 빈 활용 사례 - 다형성

• 기술 지원 빈 - 기술적인 문제나 공통 관심사를 처리할 때 주로 사용된다.
  • DB 연결이나, 공통 로그 처리와 같이 업무 로직을 지원하기 위한 하부 기술이나 공통 기술
  • 보통 애플리케이션 전반에 거쳐 광범위하게 영향

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

※ 자동 빈이든, 수동 빈이든 가장 중요한 핵심은 딱 보고 의도가 잘 이해되어야 한다는 점이다.

 

정리

• 편리한 자동 기능을 기본으로 사용하자.
• 직접 등록하는 기술 지원 객체는 수동 등록 (명확하게 의도가 보일 수 있도록)
• 다형성을 적극 활용하는 비즈니스 로직은 수동 등록을 고민해보자.

 

참고

• 해당 게시글은 김영한님의 스프링 핵심 원리 - 기본편을 바탕으로 작성되었습니다.