[스프링 핵심 원리] 07. 의존관계 자동 주입

다양한 의존관계 주입 방법

크게 4가지 방법이 있음

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

생성자 주입

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

이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법이다. 지금까지 우리가 진행했던 방법이 바로 생성자 주입이다.

 

특징

• 생성자 호출시점에 딱 1번만 호출되는 것이 보장
• 불변, 필수 의존관계에 사용
• 중요! 생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입 된다. java 물론 스프링 빈에만 해당

 

수정자 주입(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;
        }
 }

setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법이다.

 

특징

• 선택, 변경 가능성이 있는 의존관계에 사용
• 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법

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

 

 

자바빈 프로퍼티, 자바에서는 과거부터 필드의 값을 변경하지 않고, setXxx, getXxx 라는 메서드를 통해서 값을 읽거나 수정하는 규칙을 만들었는데, 그것이 자바빈 프로퍼티 규약이다. 더 자세한 내용이 궁금하면 자바빈 프로퍼티로 검색해보자

class Data {
     private int age;
     public void setAge(int age) {
     this.age = age;
      }
     public int getAge() {
     return age;
      }
 }

 

필드 주입

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

이름 그대로 필드에 바로 주입하는 방법

특징 코드가 간결해서 많은 개발자들을 유혹하지만 외부에서 변경이 불가능해서 테스트 하기 힘들다는 치명적인 단점이 있다.

DI 프레임워크가 없으면 아무것도 할 수 없다.

사용하지 말자!

• 애플리케이션의 실제 코드와 관계 없는 테스트 코드
• 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

참고로 순수한 자바 테스트 코드에는 당연히 @Autowired가 동작하지 않는다.  @SpringBootTest 처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능하며 다음 코드와 같이 @Bean 에서 파라미터에 의존관계는 자동 주입된다. 수동 등록시 자동 등록된 빈의 의존관계가 필요할 때 문제를 해결 가능

 @Bean
     OrderService orderService(MemberRepository memberRepoisitory, DiscountPolicy 
    discountPolicy) {
     return new OrderServiceImpl(memberRepository, discountPolicy);
 }

 

일반 메서드 주입

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

일반 메서드를 통해서 주입 받을 수 있다.

특징

• 한번에 여러 필드를 주입
• 일반적으로 잘 사용하지 않음

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

 

 

옵션 처리

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

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

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

참고로 @Nullable, Optional은 스프링 전반에 걸쳐서 지원된다. 예를 들어서 생성자 자동 주입에서 특정 필드에만 사용!

 

생성자 주입을 선택

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

불변 

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

누락

프레임워크 없이 순수한 자바 코드로 단위 테스트 하는 경우에 수정자 의존관계인 경우 프레임워크 안에 동작시 의존 관계가 없으면 오류가 발생하지만, 프레임워크 없이 순수한 자바 코드로만 단위 테스트를 수행

 

그러나 생성자 주입을 사용하면 주입 데이터 누락시 컴파일 오류가 발생

 

final키워드를 생성자에 사용하게 되면 값이 설정되지 않는 오류를 막아줌

 

참고로 수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출되므로, 필드에 final 키워드를 사용이 불가능 하다. 오직 생성자 주입 방식만 final키워드 사용 가능

 

정리하자면

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

 

생성자 주입과 수정자 주입을 동시에 사용할 수 있다. 항상 생성자 주입을 선택해라! 그리고 가끔 옵션이 필요하면 수정자 주입을 선택해라. 필드 주입은 사용하지 않는게 좋음!!

 

롬복과 최신 트랜드

막상 개발을 해보면, 대부분이 다 불변이고, 그래서 다음과 같이 필드에 final 키워드를 사용하게 됨

그런데 생성자도 만들어야 하고, 주입 받은 값을 대입하는 코드도 만들어야 하고… 필드 주입처럼 좀 편리하게 사용하는 방법은 없을까? 역시 개발자는 귀찮은 것은 못 참는다!

 

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

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

 

이 최종결과 코드와 이전의 코드는 완전히 동일하며  롬복이 자바의 애노테이션 프로세서라는 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성

 

실제 class를 열어보면 다음 코드가 추가되어 있는 것을 확인 가능

 

정리하자면

 

최근에는 생성자를 딱 1개만 두고 @Autowired를생략하는 방법을 주로 사용 여기에 Lombok 라이브러리의 @RequiredArgsConstructor 함께 사용시 기능은 다 제공하며 코드는 깔끔하게 사용이 가능

 

조회 빈이 2개 이상 - 문제

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

@Autowired
private DiscountPolicy discountPolicy

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

 ac.getBean(DiscountPolicy.class)

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

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

 

 @Component
 public class FixDiscountPolicy implements DiscountPolicy {}

 @Component
 public class RateDiscountPolicy implements DiscountPolicy {}

 

그리고 이렇게 의존관계 자동 주입을 실행하면

 

NoUniqueBeanDefinitionException 오류가 발생

NoUniqueBeanDefinitionException: No qualifying bean of type 
'hello.core.discount.DiscountPolicy' available: expected single matching bean
but found 2: fixDiscountPolicy,rateDiscountPolicy

 

오류메시지가 친절하게도 하나의 빈을 기대했는데 었다고 알려준다. fixDiscountPolicy , rateDiscountPolicy 2개가 발견

 

이때 하위 타입으로 지정할 수 도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어짐 그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때 해결이 불가 스프링 빈을 수동 등록해서 문제를 해결해도 되지만, 의존 관계 자동 주입에서 해결하는 여러 방법이 있다.

 

@Autowired 필드명, @Qualifier, @Primary

해결 방법을 하나씩 알아보자

 

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

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

@Autowired 필드 명 매칭

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

 

기존코드

@Autowired
 private DiscountPolicy discountPolicy

 

필드 명을 빈 이름으로 변경

@Autowired
 private DiscountPolicy rateDiscountPolicy

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

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

 

@Autowired 매칭 정리

1. 타입 매칭

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

 

 

@Qualifier 사용

@Qualifier는 추가 구분자를 붙여주는 방법으로 주입시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아님

 

빈 등록시 @Qualifier를 붙임

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

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

주입시에 @Qualifier를 붙여주고 등록한 이름을 적어줌

 

생성자 자동 주입 예시

 @Autowired
 public OrderServiceImpl(MemberRepository memberRepository,
                            @Qualifier("mainDiscountPolicy") DiscountPolicy 
    discountPolicy) {
     this.memberRepository = memberRepository;
     this.discountPolicy = discountPolicy;
 }

 

수정자 자동 주입 예시

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

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

 

 

다음과 같이 직접 빈 등록시에도 @Qualifier를 동일하게 사용이 가능

 @Bean
 @Qualifier("mainDiscountPolicy")
     public DiscountPolicy discountPolicy() {
     return new ...
 }

 

정리하자면 

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

 

@Primary 사용 

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

 

@Primary, @Qualifier 활용

코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고, 코드에서  특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보면

 

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

 

물론 이때 메인 데이터베이스의 스프링 빈을 등록할 때 @Qualifier를 지정해주는 것은 상관없음

 

우선순위

@Primary는 기본값 처럼 동작하는 것이고, @Qualifier는 매우 상세하게 동작 이런 경우 어떤 것이 우선권을 가지는걸까? 

스프링은 자동보다는 수동이 넓은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높음

따라서 여기서도 @Qualifier가 우선권이 높음

 

 

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

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

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

 

결론부터 이야기하면, 스프링이 나오고 시간이 갈 수록 점점 자동을 선호하는 추세.

스프링은 @Component뿐만 아니라 @Controller, @Service, @Repository처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원하며 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계

 

설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 이상적이지만, 개발자 입장에서 스프링 빈을 하나 등록 시 @Component만 넣어주면 끝나는 일을 @configuration 설정 정보에 가서 @Bean을 적고, 객체를 생성하고, 주입할 대상을 일일이 적어주는 과정은 상당히 번거로우며 또 관리할 빈이 많아서 설정 정보를 커지면 설정 정보를 관리하는 것 자체가 부담이 된다고 하며 결정적으로 자동 빈을 사용해도 OCP, DIP를 지킴!!

 

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

 

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

 

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

업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패턴이 있는데 이런 경우 자동 기능을 적극 사용하는 것이 좋음!!

 

보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉬우며 기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미침

 

그리고 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 잘 드러나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많아서 이런 기술 지원 로직들은 가급적 수동 빈 등 록을 사용해서 명확하게 드러내는 것이 좋음!

 

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

 

참고로 스프링과 스프링 부트가 자동으로 등록하는 수 많은 빈들은 예외다.

스프링의 의도대로 잘 사용하는게 중요하며  스프링 부트의 경우 다. 이런 부분들은 스프링 자체를 잘 이해하고

DataSource 같은 데이터베이스 연결에 사용하는 기술 지원 로직까지 내부에서 자동으로 등록하는데,  이런 부분은 메뉴얼을 잘 참고해서 스프링 부트가 의도한 대로 편리하 게 사용하면 됨!

 

반면에 스프링 부트가 아니라 내가 직접 기술 지원 객체를 스프링 빈으로 등록한다면 수동으로 등록해서 명확하게 드러내는 것이 좋음

 

정리하자면

편리한 자동 기능을 기본으로 사용하며 직접 등록하는 기술 지원 객체는 수동으로 등록하자 

다형성을 적극 활용하는 비즈니스 로직은 수등 등록을 고민해보자