[Spring] 스프링 핵심 원리 기본편 6) 컴포넌트 스캔

스프링 핵심 원리 - 기본편

Session 6 컴포넌트 스캔 

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

1) 컴포넌트 스캔

@Bean이나 XML의 <bean> 등을 통해 설정 정보에 직접 스프링 빈을 나열했다 → 스프링 빈이 수백개가 되면 설정 정보도 커지고 누락 등의 문제가 생김

스프링은 자동으로 스프링 빈을 등록해주는 컴포넌트 스캔이라는 기능을 제공해주고 의존관계도 자동으로 주입해주는 @Autowired라는 기능도 제공한다.

 

2) AutoAppConfig 생성

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

@ComponentScan : @Component가 붙은 클래스를 찾아서 자동으로 스프링 빈으로 등록해준다.

excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class) : 현재 AppConfig, TestConfig 등 만들어 둔 설정 정보도 등록되기 때문에 제외시켜줬다, @Configuration도 컴포넌트 스캔 대상인데 @Configuration의 소스코드를 보면 @Component가 붙어있기 때문!

 

2) @Component 추가

@Component
 public class MemberServiceImpl implements MemberService {
     private final MemberRepository memberRepository;
     
     @Autowired
     public MemberServiceImpl(MemberRepository memberRepository) {
     	this.memberRepository = memberRepository;
    }
}

MemoryMemberRepository, RateDiscountPolicy, MemberServiceImpl, OrderServiceImpl에 @Component 추가

의존관계 주입도 클래스 안에서 해결해야 하기 때문에 MemberServiceImpl, OrderServiceImpl @Autowired도 추가

 

3) 컴포넌트 스캔, 의존관계 주입 과정

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

스프링 빈의 기본 이름은 클래스명 사용(앞글자만 소문자로 변경)

스프링 빈 이름을 직접 지정하고 싶으면 @Component("지정 이름") 으로 부여

생성자에 @Autowired를 지정하면 스프링 컨테이너가 자동으로 타입이 같은 빈을 찾아서 주입

---

2. 탐색 위치와 기본 스캔 대상

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

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

basePackages : hello.core를 포함안 하위 패키지를 모두 탐색

basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정

지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치로 지정

▶ 패키지를 지정하지 않고 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것을 권장! 스프링 부트도 이 방법을 기본으로 제공

 

2) 컨포넌트 스캔 기본대상

@Component : 컴포넌트 스캔에 사용

@Controller : 스프링 MVC 컨트롤러에서 사용

@Service : 스프링 비즈니스 로직에서 사용

@Repository : 스프링 데이터 접근 계층에서 사용

@Configuration : 스프링 설정 정보에서 사용

---

3. 필터

1) 필터 테스트용 컴포넌트 생성

애노테이션 생성

// 컴포넌트 스캔 대상에 추가할 애노테이션
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent { }

// 컴포넌트 스캔 대상에 제외할 애노테이션
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent { }

 

컴포넌트 스캔 필터 설정

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

includeFilters : 컴포넌트 스캔 대상을 추가로 지정

excludeFilters : 컨포넌트 스캔에서 제외할 대상을 지정

 

2) Filter type 옵션

ANNOTAION : 기본값, 애노테이션을 인식해서 동작

ASSIGNABLE_TYPE : 지정한 타입과 자식타입을 인식해 동작

ASPECTEJ : AspectJ패턴 사용

REGEX : 정규 표현식

CUSTOM : TypeFilter하는 인터페이스 구현해서 처리

---

4. 중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하는 상황을 스프링이 처리하는 방법

 

1) 자동 빈 등록 vs 자동 빈 등록

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

ConflictingBeanDefinitionException 발생

 

2) 수동 빈 등록 vs 자동 빈 등록

수동 빈이 더 우선권을 가짐(수동 빈이 자동 빈을 오버라이딩한다)

오버라이딩 되었다고 로그에 남음

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

최근 스프링 부트는 오류 발생하게 바뀜