의존관계 자동 주입

의존 관계 주입 4가지

1. 생성자 주입

2. 수정자 주입 (setter)

3. 필드 주입

4. 일반 메서드 주입

 

 

 

생성자 주입

• 이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법
• 특징
  • 생성자 호출시점에 딱 1번만 호출되는 것이 보장된다.
  • 불변, 필수 의존관계에 사용
  • 생성자가 딱 1개만 있으면 @Autowired를 제외 시킬수 있다.

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

 

 

 

수정자 주입 (setter 주입)

• setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법
• 특징
  • 선택, 변경 가능성이 있는 의존관계에 사용
  • 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.

  @Component
  public class OrderServiceImpl implements OrderService{
  
      private  MemberRepository memberRepository;
      private  DiscountPolicy discountPolicy;
  
      //선택 의존관계 설정
      @Autowired(required = false)
      public void setMemberRepository(MemberRepository memberRepository){
          System.out.println ( "memberRepository = " + memberRepository );
          this.memberRepository = memberRepository;
      }
  
      @Autowired
      public void setDiscountPolicy(DiscountPolicy discountPolicy){
          System.out.println ( "discountPolicy = " + discountPolicy );
          this.discountPolicy = discountPolicy;
      }
  
      public OrderServiceImpl(MemoryMemberRepository memberRepository, DiscountPolicy discountPolicy) {
          this.memberRepository = memberRepository;
          this.discountPolicy = discountPolicy;
      }
  

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

대부분이 생성자 주입을 사용하고 선택, 변경이 일어날꺼 같을때 수정자 주입을 사용한다

 

 

 

필드 주입

• 이름 그대로 필드에 바로 주입하는 방식이다
• 특징
  • 코드가 간결해서 많은 개발자들을 유혹하지만 외부에서 변경이 불가능해서 테스트 하기가 힘들다는 치명적인 단점이 있다
  • DI프레임워크가 없으면 아무것도 할 수 없다
  • 사용하지 말자!
    • 애플리케이션의 실제 코드와 관계 없는 테스트 코드
    • 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

@Component
public class OrderServiceImpl implements OrderService{

    @Autowired private MemberRepository memberRepository;
    @Autowired private DiscountPolicy discountPolicy;

 

일반 메서드 주입

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

@Component
public class OrderServiceImpl implements OrderService{

    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;

    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy){
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

    @Autowired
    public void init(MemberRepository memberRepository, DiscountPolicy discountPolicy){
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

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

 

 

옵션 처리

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

자동 주입 대상을 옵션으로 처리하는 방법은 3가지가 있다

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

public class AutowiredTest {

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

    static class TestBean {
				
				//호출 안됨
        @Autowired(required = false)
        public void setNoBean1(Member noBean1){
            System.out.println ( "noBean1 = " + noBean1 );
        }
        
				// null 호출
        @Autowired
        public void setNoBean2(@Nullable Member noBean2){
            System.out.println ( "noBean2 = " + noBean2 );
        }
			  
				// Optional.empty 호출
        @Autowired
        public void setNoBean3(Optional<Member> noBean3){
            System.out.println ( "noBean3 = " + noBean3 );
        }
    }
 }

 

 

 옵션 처리 (Bean Null 처리)

@AutoWired는 연결이 없는 경우나 연결할 Bean이 Null인 경우 아래와 같이 처리할 수 있다

Spring에서 @AutoWired에 옵션으로 required=false로 호출을 막을 수도 있고,

@Nullable을 통해서 익셉션을 막거나, 자바 8이상에서 Optional을 통해서도 처리할 수 있다.

package hello.core.autowired;

import hello.core.member.Member;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.lang.Nullable;

import java.util.Optional;

public class AutowiredTest {
    @Test
    void AutowiredOption(){
        ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);
    }
    static class TestBean{
        //호출 안됨
        @Autowired(required = false)
        public void setNoBean1(Member member) {
            System.out.println("setNoBean1 = " + member);
        }
        //null 호출
        @Autowired
        public void setNoBean2(@Nullable Member member) {
            System.out.println("setNoBean2 = " + member);
        }
        //Optional.empty 호출
        @Autowired(required = false)
        public void setNoBean3(Optional<Member> member) {
            System.out.println("setNoBean3 = " + member);
        }
    }


}

 

생성자 주입을 선택해라!

• 다양한 의존관계 주입방법중에서도 우리는 생성자 주입을 공격적으로 사용해야한다.
• 불변성 , 누락시 컴파일 에러, final 키워드를 통한 생성자 설정여부를 컴파일 시점에 확인 할 수 있다.
• 생성자 주입을 이용하면, 의존관계를 변경할 일이 없어지므로 좋다.
• 그러므로 위에 소개한 다양한 의존관계 주입법중 항상 생성자 주입을 적극 활용하자.
• 가끔 옵션이 필요한 경우에만 수정자 주입을 사용하고 그 외에 방법을 지양하자.

 

 

롬복과 최신 트랜드

• 백엔드 개발을 하다보면 컴포넌트가 대부분이 불편성을 가지므로 생성자 주입을 사용해야 한다.
• 그런데, 생성자 주입방법은  private final 필드를 만들어 생성자를 통해 주입 받도록 설정하는데 귀찮은 작업이다.
• 롬복 라이브러리가 제공하는@RequiredArgsConstructor 기능을 사용하면  final 이 붙은 필드를 모아서 생성자를 자동으로 만들어 준다.  (다음 코드에는 보이지 않지만 실제 호출 가능하다)
• 롬복 사용 전 (생성자가 하나이므로 @AutoWired가 생략된 상황임)

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

롬복 사용 후 

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

 

조회 빈이 2개 이상 - 문제

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

따라서 해당 타입의 선택된 빈이 2개 이상일 때 문제가 발생한다.

 

다음과 같이 DiscountPolicy 의 하위 타입인 FixDiscountPolicy , RateDiscountPolicy 둘다 스프링 빈으로 선언하고..

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

 

의존관계 자동 주입을 실행하면..

@Autowired
private DiscountPolicy discountPolicy

 

NoUniqueBeanDefinitionException 오류가 발생한다.

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

 

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

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

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

@Autowired 필드 명, @Qualifier, @Primary

조회 대상 빈이 2개 이상일 때 해결 방법은 다음과 같다.

• @Autowired 필드 명 매칭
• @Qualifier 사용
• @Primary 사용

 

1. @Autowired 필드 명 매칭

@Autowired 는 타입 매칭을 시도하고

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

 

변경 전

@Autowired
private DiscountPolicy discountPolicy

 

변경 후

@Autowired
private DiscountPolicy rateDiscountPolicy

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

구현 객체에 의존하는 모습을 보이니 좋은 방법은 아닌듯하다.

2. @Qualifier 사용

@Qualifier 는 추가 구분자를 붙여주는 방법이다.

주입시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다.

 

빈 등록시 @Qualifier를 붙여준다.

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

 

주입시에 @Qualifier를 붙여주고 주입해줄 빈의 추가 구분자를 붙여준다.

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

위 코드는 생성자 자동 주입 예시이며, 수정자 자동 주입에도 동일하게 사용하면된다.

 

직접 빈 등록시

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

사실 직접 빈 등록시에는 구현 객체를 리턴값에 적어주는데 @Qualifier 가 과연 쓰일지 의문이 든다.

3. @Primary 사용

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

 

다음 코드는 rateDiscountPolicy 가 우선권을 가진다.

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

 

여기까지 보면 @Primary 와 @Qualifier 중에 어떤 것을 사용하면 좋을지 고민이 될 것이다.

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

반면에 @Primary 를 사용하면 @Qualifier 를 붙일 필요가 없다.

매우 간단하다!

4. @Primary, @Qualifier 활용

• 코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고, 코드에서 특별한 기능 으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해보자.
• 메인 데이터베이스의 커넥션을 획득하는 스프링 빈은 @Primary 를 적용해서 조회하는 곳에서 @Qualifier 지정 없이 편리하게 조회하고, 서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifier 를 지정해서 명시적으로 획 득 하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있다.
• 물론 이때 메인 데이터베이스의 스프링 빈을 등록할 때 @Qualifier 를 지정해주는 것은 상관없다.

5. @Primary, @Qualifier 우선순위

@Primary 는 기본값 처럼 동작하는 것이고, @Qualifier 는 매우 상세하게 동작한다.

이런 경우 어떤 것이 우선권을 가져갈까?

스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다. 따라서 여기서도 @Qualifier 가 우선권이 높다.

애노테이션 직접 만들기

@Qualifier("mainDiscountPolicy") 이렇게 문자를 적으면 컴파일시 타입 체크가 안된다.

예를 들어 mainDiscountPolicy 를 mainnDiscountPolicy로 적어도 컴파일시 문제가 없다. 그러나 정상적으로 동작하지 않는다.

이런 오류를 다음과 같은 애노테이션을 만들어 문제를 해결할 수 있다.

@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

의도적으로 정말 해당 타입의 스프링 빈이 다 필요한 경우도 있다.

예를 들어서 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정해보자.

스프링을 사용하면 소위 말하는 전략 패턴을 매우 간단하게 구현할 수 있다.

 

public class AllBeanTest {

    @Test
    void findAllBean() {
        //given
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);
        DiscountService discountService = ac.getBean(DiscountService.class);
        Member member = new Member(1L, "memberA", Grade.VIP);

        //when
        int fixDiscountPrice = discountService.discount(member, 10000, "fixDiscountPolicy");
        int rateDiscountPrice = discountService.discount(member, 20000, "rateDiscountPolicy");

        //then
        Assertions.assertThat(fixDiscountPrice).isEqualTo(1000);
        Assertions.assertThat(rateDiscountPrice).isEqualTo(2000);
    }

    static class DiscountService{
        private final Map<String, DiscountPolicy> policyMap;
        private final List<DiscountPolicy> policyList;

        public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policyList) {
            this.policyMap = policyMap;
            this.policyList = policyList;
        }

        public int discount(Member member, int price, String discountCode) {
            DiscountPolicy discountPolicy = policyMap.get(discountCode);
            return discountPolicy.discount(member, price);
        }
    }
}

 

로직 분석

• DiscountService는 Map으로 모든 DiscountPolicy 를 주입받는다. 이때 fixDiscountPolicy , rateDiscountPolicy 가 주입된다.
• discount() 메서드는 discountCode로 fixDiscountPolicy 가 넘어오면 map에서 fixDiscountPolicy 스프링 빈을 찾아서 실행한다. 물론 rateDiscountPolicy 가 넘어오면 rateDiscountPolicy 스프링 빈을 찾아서 실행한다.

주입 분석

• Map<String, DiscountPolicy> : map의 키에 스프링 빈의 이름을 넣어주고, 그 값으로 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
• List<DiscountPolicy> : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다. 만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map을 주입한다.

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

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

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

결론부터 이야기하면, 스프링이 나오고 시간이 갈 수록 점점 자동을 선호하는 추세다. 스프링은 @Component 뿐만 아니라 @Controller , @Service , @Repository 처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원한다.

거기에 더해서 최근 스프링 부트는 컴포넌트 스캔을 기본으로 사용하고, 스프링 부트의 다양한 스프링 빈들도 조건이 맞으면 자동으로 등록하도록 설계했다.

설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작하는 부분을 명확하게 나누는 것이 이상적이지만, 개발자 입장에서 스프링 빈을 하나 등록할 때 @Component 만 넣어주면 끝나는 일을 @Configuration 설정 정보에 가서 @Bean 을 적고, 객체를 생성하고, 주입할 대상을 일일이 적어주는 과정은 상당히 번거롭다.

또한 관리할 빈이 많아서 설정 정보가 커지면 설정 정보를 관리하는 것 자체가 부담이 된다.

그리고 결정적으로 자동 빈 등록을 사용해도 OCP, DIP를 지킬 수 있다.

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

1) 기술 지원 빈을 등록할때 사용

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

 

업무 로직 빈

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

기술 지원 빈

• 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용된다. 데이터베이스 연결이나, 공 통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.

 

업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리 처럼 어느정도 유사한 패 턴이 있다. 이런 경우 자동 기능을 적극 사용하는 것이 좋다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생 했는지 명확하게 파악하기 쉽다.

 

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

 

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

2) 비즈니스 로직 중에서 다형성을 적극 활용할 때

의존관계 자동 주입 - 조회한 빈이 모두 필요할 때, List, Map을 다시 보자.

수동 빈으로 등록하거나 또는 자동으로하면 특정 패키지에 같이 묶어두는게 좋다. 핵심은 딱 보고 이해되는 것이 중요하다.

 

이 부분을 별도의 설정 정보로 만들고 수동으로 등록하면 다음과 같다.

@Configuration
public class DiscountPolicyConfig {
    @Bean
    public DiscountPolicy rateDiscountPolicy() {
    return new RateDiscountPolicy();
    }

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

이 설정 정보만 봐도 한눈에 빈의 이름은 물론이고, 어떤 빈들이 주입될지 파악할 수 있다.

그래도 빈 자동 등록을 사용하고 싶으면 파악하기 좋게 DiscountPolicy 의 구현 빈들만 따로 모아서 특정 패키지에 모아두자.

 

참고

---

 

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

 

 

GitHub - highright96/spring-core: 스프링 핵심 원리 - 기본편