[스프링 기본] 컴포넌트 스캔

공부 내용을 정리하고 앞으로의 학습에 이해를 돕기 위해 작성합니다.

 

컴포넌트 스캔과 의존관계 자동 주입 시작하기

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

- 하지만 스프링 빈이 수십, 수백 개가 되면 이를 일일이 등록하기 번거롭고, 누락할 가능성도 있다.

- 이러한 반복 작업을 줄이기 위해 스프링은 설정 정보 없이도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔 기능과, 의존관계를 자동으로     주입하는 @Autowired 기능을 제공한다.

 

기존 AppConfig는 코드와 테스트를 유지하기 위해 남겨두고, 새로운 AutoAppConfig를 만든다.

package hello.core;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

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

- 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan을 설정 정보에 붙여주면 된다.
- 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다!

 

참고: 컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록된다.
기존 예제 코드를 유지하기 위해 excludeFilters로 설정 정보를 제외했다. 

 

각 클래스가 컴포넌트 스캔 대상이 되도록 @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;
    }
}

- 컴포넌트 스캔은 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.

- 이전에 AppConfig에서는 @Bean으로 설정 정보를 작성하고 의존관계를 직접 명시했다. 이제는 설정 정보가 없으므로, 의존관계 주입도 클래스 내부에서 해결해야 한다.

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

 

테스트 코드

package hello.core.scan;

import hello.core.AutoAppConfig;
import hello.core.member.MemberService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class AutoAppConfigTest {

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

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

-> 오른쪽으로 휠

- AnnotationConfigApplicationContext를 사용하는 것은 기존과 동일하며, 설정 정보로 AutoAppConfig 클래스를 넘겨준다.

 

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

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

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

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

  ㄴ 빈 이름 직접 지정: 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2")처럼 이름을 부여하면 된다.

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

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

- 이는 getBean(MemberRepository.class)와 동일한 방식으로 동작한다.

- 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.

 

인텔리제이 단축키

- Command + O: 메서드 오버라이드/구현 (현재 클래스 내에서 사용).

- Shift 두 번: 프로젝트 내 모든 항목 검색.

- Command + Shift + F: 프로젝트 전체에서 텍스트 검색.

 

현재 탭 제외 나머지 탭 닫기: option 누른 채로 X클릭

 

탐색 위치와 기본 스캔 대상

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

@ComponentScan(
     basePackages = "hello.core",
}

- basePackages

 ㄴ 탐색할 패키지의 시작 위치를 지정하며, 이 패키지를 포함해서 하위 패키지도 모두 탐색한다.

 ㄴ 여러 시작 위치를 지정할 수도 있다.
- basePackageClasses: 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
- 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

강사님이 권장하는 방법

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

 

컴포넌트 스캔 대상

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

 

참고 : 애노테이션에는 상속관계가 없다. 특정 애노테이션이 다른 애노테이션을 포함하는 것을 인식하는 기능은 자바 언어가 아니라 스프링이 지원하는 기능이다.

 

부가 기능

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

@Repository: 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해 줌

@Configuration: 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리

@Service: 특별한 처리는 하지 않지만, 비즈니스 계층을 나타내어 개발자가 인식하는 데 도움을 줌

 

필터

includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.

excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.

 

컴포넌트 스캔 대상에 추가/제외할 애노테이션을 만든다.

package hello.core.scan.filter;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}

-----------------------------------------------------------------------------

package hello.core.scan.filter;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface 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.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.ApplicationContext;
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.*;
import static org.junit.jupiter.api.Assertions.*;
import static org.springframework.context.annotation.ComponentScan.*;

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);

        BeanA beanA = ac.getBean("beanA", BeanA.class);
        assertThat(beanA).isNotNull();

        assertThrows(
                NoSuchBeanDefinitionException.class,
                () -> ac.getBean("beanB", BeanB.class));
    }

    @Configuration
    @ComponentScan(
            includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
            excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
    )
    static class ComponentFilterAppConfig{

    }
}

- includeFilters에 MyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.  
- excludeFilters에 MyExcludeComponent 애노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않는다.

 

Filter의 5가지 옵션

- ANNOTATION: 기본값, 애노테이션을 인식해서 동작.

    예) `org.example.SomeAnnotation`
- ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작. 

    예) `org.example.SomeClass`
- ASPECTJ: AspectJ 패턴 사용. 

    예) `org.example..*Service+`
- REGEX: 정규 표현식. 

    예) `org\. example\. Default.*`
- CUSTOM: `TypeFilter`라는 인터페이스를 구현해서 처리. 

    예) `org.example.MyTypeFilter`

 

대부분은 @Component면 충분하기 때문에 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장한다.

 

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름이 등록되면  발생하는 두 가지 상황이 있다.

 

1. 자동 빈 등록 VS 자동 빈 등록

- 컴포넌트 스캔에 의해 자동으로 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다.

- ConflictingBeanDefinitionException 예외 발생

 

2. 수동 빈 등록 VS 자동 빈 등록

@Component
public class MemoryMemberRepository implements MemberRepository{
... 
}


-----------------------------------------------------------------

package hello.core;

import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

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

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

}

수동 빈 등록시 남는 로그

- 이 경우 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩 해버린다.)

- 수동 빈 등록과 자동 빈 등록이 충돌할 때, 최근 스프링 부트에서는 오류가 발생하도록 기본값을 변경했다. 이는 개발자가 의도하지 않은 설정 충돌로 인한 애매하고 잡기 어려운 버그를 방지하기 위함이다.

 

결론 : 명확하지 않은 건 하지 말자