[Spring] 컴포넌트 스캔

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

컴포넌트 스캔은 스프링 빈을 스캔해서 스프링 기능을 실행하는것

@Configuration
@ComponentScan(
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class) 
        // 다른 Configuration이 등록되면 안되기 때문에 등록 (@Configuration일 경우 자동 스캔)
        // 실무에서 exclude는 잘 안씀
)
public class AutoAppConfig {

}

@Component
public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

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

• 구현체는 @Component 애노테이션을 붙여준다. @Component로 애노테이션을 쓰면 스프링 빈으로 등록된다.
• 등록된 빈에 의존관계를 주입하기 위해서 생성자에 @Autowired 애노테이션을 붙여준다.

컴포넌트 스캔 과정

AppConfig에 @ComponentScan 애노테이션이 있으면 아래와 같은 작업을 수행한다.

1. @Component 애노테이션이 붙은 클래스를 스캔하여 빈으로 등록한다.
2. 이때 스프링 빈의 기본이름은 클래스명을 사용하되 맨 앞글자만 소문자로 사용한다.
   1. MemberServiceImpl 클래스 -> memberServiceImpl
   2. 빈 이름을 직접 입력하고 싶은 경우 @Component("memberServiceImpl") 와 같이 사용한다.
3. @Autowired가 있으면 생성자가 생성할 때, 파라미터에 지정된 클래스를 빈 저장소에서 같은 타입이 있는지 조회
4. 조회된 빈을 주입해준다.

컴포넌트 스캔의 탐색 위치

package hello.core;

@Configuration
@ComponentScan(
        basePackages = "hello.core.member",
        // 검색할 시작 패키지 위치를 지정한다.
        // basePackages = {"hello.core.member", "hello.service"},
        // 기본값은 이 클래스가 속한 패키지부터 시작한다. 따라서 hello.core부터
        basePackageClasses = AutoAppConfig.class,

        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
        // 다른 Configuration이 등록되면 안되기 때문에 등록 (@Configuration일 경우 자동 스캔)

)
public class AutoAppConfig {

}

탐색할 패키지의 기본 시작위치는 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

따라서, 패키지 위치 정보를 따로 두지 않고 설정정보 클래스 자체를 프로젝트의 최상단에 두는 것이 관례다.

참고로, 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication을 프로젝트 시작 루트 위치에 두는 것이 관례이다. (그리고 이 설정 안에 바로 @ComponentScan이 들어있다.)

@SpringBootApplication
public class CoreApplication {

   public static void main(String[] args) {
      SpringApplication.run(CoreApplication.class, args);
   }

 

컴포넌트 스캔 기본 대상

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

• @Component: 컴포넌트 스캔에서 사용
• @Controller
  • 스프링 MVC 컨트롤러에서 사용
  • 스프링 MVC 컨트롤러로 인식
• @Service
  • 스프링 비즈니스 로직에서 사용
  • 특별한 처리는 없지만 비즈니스 로직이라는 것을 개발자가 인식하도록 함
• @Repository
  • 스프링 데이터 접근계층에서 사용
  • 스프링 데이터 접근계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
• @Configuration
  • 스프링 설정 정보에서 사용
  • 앞서 보았듯이 스프링 설정정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

필터

• includeFilter: 해당 빈을 포함
• excludeFilter: 해당 빈을 포함하지 않음

FilterType 옵션

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

}

• ANNOTATION: 기본값, 애노테이션을 인식해서 동작한다.
• ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.
• ASPECTJ: AspectJ 패턴 사용
• REGEX: 정규표현식
• CUSTOM: TypeFilter라는 인터페이스를 구현해서 처리

중복 등록과 충돌

자동 빈 등록 vs 자동 빈 등록

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

수동 빈 등록 vs 자동 빈 등록

이런 경우 수동 빈 등록이 우선권을 갖는다

수동빈이 자동빈을 오버라이딩 해준다.

Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing

이런 경우 스프링 부트에서는 오류가 발생하도록 기본설정을 바꾸었다고 한다 (버그가 생기면 잡기 어려움)