Spring Core(3) 컴포넌트 스캔과 의존관계 자동주입

오잉·2023년 4월 12일

SPRING

목록 보기

3/15

지금까지는 @Configuration이 붙은 자바 설정 파일에 @Bean으로 일일이 스프링 빈을 등록하고, 생성자를 통해서 일일이 의존성을 주입해주었다.

@Configuration
public class AppConfig {
    
    @Bean 
    public MemberService() {
        return new MemberServiceImpl(memberRepository());
    }
    
    @Bean
    public OrderService orderService() {
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }
    
    @Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }
    
    @Bean
    public DsicountPolicy discountPolicy() {
        return new RateDiscountPolicy();
    }
}

하지만 등록해야할 스프링 빈이 수백개가 된다면 일일이 등록하기도 힘들고, 설정 정보도 커지고, 누락하는 문제도 발생한다.

그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
또 의존관계를 자동으로 주입하는 @Autowired라는 기능도 제공한다.

1. 컴포넌트 스캔

1) 컴포넌트 스캔 사용법

컴포넌트 스캔을 사용하려면 @Configuration이 붙은 설정정보에 @ComponentScan을 붙여주면 된다.
(보통 @SpringBootApplication 설정을 통해 이미 @ComponentScan 설정되어있음)

@Configuration
@ComponentScan
public class AutoAppConfig {
	// 기존의 AppConfig와 다르게 @Bean으로 등록한 클래스가 하나도 없다.
}

컴포넌트 스캔은 이름 그대로 @Component이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.
이제 등록하고자 하는 클래스에 @Component를 붙임으로서 스프링 컨테이너에 스프링 빈으로 등록할 수 있다.

@Component
public class MemoryMemberRepository implements MemberRepository {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class MemberServiceImpl implements MemberService {
    private final MemberRepository memberRepository;
    
    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
  }
}

@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으로 직접 설정 정보를 작성하고, 생성자 주입을 통해 의존관계도 직접 명시했다.

하지만 이제는 더이상 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 각각의 @Component 클래스 안에서 해결해야한다.

=> @Autowired는 의존관계를 자동으로 주입해준다.
(@Autowired 를 사용하면 생성자에서 여러 의존관계도 한번에 주입받을 수 있다)

2) 컴포넌트 스캔과 자동 의존관계 주입의 동작 과정

@ComponentScan

@ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.

@Autowired 의존관계 자동주입

생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.

3) 컴포넌트 스캔 기본 대상

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

@Component : 컴포넌트 스캔에서 사용
@Controlller : 스프링 MVC 컨트롤러에서 사용
@Service : 스프링 비즈니스 로직에서 사용
@Repository : 스프링 데이터 접근 계층에서 사용
@Configuration : 스프링 설정 정보에서 사용

(해당 클래스의 소스 코드를 보면 @Component 를 포함하고 있는 것을 알 수 있다.)

2. 의존관계 자동주입

1) 의존관계 주입 방법

생성자 주입

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

생성자를 통해서 의존관계를 주입받는 방법 (지금까지 우리가 진행했던 방법)
생성자 호출 시점에 딱 1번만 호출되는 것이 보장 (맨처음에 초기화 된 후, 이후 변경을 막을 수 있다)
불변, 필수 의존관계에 사용 (항상 그런 것은 아니고 주로 그렇게 사용한다)
생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입 된다. (물론 스프링 빈에만 해당)

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

필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법
선택, 변경 가능성이 있는 의존관계에서 사용 (<-> 생성자 주입)
자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법
(자바빈 프로퍼티 규약 : 필드의 값을 직접 변경하지 않고, setXxx, getXxx 라는 메서드를 통해서 값을 읽거나 수정하는 규칙)

필드 주입

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

필드에 바로 주입하는 방법
외부에서 변경이 불가능해서 (단위) 테스트 하기 힘들다
DI 프레임워크가 없으면 아무것도 할 수 없다
사용하지 말자 (애플리케이션의 실제 코드와 관계 없는 테스트 코드
or 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용)

순수한 자바 테스트 코드에는 당연히 @Autowired가 동작하지 않는다. @SpringBootTest 처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능하다.

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

2) 그래서 뭘 써야 할까?

생성자 주입을 써라. 그 이유는 다음과 같다.

불변

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

누락
프레임워크 없이 순수한 자바 코드를 단위 테스트 하는 경우에

수정자 주입 방식 코드 테스트를 돌리면 실행은 된다. 그런데 막상 실행 결과는 NPE(Null Point Exception)이 발생한다. (모든 의존관계 주입이 누락되었기 때문)
생성자 주입을 사용하면 주입 데이터를 누락 했을 때 컴파일 오류가 발생한다. 그리고 IDE에서 어떤 값을 필수로 주입해야 하는지 바로 알 수 있다.

final 키워드

생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있다. 그래서 생성자에서 혹시라도 값이 설정되지 않는 경우 컴파일 시점에 오류를 발생시킨다. (컴파일 에러는 세상에서 가장 빠르고 좋은 에러다)
수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출되므로, 필드에 final 키워드를 사용할 수 없다. 오직 생성자 주입 방식만 final 키워드를 사용할 수 있다.