컴포넌트 스캔

Kooks·2026년 4월 30일

Spring

목록 보기
3/6
post-thumbnail
  • 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
  • 의존관계도 자동으로 주입하는 @Autowired라는 기능도 제공한다.

1. @ComponentScan

  • @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
  • 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.

2. Autowired

  • 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
  • 생성자에 파라미터가 많아도 다시 찾아서 자동으로 주입한다.
@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;
    }
}

탐색 위치와 기본 스캔

@ComponentScan(
	basePackage = "hello.core",
)
  • basePackages : 탐색할 패키지의 시작 위치를 지정, 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
  • basePackages = {"hello.core", "hello.service"} 여러 시작 위치를 지정할 수도 있다.
  • basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
  • 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

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

컴포넌트 스캔 기본 대상

  • @Compnent : 컴포넌트 스캔에 사용
  • @Controller : 스프링 MVC 컨트롤러에 사용
  • @Service : 스프링 비즈니스 로직에 사용, 특별한 기능은 따로 존재하지 않지만, 개발자들이 핵심 비즈니스 로직이 여기에 존재한다고 인식 가능
  • @Repository : 스프링 데이터 접근 계층에 사용, 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
  • @Configuration : 스프링 설정 정보에서 사용

    해당 클래스의 소스 코드를 보면 @Component를 포함하고 있다.

Filter

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

FilterType

  • ANNOTATION : 기본값, 애노테이션을 인식해서 동장
    ex) org.example.SomeAnnotation
  • ASSIGNABLE_TYPE : 지정한 타입과 자식 타입을 인식해서 동작한다.
    ex) org.example.SomeClass
  • ASPECTJ : AspectJ 패턴 사용
    ex) org.example..*Service
  • REGEX : 정규표현식
    ex) org\.example\.Default.*
  • CUSTOM : TypeFilter 이라는 인터페이스를 구현해서 처리
    ex) org.example.MyTypeFilter
@ComponentScan(
	includeFilters = {
    	@Filter(type = FilterType.ANNOTATION, classes = MyIncludeCompnont.class),
    },
    excludeFilters = {
    	@Filter(type = FilterType.ANNOTATION, classes = MyExclueComponent.class),
        @Filter(type = FilterType.ASSIGNABLE_TYPE, classes = BeanA.class
    }
)

@Component 면 충분하기 때문에 거의 사용될 일은 거의 없다.
여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.
특히 스프링 부트는 컴포넌트 스캔을 기본적으로 제공하는데, 개인적으로 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고, 선호하는 편이다.

중복 등록과 충돌

자동 vs 자동 출동

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

수동 vs 자동 출동

  • 수동 빈과 자동 빈이 출동하게되면 수동 빈 등록이 우선권을 가진다.
  • 수동 빈이 자동 빈을 오버라이딩 한다.
Overriding bean definition for bean 'memoryMemberRepository' with a different
definition: replacing

의도적으로 했다면 상관없지만, 여러 설정들이 꼬여서 이런 결과가 만들어지는 경우가 대부분이다.
그래서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다.

Consider renaming one of the beans or enabling overriding by setting
spring.main.allow-bean-definition-overriding=true
profile
I'm kooks

0개의 댓글