Spring @ComponentScan 동작 과정

Spring에서 클래스에 @Configuration, @RestController, @Service 등의 어노테이션을 선언하면 스프링은 해당 어노테이션들을 스캔해서 빈으로 등록을 해주는데요, 이러한 역할을 하는 것이 @ComponentScan 어노테이션 입니다.

@ComponentScan 은 단어 그대로 @Component 어노테이션이 붙은 클래스들을 스캔하여 스프링 빈으로 등록하는데, 위에 언급된 어노테이션들은 모두 내부에 @Component 어노테이션을 가지고 있습니다.

 

@Service

 

@Configuration

 

위와 같은 어노테이션들을 설정하면 스프링에서는 어떻게 컴포넌트들을 스캔하고, 스프링 빈으로 등록하는지 살펴보겠습니다.

 

 

 

@ComponentScan

ComponentScan

ComponentScan 어노테이션에 존재하는 주석으로, 대략적인 의미는 다음과 같습니다.

@Configuration 클래스들과 함께 컴포넌트 스캔을 구성하며, 
basePackageClasses 혹은 basePackages 중 하나를 지정하여 스캔할 구체적인 패키지를 정의합니다.
만약 구체적인 패키지가 정의되지 않았을 경우, 이 어노테이션이 정의된 클래스의 패키지로부터 스캔이 수행됩니다.
...

 

@ComponentScan 어노테이션은 @SpringBootApplication 어노테이션에 존재하는데요, 그렇기 때문에 따로 설정하지 않으면 main() 메서드가 존재하는 패키지부터 스캔을 하게 됩니다.

스프링이 컴포넌트들을 어느 패키지에서 스캔할지는 ComponentScanAnnotationParser 클래스에서 @ComponentScan 어노테이션을 파싱하여 정의합니다.

 

 

 

ComponentScanAnnotationParser

해당 클래스는 클래스명 그대로 @ComponentScan 어노테이션을 파싱하는 클래스입니다.

 

@ComponentScan 어노테이션에 존재하는 메서드들입니다.

• value(): basePackages의 alias
• basePackages(): 어노테이션 컴포넌트를 스캔하는 기본 패키지
• basePackageClasses(): basePackages()의 Type-safe 대안으로, 지정된 각 클래스의 패키지를 스캔
• nameGenerator(): 스프링 컨테이너에서 탐지된 컴포넌트들의 이름을 지정하는 데 사용 (BeanNameGenerator)
• scopeResolver(): 컴포넌트의 Scope 범위 확인
• scopeProxy(): 컴포넌트의 프록시가 생성되어야 하는지 결정
• resourcePattern(): 컴포넌트에 적합한 클래스 파일 제어 (보다 유연한 접근을 위해 includeFilters, excludeFilters 고려)
• useDefaultFilters(): @Component, @Repository, @Service, @Controller 어노테이션이 달린 클래스들에 대해 자동으로 스캔할지 활성화 여부 (default = true)
• includeFilters(): 컴포넌트 스캐닝에 적합한 타입을 명시적으로 지정 (특정 조건을 만족하는 클래스만 스캔)
• excludeFilters(): 컴포넌트 스캐닝에 적합하지 않은 타입을 명시적으로 지정 (includeFilters 와 사용법 동일)

 

ComponentScanAnnotationParser.parse()

parse() 메서드를 통해 @ComponentScan 어노테이션에 존재하는 메서드들을 파싱합니다.

 

 

@SpringBootApplication 어노테이션 내에 존재하는 @ComponentScan은 기본적으로 basePackage, basePackageClasses 등에 대해 따로 설정하지 않기 때문에 @SpringBootApplication 어노테이션이 존재하는 패키지를 basePackages 로 설정합니다.

 

위 @ComponentScan 의 파싱이 끝나면, scanner(ClassPathBeanDefinitionScanner) 로 컴포넌트를 스캔합니다.

 

 

 

ClassPathBeanDefinitionScanner

클래스 경로에서 Bean 후보를 탐지하는 bean definition 스캐너로, (BeanFactory 혹은 ApplicationContext)의 레지스트리에 빈을 등록합니다.

 

현재 테스트를 위해 설정한 @Component 어노테이션의 대상은 다음과 같습니다. (@Configuration, @RestController, @Service)

 

 

ClassPathBeanDefinitionScanner.doScan()

doScan() 메서드에서 핵심 기능은 크게 컴포넌트 후보 조회 -> beanName 생성 -> BeanDefinition 등록 입니다.

• findCandidateComponents() -> generateBeanName() -> registerBeanDefinition()

 

findCandidateComponents() 메서드로 조회된 객체들입니다.

직접 @Component 대상으로 등록된 3개의 객체들이 존재합니다.

 

해당 컴포넌트는 지난 번 Spring Bean 이 등록되는 과정 에서 살펴봤듯이, DefaultListableBeanFactory 클래스에서 beanDefinitionMap 에 저장하여 빈을 등록&관리합니다.

private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<>(256);