스프링 핵심원리 : 기본편 - 컴포넌트 스캔과 자동 의존관계 주입

"인프런의 스프링 핵심원리 - 기본편 강의를 듣고 작성한 글 입니다."

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

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

 

컴포넌트 스캔과 자동 의존관계 주입

- 지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean 이나 XML 의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.

- 예제에서는 몇개가 안되었지만, 이렇게 등록해야 할 스프링 빈이 수십, 수백개가 되면 일일히 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생한다.

- 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.

- 또 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공한다.

 

코드로 컴포넌트 스캔과 의존관계 자동 주입을 알아보자.

먼저 기존 AppConfig 클래스는 과거 코드와 테스트를 유지하기 위해 남겨두고, 새로운 AutoAppConfig 클래스를 만들자.

hello.core 패키지에 AutoAppConfig 클래스를 만들고 다음과 같이 코드를 작성한다.

- AutoAppConfig.java

@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
}

- 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다.

- 기존의 AppConfig 와는 다르게 @Bean 으로 등록한 클래스가 하나도 없다.

+ 참고 : 컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에 AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고 실행되어 버린다.

그래서 excludeFilters 를 이용해서 설정 정보는 컴포넌트 스캔 대상에서 제외했다. 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해서 이 방법을 선택했다.

 

컴포넌트 스캔은 이름 그대로 @Component 어노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다. @Component 를 붙여주자.

+ 참고 : @Configuration 이 컴포넌트 스캔의 대상이 된 이유도 @Configuration 소스 코드를 열어보면 @Component 어노테이션이 붙어있기 때문이다.

 

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

- MemoryMemberRepository.java -> @Component 추가

@Component
public class MemoryMemberRepository implements MemberRepository {}

- RateDiscountPolicy.java -> @Component 추가

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

- MemberServiceImpl.java -> @Component, @Autowired 추가

@Component
public class MemberServiceImpl implements MemberService{

//    private final MemberRepository memberRepository = new MemoryMemberRepository();
    private final MemberRepository memberRepository;

    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository){
        this.memberRepository = memberRepository;
    }

    // ......
}

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

- @Autowired 는 의존관계를 자동으로 주입해준다. 스프링에서 @Autowired 어노테이션이 붙어있는 생성자 메소드를 발견할 경우, 의존성 주입을 위해 매개변수로 들어와 있는 객체를 스프링 빈 컨테이너에서 찾은 후 해당 빈 객체를 의존성 주입 해준다.

- 자세한 룰은 추후에 알아보자.

 

- OrderServiceImpl.java -> @Component, @Autowired 추가

@Component
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    // final 키워드가 붙어있는 필드는 기본적으로 생성자를 통해 값을 할당해야 한다.
    @Autowired
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

    // .....
}

- @Autowired 를 사용하면 생성자에서 여러 의존관계도 한번에 주입받을 수 있다.

 

그럼 이제 테스트 코드를 작성하여 컴포넌트 스캔과 의존관계 자동 주입이 잘 되었는지 확인해보자.

test 폴더 아래 hello.core.scan 패키지에 AutoAppConfigTest 클래스를 만들고 다음과 같이 코드를 작성한다.

- AutoAppConfigTest.java

public class AutoAppConfigTest {
    
    @Test
    void basicScan(){
        ApplicatoinContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

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

- AnnotationConfigApplicationContext 를 사용하는 것은 기존과 동일하다.

- 설정 정보로 AutoAppConfig 클래스를 넘겨준다.

- 실행해보면 기존과 같이 잘 동작하는 것을 확인할 수 있다.

로그를 잘 보면 컴포넌트 스캔이 잘 동작하는 것을 확인할 수 있다.

16:50:15.015 [main] DEBUG org.springframework.context.annotation.ClassPathBeanDefinitionScanner - Identified candidate component class: file [C:\Users\tnrdu\Documents\GitHub\Spring_Basic\core\out\production\classes\hello\core\discount\RateDiscountPolicy.class]
16:50:15.017 [main] DEBUG org.springframework.context.annotation.ClassPathBeanDefinitionScanner - Identified candidate component class: file [C:\Users\tnrdu\Documents\GitHub\Spring_Basic\core\out\production\classes\hello\core\member\MemberServiceImpl.class]
16:50:15.017 [main] DEBUG org.springframework.context.annotation.ClassPathBeanDefinitionScanner - Identified candidate component class: file [C:\Users\tnrdu\Documents\GitHub\Spring_Basic\core\out\production\classes\hello\core\member\MemoryMemberRepository.class]
16:50:15.018 [main] DEBUG org.springframework.context.annotation.ClassPathBeanDefinitionScanner - Identified candidate component class: file [C:\Users\tnrdu\Documents\GitHub\Spring_Basic\core\out\production\classes\hello\core\order\OrderServiceImpl.class]

 

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

 

1. @ComponentScan

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

- 이때 스프링 빈의 기본 이름은 클래스 명을 사용하되 맨 앞글자만 소문자를 사용한다.

    - 빈 이름 기본 전략 : MemberServiceImpl 클래스 -> memberServiceImpl

    - 빈 이름 직접 지정 : 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2") 이런식으로 이름을 부여하면 된다.(구현체를 대상으로 해야한다.)

 

2. Autowired 의존관계 자동 주입

- 생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.

- 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.

    - getBean(MemberRepository.class) 와 동일하다고 이해하면 된다.

    - 더 자세한 내용은 다음에 알아보자.

 

- 생성자에 매개변수가 많아도 다 찾아서 자동으로 주입한다.

 

 

탐색위치와 기본 스캔 대상

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

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

-AutoAppConfig.java

@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class),
        basePackages = "hello.core"
)
public class AutoAppConfig {
}

- basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.

    - basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.

- basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.

- 만약 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

* 권장하는 방법

개인적으로 사용하기 좋은 방법은 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.

예를 들어서 프로젝트가 다음과 같은 구조로 이루어져 있다고 하자.

- com.hello

- com.hello.service

- com.hello.repository

 

com.hello -> 프로젝트 시작 루트, 여기에 AppConfig 같은 메인 설정 정보를 두고, @ComponentScan 어노테이션을 붙이고, backPackages 지정은 생략한다.

이렇게 하면 com.hello 를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다. 그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다.

참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다.

(그리고 이 설정안에 바로 @ComponentScan 이 들어있다.)

 

컴포넌트 스캔 기본 대상

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

- @Component : 컴포넌트 스캔에서 사용

- @Controller : 스프링 MVC 컨트롤러에서 사용

- @Service : 스프링 비즈니스 로직에서 사용

- @Repository : 스프링 데이터 접근 계층에서 사용

- @Configuration : 스프링 설정 정보에서 사용

 

위 어노테이션들의 소스 코드를 보면 @Component 를 포함하고 있는 것을 알 수 있다.

+ 참고 : 사실 어노테이션에는 상속 관계라는 것이 없다. 그래서 이렇게 어노테이션이 특정 어노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 것은 아니고, 스프링이 지원하는 기능이다.

 

컴포넌트 스캔의 용도 뿐만 아니라 다음 어노테이션이 있으면 스프링은 부가 기능을 수행한다.

- @Controller : 스프링 MVC 컨트롤러로 인식

- @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.(데이터베이스 익셉션을 스프링 익셉션으로 변환한다.)

- @Configuration : 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

- @Service : 사실 @Service 는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다.

+ 참고 : useDefaultFilters 옵션은 기본으로 켜져 있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다. 그냥 이런 옵션이 있구나 정도 알고 넘어가자.