Categories: Spring

Spring 스프링 컴포넌트 스캔(Component Scan)이란?

spring

컴포넌트 스캔이란?

컴포넌트 스캔(Component Scan)은 스프링 프레임워크가 특정 패키지를 탐색하면서, 스캔 대상에 해당하는 클래스를 찾아 빈(Bean)으로 등록하는 기능입니다. 스프링 애플리케이션은 이러한 자동 스캔 기능 덕분에 개발자가 Bean을 매번 XML이나 자바 설정 파일에 일일이 등록하지 않아도 됩니다.

자바 기반의 설정을 예로 들면, @Configuration 클래스에 @ComponentScan 어노테이션을 작성하고 패키지를 지정하기만 하면 해당 패키지(및 하위 패키지)의 스프링 빈 등록 대상(@Component, @Service, @Repository, @Controller 등) 클래스들을 모두 스캔하여 자동으로 Bean 등록을 수행합니다.

왜 컴포넌트 스캔이 필요한가?

생산성 향상: 모든 스프링 빈을 매번 수동으로 등록하는 대신, 표준 어노테이션(예: @Component)만 붙여두면 스프링 컨테이너가 자동으로 빈 등록을 해 주므로 생산성이 올라갑니다.
관례에 따른 표준화: 스프링은 주로 @Controller, @Service, @Repository 등 계층화를 위한 특정 stereotype 어노테이션을 제공합니다. 이러한 어노테이션을 붙이면 자동으로 빈 등록과 함께 역할도 분류할 수 있으므로 관리가 편리해집니다.
유연한 구조: 여러 개의 패키지를 스캔 대상에 추가하거나 제외할 수 있고, 특정 클래스는 스캔 대상에서 필터링하여 제외하거나 포함하도록 설정할 수 있어 확장성, 유연성이 높아집니다.

컴포넌트 스캔 기본 작동 원리

스프링이 컴포넌트 스캔을 시작하면 크게 아래와 같은 과정을 거칩니다.

스캔 대상 패키지 식별: @ComponentScan(basePackages = “com.example”)처럼 basePackages 속성에 지정된 위치(또는 default 패키지)를 기준으로 하위 디렉터리까지 순차적으로 클래스 파일을 검색합니다.
스캔 대상 클래스 찾기: 검색된 클래스들 중 @Component 및 @Component를 메타로 삼는(=내부적으로 @Component가 붙어있는) 다른 stereotype 어노테이션(@Service, @Repository, @Controller, @RestController 등)이 붙어있는 클래스를 찾아냅니다.
빈 등록: 해당 클래스를 스프링 컨테이너에 빈으로 등록합니다. 클래스 이름을 기반으로 기본 bean 이름을 생성하되(lowerCamelCase 형태), @Component(“beanName”)처럼 별도의 이름을 지정한 경우 그 이름으로 등록됩니다.

@Component와 stereotype 어노테이션의 관계

@Component: “이 클래스는 스프링의 빈(Bean)으로 등록될 대상”임을 나타내는 가장 기본적인 표준 스프링 어노테이션입니다.
@Controller: Spring MVC에서 컨트롤러 역할을 하는 클래스라는 의미로, 내부적으로 @Component가 포함되어 있습니다.
@Service: 비즈니스 로직을 수행하는 레이어(서비스 레이어)에 사용됩니다. 역시 @Component를 메타로 삼기 때문에 컴포넌트 스캔 대상이 됩니다.
@Repository: 데이터 접근 레이어(DAO) 역할로, 예외 변환 등을 위해 사용됩니다. 내부적으로 @Component가 있기 때문에 컴포넌트 스캔 대상입니다.
@Configuration: 스프링 컨테이너의 설정 클래스. 내부적으로 @Component가 있어, 컴포넌트 스캔 대상이 됩니다.

Tip: @Bean을 메서드에 붙여 빈을 등록하는 방식(수동 등록)과 @ComponentScan에 의한 자동 등록이 모두 가능하므로, 환경과 구조에 따라 적절히 병행할 수 있습니다.

@ComponentScan 설정 방법

기본 사용법

자바 기반 설정을 예시로 들어 보겠습니다.

Java

@Configuration
@ComponentScan(basePackages = "com.example")
public class AppConfig {
}

Java

@Configuration은 이 클래스를 스프링 설정용 클래스로 사용한다는 의미입니다.
@ComponentScan(basePackages = “com.example”)는 “com.example 패키지 및 그 하위 패키지에서 컴포넌트 스캔을 실행하라”는 의미입니다.
스캔 대상은 @Component 계열 어노테이션이 붙은 클래스들입니다.

basePackages 속성의 다양한 사용

복수 패키지 지정

Java

@ComponentScan(basePackages = {"com.example.service", "com.example.repository"})

Java

복수의 패키지를 동시에 지정할 수 있습니다.

베이스 패키지를 지정하지 않을 경우

Java

@Configuration
@ComponentScan
public class AppConfig { ... }

Java

해당 설정 클래스의 패키지를 베이스로 스캔이 이루어집니다. 따라서 패키지 구조를 적절히 배치하고, 설정 클래스가 상위 패키지에 위치하도록 하면 자연스럽게 전체 애플리케이션이 스캔될 수 있습니다.

@ComponentScan의 주요 속성들

basePackages: 컴포넌트를 스캔할 패키지 명시 (문자열 또는 문자열 배열).
basePackageClasses: 지정한 클래스들이 속한 패키지를 기준으로 스캔.
includeFilters: 특정 조건에 맞는 클래스만 스캔 대상에 포함하고 싶을 때 사용 (예: 특정 애노테이션이 있는 클래스만).
excludeFilters: 특정 조건에 맞는 클래스들을 스캔 대상에서 제외하고 싶을 때 사용.
lazyInit: 스캔된 Bean들을 Lazy Initialization으로 등록할지 여부 (true로 설정하면 실제 사용 시점에 Bean 생성).

스캔 필터(Include/Exclude Filters) 사용하기

보다 유연하게 컴포넌트 스캔 대상을 제어하고 싶다면, includeFilters와 excludeFilters를 활용할 수 있습니다.

Include Filter

includeFilters는 지정된 조건(타입, 어노테이션 등)에 부합하는 클래스만 스캐닝하여 빈으로 등록합니다.

Java

@Configuration
@ComponentScan(
    basePackages = "com.example",
    includeFilters = {
        @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyCustomAnnotation.class)
    },
    useDefaultFilters = false
)
public class AppConfig {
}

Java

@ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyCustomAnnotation.class): 클래스에 @MyCustomAnnotation이 붙어 있어야 Bean 등록 대상이 됩니다.
useDefaultFilters = false: 스프링이 기본적으로 사용하는 필터(@Component 등)를 사용하지 않겠다는 의미입니다. 따라서 오직 @MyCustomAnnotation가 붙은 클래스들만 등록됩니다.

Exclude Filter

excludeFilters를 사용하면 원하는 클래스(또는 어노테이션, 정규 표현식 등)를 스캔 대상에서 제외할 수 있습니다.

Java

@Configuration
@ComponentScan(
    basePackages = "com.example",
    excludeFilters = {
        @ComponentScan.Filter(type = FilterType.REGEX, pattern = "com\\.example\\.excluded.*")
    }
)
public class AppConfig {
}

Java

type = FilterType.REGEX, pattern = “com\\.example\\.excluded.*” : com.example.excluded 패키지(하위 포함) 안에 있는 클래스들은 모두 제외.

FilterType의 종류

ANNOTATION: 특정 어노테이션이 붙어 있는지 여부로 필터링
ASSIGNABLE_TYPE: 특정 클래스나 인터페이스를 상속 혹은 구현했는지 여부로 필터링
REGEX: 정규 표현식(Regular Expression)으로 필터링
ASPECTJ: AspectJ 포인트컷 표현식을 이용하여 필터링
CUSTOM: TypeFilter 인터페이스를 직접 구현한 클래스를 사용해 커스텀 로직으로 필터링

컴포넌트 스캔 시 주의사항

빈 이름 충돌

스프링에서 Bean은 식별자(이름)로 관리됩니다. 스캔된 클래스 이름이 동일하거나, 별도로 지정한 Bean 이름이 겹치면 충돌이 발생합니다. 예를 들어, 같은 패키지 하위에 두 개의 @Service(“orderService”)가 있다면 스캔 과정에서 이름이 충돌할 수 있습니다.

해결 방법
- 빈 이름을 유니크하게 지정하거나
- 패키지 구조를 잘 분리하는 것
- XML 또는 자바 설정의 수동 빈 등록(또는 프로필 분리)으로 일부 클래스를 분리하는 것

중복 스캔

여러 개의 설정 파일(AppConfig 등)에 대해 basePackages가 겹치는 경우, 같은 클래스를 중복 스캔할 우려가 있습니다.

실제로는 충돌 상황을 제외하면 동일 빈을 “이미 등록된 상태”로 인식하고 중복으로 등록되지 않지만, 불필요한 스캔 과정이 늘어나고 설정이 복잡해질 수 있습니다.
프로젝트 구조를 정리하여 필요 최소한의 컴포넌트 스캔 범위를 지정하는 것이 좋습니다.

성능 문제

수많은 패키지를 한꺼번에 스캔하면 시작 속도가 느려질 수 있습니다. 대규모 프로젝트에서는 스캔 범위를 꼭 필요한 영역으로 한정하고, 불필요한 패키지는 excludeFilters 등으로 제외하여 성능을 관리할 필요가 있습니다.

고급 활용 예시

@SpringBootApplication의 컴포넌트 스캔

스프링 부트를 사용한다면 @SpringBootApplication 에 이미 @ComponentScan이 포함되어 있기 때문에, @SpringBootApplication이 선언된 클래스의 패키지 및 하위 패키지가 기본 스캔 대상이 됩니다.

예: com.example.app 패키지에 @SpringBootApplication 클래스가 있다면, com.example.app 및 그 하위 패키지 전체가 스캔 대상입니다.
추가 설정을 하고 싶다면, @SpringBootApplication(scanBasePackages = “com.example”)와 같이 작성하거나, 따로 @ComponentScan을 선언해 확장할 수 있습니다.

멀티 모듈 프로젝트에서의 컴포넌트 스캔

멀티 모듈 환경에서 서비스 레이어, 리포지토리 레이어 등의 프로젝트가 나뉘어 있을 경우, 각 모듈에서 제공하는 패키지 경로가 다를 수 있습니다. 이때 @ComponentScan의 basePackages에 여러 모듈의 패키지를 나열하거나, 개별 모듈 별로 설정 클래스를 분리해 적용할 수 있습니다.

Java

@Configuration
@ComponentScan(basePackages = {
    "com.example.moduleA",
    "com.example.moduleB"
})
public class MultiModuleConfig {
}

Java

프로파일(Profile)과의 연동

스프링 프로파일을 활용해, 특정 환경에서만 스캔되는 빈을 관리할 수도 있습니다.

예: 개발 환경에선 @Profile(“dev”)가 붙은 Bean만 스캔되도록 구성하거나, 운영(environment=prod)에서는 해당 빈이 스캔되지 않도록 설정할 수 있습니다.

정리

스프링 컴포넌트 스캔은 개발자가 Bean 등록을 쉽게 자동화하고, 의존성 주입(Dependency Injection)을 간편하게 설정할 수 있도록 해주는 핵심 기능입니다.

@Component, @Service, @Repository, @Controller 등으로 자동 등록.
basePackages, includeFilters, excludeFilters 등으로 스캔 대상을 정교하게 조정.
빈 충돌, 중복 스캔 등의 주의점이 있으므로 프로젝트 구조 설계 시 유의.
스프링 부트에서는 @SpringBootApplication이 기본적으로 컴포넌트 스캔을 지원하며, 필요한 경우 추가 커스터마이징 가능.

프로젝트 규모가 작을 땐 @ComponentScan(basePackages = “패키지.경로”)만 지정해도 충분하지만, 규모가 커지거나 특정 패키지는 제외해야 할 필요가 있으면 excludeFilters를 적극 활용하고, 빈 충돌을 방지하기 위해 디렉터리 구조와 빈 이름을 체계적으로 설계해야 합니다.

결론

컴포넌트 스캔은 스프링 DI 컨테이너를 구성하는 핵심적인 방법 중 하나로, 스프링을 이용해 애플리케이션을 개발할 때 빼놓을 수 없는 핵심 기능입니다.

자동 빈 등록: 최소한의 설정으로도 개발자에게 높은 생산성을 제공합니다.
유연한 스캐닝 옵션: 필요한 대로 패키지, 필터 등 다양한 옵션을 활용해 세밀하게 설정할 수 있습니다.
@SpringBootApplication과의 조합: 스프링 부트 프로젝트에서는 설정이 훨씬 간소화되어 초기 세팅이 쉽고 빠릅니다.

컴포넌트 스캔 덕분에 스프링 애플리케이션을 모듈 단위로 구조화하고, 각 계층(@Controller, @Service, @Repository 등)으로 구분해 작성하면, 큰 규모의 애플리케이션도 체계적으로 관리하고 확장할 수 있습니다. 앞으로 프로젝트에서 컴포넌트 스캔 기능을 적극 활용해 생산성과 유지보수성을 향상시키시길 바랍니다.

suover