지난 글에서 @Autowired를 사용할 때 같은 타입으로 조회되는 빈이 2개인 경우 오류가 발생했었다. 

 

@Autowired 로 빈을 자동으로 주입할 때, 특정한 빈을 지정해주는 방법이 무엇인지 알아보자

 


 

 

 

조회 대상 빈이 2개 이상일 때 해결 방법은 크게 3가지가 있다. 

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

 

 

1.  @Autowired 필드명 매칭

 

: @Autowired 는 먼저 타입으로 빈을 찾고, 찾은 빈이 여러개라면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다. 

 

 

기존코드

@Autowired
private  final DiscountPolicy   discountPolicy;

 

필드명을 빈 이름으로 변경 

@Autowired
private  final DiscountPolicy rateDiscountPolicy;

 

다음코드와 같이 필드명을 주입받고자 하는 빈 이름으로 변경하면,

@Autowired가 타입으로 조회 후 rateDiscountPolicy와 fixDiscountPolicy 라는 2개의 빈을 찾고 나서 

필드 이름으로 추가 매칭하여 우리가 원하는 rateDiscountPolicy를 자동으로 주입해주게 된다. 

 

 

 

다시한번 테스트 코드를 수행하여 의존 관계가 자동으로 잘 주입되었는지 확인해보자

  • 위의 설명에서는 필드 주입 방식으로 했지만, 우리의 코드는 생성자 주입 방식을 이용하고 있으므로
  • 파라미터의 이름을 주입받고자하는 빈의 이름으로 바꿔주자

 

수정된 OrderServiceImpl 코드

@Component
public class OrderServiceImpl implements OrderService{

      private  final MemberRepository memberRepository;
      private  final DiscountPolicy   discountPolicy;

      @Autowired
      public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy rateDiscountPolicy) {

        this.memberRepository = memberRepository;
        this.discountPolicy = rateDiscountPolicy;

    }

 

 

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

 

※ 참고 : 참고로 나는 필드명으로 주입 받는 코드를 짜도 주입이 안되는 오류가 발생했다.. 그래서 그냥  @Qualifier을 사용하여 테스트를 성공했지만 일단 이런 방법도 있다는 것을 알아두자

같은 오류가 발생한다면 아래의 질문 글을 참고해보자
인프런- 필드명으로 의존 관계 주입 받을때 발생하는 오류

 

 

 

 

2. Qualifier 사용 

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

 

빈 등록시 @Qualifier을 붙여준다

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

 

 

주입시 @ Qualifier을 붙여주고 등록한 이름을 적어준다 

@Component
public class OrderServiceImpl implements OrderService{

      private  final MemberRepository memberRepository;
      private  final DiscountPolicy   discountPolicy;

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

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

    }

 

 

 

그런데,   @Qualifier  로 주입할 때 @Qualifier("mainDiscountPolicy") 를 못찾으면 어떻게 될까?

그러면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다.

 

 

하지만 @Qualifier은 @Qualifier을 찾는 용도로만 사용하는게 명확하고 좋다.

괜히 등록한 이름의 빈도 찾으니까.. 라며 생각하지말고  @Qualifier로 등록한 값이 들어가는 경우만 생각하자는 뜻이다. 

 

 

다음과 같이 직접 빈 등록시에도 @Qualifier를 동일하게 사용할 수 있다.

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

 

 

3. @Primary

@Primary는 우선수위를 정하는 방법이다. @Autowired로 여러개의 빈이 조회되었을 때 @Primary 가 우선권을 가진다.

 

rateDiscountPolicy가 우선권을 가지도록 하자.

@Component
@Primary 
public class RateDiscountPolicy implements DiscountPolicy {} 

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

 

OrderServiceImpl 코드

@Component
public class OrderServiceImpl implements OrderService{

      private  final MemberRepository memberRepository;
      private  final DiscountPolicy   discountPolicy;

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

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

    }

 

 

이후에 테스트를 수행하면 discountPolicy의 값으로 RateDiscountPloicy가 잘 들어갔음을 알 수 있다. 

discountPolicy = hello.core.discount.RateDiscountPolicy@76a36b71

 

 

 


 

 

 

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

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

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

 

반면에 @Primary를 사용한다면 우선권을 주고 싶은 클래스에만 어노테이션을 추가해주면 된다. 

 

 

 

@Primary, @Qualifier 활용

 

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

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

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

 

 

우선순위

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

이런 경우 어떤 것이 우선권을 가져갈까? 스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다. 따라서 여기서도 @Qualifier 가 우선권이 높다.

 

 

@Autowired는 타입으로 빈을 조회한다. 

 @Autowired
 private DiscountPolicy discountPolicy

 

타입으로 빈을 조회하기 때문에 마치 다음과 유사하게 동작한다 ( 실제로는 더 많은 기능이 있다 ) 

 ac.getBean(DiscountPolicy.class)

 

 

그런데, 빈 조회에서 공부했듯이 같은 타입의 빈이 2개이상 조회되는 경우 문제가 발생한다.

 

 

DiscountPolicy는  RateDiscountPolicy 와 FixDisCountPolicy 라는 두 개의 구체화 클래스가 있었다. 

 

이전에는 컴포넌트 스캔의 대상으로  RateDiscountPolicy  만 등록해줬지만,

FixDisCountPolicy에 @Component를 추가해서 컴포넌트 스캔의 대상으로 만들어주자. 

 

 

그리고 나서 의존 관계 자동 주입을 실행하면 

 @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

 

 

오류 메세지를 읽어보니 하나의 빈을 기대했는데  DiscountPolicy 타입이 2개가 조회되어서 어떤 빈을 줘야하는지 구분을 못하겠다고 한다. 

 

 

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

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

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

 

 


 

 

다음글에서 의존 관계 자동 주입시 조회되는 빈이 2개 이상일때 해결 방법에 대해서 알아보자 

 

 

 

 

의존 관계 주입을 자동으로 해줄 때 생성자 주입이 좋긴 하지만 코드가 많다...

생성자의 값을 설정해주는 코드를 넣어줘야하므로!

 

필드 주입의 경우 필드에 어노테이션 하나만 붙이면 끝인데.... 

 

 

생성자 주입을 필드 주입처럼 편리하게 사용하는 방법이 없을까?

 

롬복을 이용하자 

 

 

 

 


 

롬복 라이브러리 적용 방법 

 

build.gradle에 코드 추가하기 

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

 

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    //lombok 라이브러리 추가 시작
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'
    testCompileOnly 'org.projectlombok:lombok'
    testAnnotationProcessor 'org.projectlombok:lombok'
    //lombok 라이브러리 추가 끝
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

 

 

build.gradle 전체 코드

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.2.2'
    id 'io.spring.dependency-management' version '1.1.4'
}

group = 'hello'
version = '0.0.1-SNAPSHOT'
java {
    sourceCompatibility = '17'
}

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




repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    //lombok 라이브러리 추가 시작
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'
    testCompileOnly 'org.projectlombok:lombok'
    testAnnotationProcessor 'org.projectlombok:lombok'
    //lombok 라이브러리 추가 끝
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

/*
tasks.named('test') {
    useJUnitPlatform()
}
*/

 

 

 

  1. External Libraries 에서 lombok 있는지 확인 

 

 

 

 

2. Preferences(윈도우 File Settings)>  plugin > lombok 검색 설치 실행 (재시작)

 

 

 

3. Preferences >  Annotation Processors 검색 Enable annotation processing 체크 (재시작)

 

 

4. 임의의 테스트 클래스를 만들고 @Getter, @Setter 확인

 

package hello.core;

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class HelloLombok {

    private String name;
    private int age;

    public static void main(String[] args) {
        
        HelloLombok helloLombok = new HelloLombok();
        helloLombok.setAge(10);
        int age1 = helloLombok.getAge();
        System.out.println("age1 = " + age1);

    }
}

 

 

원래 자바는 우리가 직접 getter와 setter메서드를 만들어줘야했다.

하지만 롬복의 @Getter, @Setter 를 이용한다면 메서드 없어도 알아서 만들어주므로 

코드가 깔끔해진다. 

 

이것들 이외에도 생성자와 관련한 것들도 있고 종류가 굉장히 많다! 

 

앞으로는 롬복을 사용해서 코드를 좀 더 간결하게 작성해보자


 

 

 

OrderServiceImpl 기존 코드

@Component
public class OrderServiceImpl implements OrderService{

      private  final MemberRepository memberRepository;
      private  final DiscountPolicy   discountPolicy;
      
     // @Autowired 
      public OrderServiceImpl(MemberRepository memberRepository,@Qualifier("rateDiscountPolicy") DiscountPolicy discountPolicy) {

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

 

  • 생성자가 하나면 @Autowired를 생략해도 된다. 
  • 이제 여기에 롬복을 적용시켜보자 

 

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService{

      private  final MemberRepository memberRepository;
      private  final DiscountPolicy   discountPolicy;

   }

 

  • @RequiredArgsConstructor : 필수로 값을 넣어줘야하는 객체(final로 설정된 필드)를 모아 생성자를 만들어준다.
  • OrderServiceImpl에서 final로 설정된 것은 memberRepository, discountPolicy
  • 따라서 이 두 값을 매개변수로 하는 생성자를 알아서 만들어준다
  • 즉, @Autowired로 필드에 직접 주입을 받는 것과 같은 것이다 ( 물론 생성자를 이용해서!! ) 

 

결국 ,  저렇게 긴 코드가 어노테이션 하나와 같은 것이다. 

 

@RequiredArgsConstructor
public OrderServiceImpl(MemberRepository memberRepository,@Qualifier("rateDiscountPolicy") DiscountPolicy discountPolicy) {

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

 

 

이 최종결과 코드와 이전의 코드는 완전히 동일하다. 롬복이 자바의 애노테이션 프로세서라는 기능을 이용해서 컴파일 시점에 생성자 코드를 자동으로 생성해준다. 실제 java class를 열어보면 다음 코드가 추가되어 있는 것을 확인할 수 있다.

 

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

 

 

 


 

 

 

 

의존관계를 주입하는 방식은 크게 4가지나 있는데 왜 생성자 주입을 쓰라고 하는 걸까? 

 

생성자 주입이 어떤 점에서 좋은지 자세히 알아보자. 

 

 

 

 

 

 

 생성자 주입 방식의 장점

 

 

 

 

 

 

 

 

먼저 OrderserviceImpl을 수정자 주입 방식으로 만들어보자. 

 

OrderServiceImpl

@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;
       }
       
     @Override
      public Order createOrder(Long memberId, String itemName, int itemPrice) {

        Member findMember = memberRepository.findById(memberId);
        
        // 할인과 관련된 부분은 disCountPolicy에 위임
        int discountPrice = discountPolicy.discount(findMember, itemPrice);

        return new Order(memberId,itemName,itemPrice,discountPrice);

    }
    
    }

 

 

OderServiceImplTest

class OrderServiceImplTest {

    @Test
    void createOrder(){

        OrderServiceImpl orderService = new OrderServiceImpl();
        orderService.createOrder(1L, "itemA", 10000);
    }

}

 

NullPointerException: 
Cannot invoke "hello.core.member.MemberRepository.findById(java.lang.Long)" 
because "this.memberRepository" is null

 

 

 

테스트를 실행시키니 memberRepository의 값이 없다는 오류가 발생했다. 

 

그 이유는 OrderServiceImpl의 createOrder는 memberRepository가 필요하다. 

테스트 코드에서 우리가 setMemberRepository 를 통해 memberRepository의 값을 설정해주지 않았기 때문에 memberRepository의 값이 없어서 NPE오류가 발생한 것이다. 

 

이 경우  setMemberRepository를 호출하여 memberRepository의 값을 준다면 오류가 해결될 것이다. 

 

 

( 수정자 주입을 이용해서 테스트 코드를 작성한다면, 객체를 생성할 때, 의존 관계가 있다면 이 값도 함께 설정해줘야해서 조금 번거롭다 ) 

 

 

 

 

But,   테스트 코드만 보고서는 OrderServiceImpl가 어떤 의존관계가 있는지 알 수 없다. 

그래서 우리는 해당 클래스의 의존 관계를 파악하기 위해서  직접 OrderServiceImpl의 코드를 읽어보고 필요한 객체의 값을 setter로 설정해줘야한다. 

 

물론,  지금처럼 오류 코드를 보고 OrderServiceImpl의 의존 관계를 파악하여 우리가 직접 설정해줘도 괜찮지만,

 

매번 이렇게 테스트 코드를 작성할 때 마다 해당 클래스가 어떤 의존관계를 가지고 있는지 코드를 뒤져보고 값을 설정해주기는 힘들다 

 

그래서 생성자 주입을 이용하는 것이 편리하다고 하는 것이다!! 

 

 

 

그렇다면, 생성자 주입을 이용하면 구체적으로 어떤 점이 좋은지 알아보자 

 


 

 

 

OrderServiceImpl의 의존관계 주입 방식을 생성자 주입 방식으로 바꿔서 테스트를 작성해보자.

 

OrderServiceImpl

@Component
public class OrderServiceImpl implements OrderService{

      private  final MemberRepository memberRepository;
      private  final DiscountPolicy   discountPolicy;

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

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

 

 

OderServiceImplTest

class OrderServiceImplTest {

    @Test
    void createOrder(){

        MemberRepository memberRepository= new MemoryMemberRepository();
        memberRepository.save(new Member(1L,"오리", Grade.VIP));

        OrderServiceImpl orderService = new OrderServiceImpl(new MemoryMemberRepository(),new FixDiscountPolicy());
        orderService.createOrder(1L, "itemA", 10000);
    }

}

 

OrderServiceImpl orderService= new OrderServiceImpl(new MemoryMemberRepository(),new FixDiscountPolicy());

 

 

먼저 생성자 주입을 이용한다면, 생성자를 호출하는 과정에서 매개변수로 설정된 의존 관계에 있는 객체들의 값을   

반드시 넣어줘야한다. 

만약 값을 넣지 않는다면 바로 컴파일 오류가 발생해서 값을 넣어주라는 문구가 나온다. 

  • 그렇기 때문에 컴파일 시점에 오류를 잡아낼 수 있다. 
  • 그리고 해당 객체를 생성할 때 어떤 객체와 의존 관계에 있는지 테스트 코드만을 보더라도 파악이 가능하다. 
  • 또한, 매개변수에 값을 전달할 때 임의로 객체를 설정해서 넣어줄 수 있기 때문에 변경과 테스트에 편리하는 장점이 있다. 

 

 

그리고 생성자 주입을 이용하면 필드에 final 키워드를 사용할 수 있다. 

  • 그래서 생성자에서 혹시라도 값이 설정되지 않은 오류를 컴파일 시점에 막아준다. 
  • 또한, final 키워드를 사용하면 값을 직접 설정해주거나 생성자를 통해서만 값을 설정해 줄 수 있기 때문에 한번 객체를 주입 받으면 그 값이 변하지 않으므로 객체의 값이 불변이다. 

 

 

 

정리

왜 생성자 주입을 이용해야하는가?

 

 대부분의 애플리케이션이 종료될 때 까지 의존관계를 변경할 일이 없다

  • 생성자 주입을 이용할 경우, 처음 세팅해놓고 바꿀 수없으므로 좋음 -> "불변" 
  • 생성자 주입은 객체를 생성할 때 1번만 호출 되므로 불변하게 설계할 수 있다.
    • 수정자 주입의 경우에는 변경 가능성이 있다
    • 필드 주입은 스프링이 없다면 테스트 코드에서는 의존 객체의 값을 넣어줄 수가 없다. ( = DI 컨테이너에 의존적이다 ) 
  • 순수한 자바 코드로 테스트를 생성시, 생성자를 호출하기 위해 임의의 객체를 만들어줘야하므로 의존 관계를  파악하기 좋고, 내가 원하는 것으로 대체 할 수 있다는 장점이 있다
  • final 키워드를 사용할 수 있다는 것
    생성자에서만 값을 넣어줄 수 있기 때문에 한번 값을 주입해주고 나면 객체가 바뀌지 않는다
    또한 final 키워드를 사용하면 생성자를 만들때 값을 초기화 해주는 코드를 반드시 작성해야하므로 만약 코드가 누락 되었다면 컴파일 오류가 발생한다.

 

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

 

 

 

▶  생성자 주입을 이용하자 

 

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

예를 들어 주입 받을 객체가 세개인데 하나의 값은 주입 받지 못하더라도 메서드는 실행될 수 있도록 하고자 할 때가 있다. 

 

그런데 @Autowired를 사용하면  기본값이  required의 값이 true로 설정되어있기 때문에 값이 없으면 오류가 발생한다. 

 

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

  • @Autowired(required=false) 
  • @Nuallable
  • Optional< >

 

테스트 코드를 통해서 위의 옵션들에 따라 어떻게 동작하는지 알아보자

 

public class AutowiredTest {

    @Test
    void autowiredTest() {

        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
        public void setNoBean3(Optional<Member> member) {
            System.out.println("setNoBean3 = " + member);
        }

    }
}

 

//실행결과
setNoBean2 = null
setNoBean3 = Optional.empty

 

 

Member는 스프링이 관리하는 빈이 아니다. 그런데 @Autowired로 객체를 주입받으려고 하고 있다. 

따라서 그냥 @Autowired를 사용한다면 주입해줄 객체가 없으므로 오류가 발생한다. 

 

 Error creating bean with name 'autowiredTest.TestBean': 
 Unsatisfied dependency expressed through method 'setNoBean1' parameter 0: 
 No qualifying bean of type 'hello.core.member.Member' available: 
 expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {}

 

그래서 우리는 이렇게 주입 받을 객체가 없더라도 오류가 발생하지 않도록 옵션을 설정하는 세가지 방식을 적용해서 테스트 코드를 수행해보는 것이다. 

 

  •  @Autowired ( required=false) 로 설정하는 경우
    true인 경우에는 값이 반드시 들어와야하지만, false로 설정한 경우에는 값이 들어오지 않는다면 메서드 자체가 실행되지 않는다. 그래서 실행결과에서 setBean1의 메서드가 실행되지 않은 것을 알 수 있다. 
  • @Nullable
    주입 받을 객체에 @Nullable를 사용하는 경우, 주입 받는 객체가 없다면 null값을 반환해준다. 
  • Optional< > 
    주입 받을 객체를 Optional로 감싸면 널값이 들어오는경우 Optional.empty 가 출력된다. 

 

 

 

 

 

 

의존관계 주입은 크게 4가지 방법이 있다.

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

 

 

1. 생성자 주입

생성자 주입이란 생성자를 통해 의존관계를 주입받는 방법이다.

지금까지 이용한 방식이 생성자 주입 방식이다.

 

  • 컴포넌트 스캔을 통해 빈을 등록할 때 @Autowired 어노테이션을 통해 스프링 컨테이너에서 의존 관계에 있는 객체를 자동으로 주입 시켜준다.
  • 생성자 주입은 불변,필수 의존관계에 사용함
  • 생성자 호출시 딱 1번만 호출되는것이 보장된다. 
             불변:  한번 호출해서 관계를 주입해주면 값이 바뀌지 않으므로 '불변'이다.

             필수:  private final .... 로 설정 -> 무조건 값이 있어야함 
  • 생성자가 하나일때는 @Autowired를 생략해도 된다.
    하지만 생성자가 두개라면 어떤 생성자를 호출해서 의존관계를 주입해줘야하는지 모르기 때문에 @Autowired를 지정해줘야한다. 


 @Component
 public class OrderServiceImpl implements OrderService {
 
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
    
    @Autowired// 생성자가 1개 -> 생략가능
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
             this.memberRepository = memberRepository;
             this.discountPolicy = discountPolicy;
    }
 }


스프링 컨테이너의 사이클은 2단계이다. 처음에 빈을 등록하고, 이후에 @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;
    }

 

  • 선택, 변경가능성이 있는 의존관계에 사용
  • @Autowired 를 보고 setter메서드를 통해 의존관계를 주입
  • 따라서 생성자를 먼저 실행하고, setter메서드를 호출함
※ 참고  @Autowired 의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false) 로 지정하면 된다.

 

 

3. 필드 주입

필드에 의존관계를 곧바로 주입받는 방법 

@Component
public class OrderServiceImpl implements OrderService{

    @Autowired  private  MemberRepository memberRepository;
    @Autowired  private  DiscountPolicy discountPolicy;
  • 코드가 매우 간결하지만, 외부에서 변경이 불가능해서 테스트 작성이 어렵다
  • 사용하지 말자! 

 

※ 참고: 순수한 자바 테스트 코드에는 당연히 @Autowired가 동작하지 않는다. 컨테이너를 테스트에 통합한 경우에만 가능하다.

 

 

Q. 외부에서 변경이 불가능 하다? 

 

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

 

 

다음 코드와 같이 @Bean 에서 파라미터에 의존관계는 자동 주입된다. 

하지만 필드 주입을 사용하는 경우 @Autowired로 스프링을 통해 의존관계를 주입 받는 방법 말고는 의존성을 주입 받을 방법이 없다.  만약 주입 받고 싶다면 각각의 setter를 만들어주면 되는데 이러면 setter 주입과 다를 것이 없다. 

또한  테스트를 위해 memberRepository를 다른 것으로 바꾸고자 하더라도  바꿀 수가 없다. 

 

  • SpringBootTest에서 테스트를 하면됨 : 스프링부트테스트 클래스는 스프링 부트를 띄워서 테스트 하기 때문에

 

4. 일반 메서드 주입

  • 의존 관계를 주입 받는 방식으로 메서드를 이용하는 것이다.
  • 한번에 여러 필드를 주입 받을 수 있다.
  • 잘 사용하지는 않는다
@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;
  }
  
    }

 

컴포넌트 스캔을 하는데 같은 이름의 빈을 등록하면 어떻게 될까? 

 

이런 경우는 두가지 경우가 있다.

  1. 컴포넌트 스캔 vs 컴포넌트 스캔  : 충돌하는 빈들이 모두 컴포넌트 스캔 대상인 경우 
  2. 수동 빈 등록 vs 컴포넌트 스캔 :  컴포넌트 스캔한 빈과 직접 등록해준 빈의 이름이 같은 경우 

 

 

1.  컴포넌트 스캔 vs 컴포넌트 스캔 

: 컴포넌트 스캔으로 등록했는데 같은 이름의 빈을 또다시 컴포넌트 스캔으로 등록하려는 경우 

 

@Component("service")
public class MemberServiceImpl implements MemberService {

 

@Component("service")
public class OrderServiceImpl implements OrderService{

 

두 클래스를 service라는 같은 이름의 빈으로 설정하고 컴포넌트 스캔을 할 경우, 

ConflictingBeanDefinitionException 예외가 발생한다. 

 

 

2.  수동 빈 등록 vs 컴포넌트 스캔

: 설정 클래스에서 직접 등록한 빈의 이름과, 컴포넌트의 스캔 대상중에 동일한 이름이 있는 경우

 

 

@Component // memoryMemberRepository로 등록됨
public class MemoryMemberRepository implements MemberRepository{
public class AutoAppConfig {

    @Bean(name="memoryMemberRepository")
    public MemberRepository memberRepository(){
        return new MemoryMemberRepository(); 
    }
    
}

 

MemoryMemberRepository의 경우 이미 @Component 이므로 memoryMemberRepository라는 이름으로 컨테이너에 등록될 것이다. 

그런데 만약 설정 클래스에서 똑같은 이름의 빈을 등록해주면 어떻게 될까? 

 

 

public class AutoAppConfigTest {

    @Test
    @DisplayName("컴포넌트 스캔해서 스프링 빈 등록하기")
    void basicScan(){

        AnnotationConfigApplicationContext ac =
                new AnnotationConfigApplicationContext(AutoAppConfig.class);

        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);

    }
}

 

 

 

테스트 실행 결과 테스트가 성공했다. 

분명히 같은 이름의 빈이 두개 인데 왜 테스트에 성공한 것일까? 

 

로그를 읽어보면 이런 문구가 나온다. 

 Overriding bean definition for bean 'memoryMemberRepository' with a different definition: 
 replacing[Generic bean: class [hello.core.member.MemoryMemberRepository]

 

즉, 수동 빈이 등록 우선권을 가진다.

( 수동빈이 자동빈을 오버라이딩 했다) 

 

물론 개발자가 의도적으로 이런 결과를 기대했다면, 자동 보다는 수동이 우선권을 가지는 것이 좋다. 하지만 현실은 개 발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다는 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대 부분이다! 그러면 정말 잡기 어려운 버그가 만들어진다. 항상 잡기 어려운 버그는 애매한 버그다.

 

 

그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

 

 

 

2-1. 수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러

스프링 부트인 CoreApplication을 실행해보면 오류를 볼 수 있다.

 

***************************
APPLICATION FAILED TO START
***************************

Description:

The bean 'memoryMemberRepository', defined in class path resource [hello/core/AutoAppConfig.class], could not be registered.
A bean with that name has already been defined in file [...\hello\core\member\MemoryMemberRepository.class]
and overriding is disabled.

Action:

Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true

 

스프링 부트는 현재 오버라이딩이 불가하기 때문에 빈을 등록할 수 없다고 한다. 

 

따라서 오버라이딩 기능을 사용하고 싶다면 아래 코드를 추가하라고 한다. 

 

 spring.main.allow-bean-definition-overriding=true

 

 

이 코드를 application.properties에 추가하고 스프링 부트를 재실행 한 결과 

 

Overriding bean definition for bean 'memoryMemberRepository' with a different definition: 
replacing [Generic bean: class [hello.core.member.MemoryMemberRepository]

 

오버라이딩이 성공했음을 알 수 있다. 

 

 

앞에서 컴포넌트 스캔 대상이 되는 몇 가지 어노테이션이 있었다. 

그렇다면 해당 어노테이션이 아니더라도 컴포넌트 스캔 대상이 되도록 할 수는 없을까? 

 

바로 이 기능을 담당하는 것이 필터이다. 

 

우리가 일상생활에서 쓰는 필터는  '걸러내는 틀'  이다. 

 

이것을 스프링의 관점으로 생각해본다면  필터란 무엇을 빈으로 등록하고, 등록하지 않을지 걸러내는 것 이다. 

 

 

 

 


 

 

필터

 

컴포넌트 스캔 대상에 추가할 어노테이션

package hello.core.scan.filter;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
    //@MyIncludeComponent : 컴포넌트 스캔 대상
}

 

 

컴포넌트 스캔 대상에서 제외할 어노테이션

package hello.core.scan.filter;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
    //@MyExcludeComponent : 컴포넌트 스캔 대상 제외
}

 

 

 

컴포넌트 스캔 대상에 추가할 클래스

package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA {
}

 

 

 

컴포넌트 스캔 대상에서 제외할 클래스

package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB {
}

 

 

 

 

실행 정보와 전체 테스트 코드

package hello.core.scan.filter;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.*;

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan(){
    
        AnnotationConfigApplicationContext ac = 
                new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
                
        //beanA는 스프링 빈으로 등록됨
        BeanA beanA = ac.getBean("beanA", BeanA.class);

        assertThat(beanA).isNotNull();

        //beanB는 스프링 빈으로 등록X -> beanB 조회시 예외발생
        assertThrows( NoSuchBeanDefinitionException.class,
                ()-> ac.getBean("beanB", BeanB.class) );




    }

    @Configuration
    @ComponentScan(
            includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION,
                    classes = MyIncludeComponent.class),
            excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION,
                    classes = MyExcludeComponent.class)
    )
    static class ComponentFilterAppConfig{
          // @Component + @MyIncludeComponent 를 빈으로 등록
    }
}

 

  • includeFilters : 컴포넌트 스캔 대상을 추가로 지정
  • excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정 

 

 

FilterType 옵션

탐색할 패키지의 시작 위치 지정

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸린다. 그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.

 

@ComponentScan(
        basePackages = "hello.core.member", //시작 패캐지 지정
        excludeFilters= @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class
)
)
  • basePackages  : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다
  • baseClasses :  지정한 클래스의 패키지를 시작 패키지로 지정
  • 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보의 패키지가 시작 위치가 된다. 

 

 

 

 

 

간단히 말해서,  스프링 설정 정보가 있는 클래스는 프로젝트의 시작 위치에 두거나, 

스프링 부트를 사용한다면 @ComponentScan을 사용하지 않더라도 스프링 부트가 알아서 컴포넌트 스캔을 해준다는 것이다. 

 

 

컴포넌트 스캔 기본 대상

 

컴포넌트 스캔은 @Component 뿐만 아니라 다음과 내용도 추가로 대상에 포함한다. 

 

  • @Component
  • @Controller
  • @Service
  • @Repository
  • @Configuration

 

 

 

 

 

컴포넌트 스캔이 필요한 이유?

 

  • 지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.
  • 예제에서는 몇개가 안되었지만, 이렇게 등록해야 할 스프링 빈이 수십, 수백개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생한다.
  • 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
  • 또한 의존관계도 자동으로 주입하는 @Autowired  라는 기능도 제공한다

 

 

 

컴포넌트 스캔과 @Autowired

 

 

 

 

 

AutoAppConfig

  • 먼저 기존 AppConfig.java는 과거 코드와 테스트를 유지하기 위해 남겨두고, 새로운 AutoAppConfig.java를 만들자. 
  • AutoAppConfig = 컴포넌트 스캔을 이용하는 설정 클래스 
@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type= FilterType.ANNOTATION,classes = Configuration.class
        )
)
public class AutoAppConfig {
      // 설정 정보가 아무것도 없다!
}

 

  • AutoAppConfig 클래스도 설정 클래스 이므로 @Configuration 어노테이션을 사용한다. 
  • 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다.
  • 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type= FilterType.ANNOTATION,classes = Configuration.class)
       )

 

이 코드는 @Configuration이 붙은 클래스는 스프링 빈으로 등록시키지 말라는 의미이다. 

 

컴포넌트 스캔이란? 
@Component 어노테이션이 붙은 클래스를 스캔해서 자동으로 스프링 빈으로 등록시켜주는 기능이다.  

 

이제 각 클래스가 컴포넌트 스캔의 대상이 되도록  @Component 어노테이션을 붙여주자.

 

 

※ 참고 

 

 

그렇다면 AutoAppConfig는 어떨까? AutoAppConfig클래스에도 @Configuration을 붙여줬으므로 AppConfig 또한 빈으로 등록이 안되는걸까? 

 

테스트 실행을 통해 알아보자 

 

 

MemoryMemberRepository @Component 추가 

@Component // 빈 등록 대상
public class MemoryMemberRepository implements MemberRepository{

 

RateDiscountPolicy @Component 추가 

@Component
public class RateDiscountPolicy implements DiscountPolicy {

 

MemberServiceImpl @Component, @Autowired 추가

@Component
public class MemberServiceImpl implements MemberService {


   private final MemberRepository memberRepository;

    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {

        this.memberRepository = memberRepository;
    }

 

 

OrderServiceImpl @Component, @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;
    }

 

  • 이전에 AppConfig에서는 @Bean으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다.
  • 이제는 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다.
  • @Autowired 는 의존관계를 자동으로 주입해준다.

 

AppConfig의 경우,  memberService ( )처럼 메서드를 호출하여 의존관계가 있는 객체를 주입해줬지만,  컴포넌트 스캔을 이용하는 AutoAppConfig의 경우 설정 정보 자체가 없다.  @Component을 보고 빈으로 등록해줄 뿐 의존관계를 주입해주라는 정보는 없다. 그래서 자동으로 의존관계를 주입해주는 방법이 필요하다.  ▶  @ Autowired  

 

 

 

 

 

AutoAppConfigTest 

  •  테스트 코드를 통해 컴포넌트 스캔을 통해서도 빈들이 잘 등록 되었는지 확인해보자 
public class AutoAppConfigTest {

    @Test
    @DisplayName("컴포넌트 스캔해서 스프링 빈 등록하기")
    void basicScan(){

        AnnotationConfigApplicationContext ac =
                new AnnotationConfigApplicationContext(AutoAppConfig.class);

        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);

        // 등록된 모든 빈 조회하기
        for (String beanDefinitionName : ac.getBeanDefinitionNames()) {
            System.out.println("등록된 빈 = " + beanDefinitionName);
        }


    }
}

 

//실행결과 
등록된 빈 = org.springframework.context.annotation.internalConfigurationAnnotationProcessor
등록된 빈 = org.springframework.context.annotation.internalAutowiredAnnotationProcessor
등록된 빈 = org.springframework.context.annotation.internalCommonAnnotationProcessor
등록된 빈 = org.springframework.context.event.internalEventListenerProcessor
등록된 빈 = org.springframework.context.event.internalEventListenerFactory
등록된 빈 = autoAppConfig
등록된 빈 = rateDiscountPolicy
등록된 빈 = memberServiceImpl
등록된 빈 = memoryMemberRepository
등록된 빈 = orderServiceImpl

 

AutoAppConfigTest  실행 결과 빈들이 잘 등록되었음을 알 수 있다.

 

또한 로그를 보면 컴포넌트 스캔이 잘 작동하는 것을 알 수 있다. 

 

 

 // @Autowired 생성자 주입
 Autowiring by type from bean name 'memberServiceImpl' via constructor to bean named 'memoryMemberRepository'
 Autowiring by type from bean name 'orderServiceImpl' via constructor to bean named 'memoryMemberRepository'
 Autowiring by type from bean name 'orderServiceImpl' via constructor to bean named 'rateDiscountPolicy'

 

 

아까 위에서 @Configuration이 있는 클래스는 빈으로 등록하지않는 조건을 작성했는데 

AutoAppConfig는 왜 @Configuration 어노테이션이 있음에도 빈으로 등록되었을까? 

 

그 이유는 바로,  스프링 컨테이너의 설정정보로 AutoAppConfig를 전달해줬기 때문이다. 

 

 AnnotationConfigApplicationContext ac= new AnnotationConfigApplicationContext(AutoAppConfig.class);

 

AnnotationConfigApplicationContext는 Java 기반의 설정 클래스를 스캔하고 해당 클래스에서 정의된 빈들을 컨테이너에 등록하는 역할을 합니다. 그래서 AutoAppConfig 클래스를 전달하면, 이 클래스에서 정의된 빈들이 스프링 컨테이너에 등록된다. 

 

즉, @Configuration 어노테이션이 붙어 있더라도 스프링은 이를 구성 클래스로 간주하고 빈으로 등록하는 것이다. 

 

 


 

 

 

컴포넌트 스캔과 자동 의존관계 주입이 어떻게 동작하는지 그림으로 알아보자.

 

 

1. @ComponentScan

  • @ComponentScan은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
  • 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
          - 빈 이름 기본 전략: MemberServiceImpl 클래스 →  memberServiceImpl 
          - 빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런식으로 이름           을 부여하면 된다.

참고 AppConfig 를 설정 클래스로 할때에는 메서드의 이름을 빈 이름으로 설정했었다. 

 

 

 

 

2. @Autowired 의존관계 자동 주입 

 

  • 생성자에  @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
  • 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다. →  getBean(MemberRepository.class) 와 동일하다고 이해하면 된다
  • 하지만 타입으로 빈을 조회하는 방법에는 문제점이 있었다. 바로 같은 타입의 빈이 여러개인 경우 였다. 

 

그런데 같은 타입의 빈이 여러개인 경우 어떤 빈을 주입해줄까?  그리고 빈 이름을 지정해서 주입해줄 수는 없을까? 

 

이와 관련된 문제는 뒤에서 배워보도록 하자. 

 

 

  • 또한 생성자에 주입해줘야하는 객체가 여러개여도 다 찾아서 자동으로 주입해준다. 

+ Recent posts