[스프링 핵심 원리] 4. 컴포넌트 스캔

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

---

지금까지 스프링 빈을 등록할 때, 자바의 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정정보에 직접 등록할 스프링 빈을 나열했었다. 하지만 이런 식으로 하다보면 수십, 수백 개의 빈을 일일이 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생할 수 있다.

 

그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다. 또한 의존관계도 자동으로 주입하는 @AutoWired 라는 기능을 제공한다

 

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

• @ComponentScan을 설정 정보에 붙여주면 컴포넌트 스캔을 사용 가능하다
• 기존의 AppConfig 클래스에서는 @Bean으로 등록한 클래스들이 있었는데 더 이상 없다

 

@Component
 public class MemoryMemberRepository implements MemberRepository {}
 
 
 
 @Component
 public class MemoryMemberRepository implements MemberRepository {}
 
 
 
 @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 어노테이션이 붙은 클래스들을 스캔해서 스프링 빈으로 등록한다
• @Autowired는 의존 관계를 자동으로 주입한다.

 

컴포넌트 스캔과 자동 의존관계 주입이 동작하는 방식

1. 컴포넌트 스캔을 통한 스프링 빈 등록

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

 

2. @Autowired 의존 관계 자동 주입

• 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 의존 관계를 주입한다.
• 생성자에 파라미터가 아무리 많더라도, 다 찾아서 자동으로 주입한다.

 

탐색 위치와 기본 스캔 대상

---

탐색할 패키지의 시작 위치 지정

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

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

권장하는 방법
패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다.

 

컴포넌트 스캔 기본 대상

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

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

 

 

필터

---

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

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

}

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

}


@MyIncludeComponent
public class BeanA {

}


@MyExcludeComponent
public class BeanB {

}

 

 

FilterType 옵션

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

 @ComponentScan(
  includeFilters = {
        @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
  },
  excludeFilters = {
        @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class),
        @Filter(type = FilterType.ASSIGNABLE_TYPE, classes = BeanA.class)
  }
 )

 

 

중복 등록과 충돌

---

컴포넌트 스캔에서 같은 빈 이름이 등록되면 어떻게 될까?

 

자동 빈 등록 vs 자동 빈 등록

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

• ConflictingBeanDefinitionException 예외 발생

 

수동 빈 등록 vs 자동 빈 등록

수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌되면 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩 해버린다)

@Component
 public class MemoryMemberRepository implements MemberRepository {}

@Configuration
@ComponentScan(
        excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
 )
 public class AutoAppConfig {
    @Bean(name = "memoryMemberRepository")
    public MemberRepository memberRepository() {
         return new MemoryMemberRepository();
    }
 }

 

최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다