스프링 핵심 원리(6) - 컴포넌트 스캔

박정민·2021년 2월 8일
0

spring

목록 보기
14/16

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

컴포넌트 스캔

  • 스프링이 제공하는 설정 정보 없이(AppConfig) 자동으로 스프링 빈을 등록하는 기능

  • @ComponentScan
    • @Component가 붙은 모든 클래스를 자동으로 스캔하여 스프링 빈으로 등록

  • AutoAppConfig.java
@Configuration
@ComponentScan
public class AutoAppConfig {

}
  • 스프링 빈 등록이 필요한 클래스에 @Component 추가
@Component
public class MemoryMemberRepository implements MemberRepository {}

의존관계 자동주입

  • 아래 클래스는 MemberRepository와 의존적인 관계이다.
@Component
public class MemberServiceImpl implements MemberService {
    private final MemberRepository memberRepository;

    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
}
  • 이전에는 AppConfig를 통해 의존관계를 직접 명시했다.

  • 컴포넌트 스캔 방식을 사용하면 의존관계 주입을 이 클래스 안에서 해결해야 한다.

  • @Autowired : 의존관계를 자동으로 주입해준다. (자세한 내용은 다음 글 참고)

정리

1. @ComponentScan

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

  • 등록된 스프링 빈의 이름은 해당 클래스명에서 앞글자만 소문자로 바꿔서 사용한다.
    • ex) class Apple -> 빈 이름: apple
    • 빈 이름 직접 지정: @Component("원하는 빈 이름")

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

  • 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 빈을 찾아서 주입한다.

  • 해당 빈을 조회하는 기본 방식은 타입이 같은 빈을 찾는 것이다.
    • getBean(MemberRepository.class)와 비슷하다.

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

스캔할 패키지의 시작 위치 지정

  • 컴포넌트 스캔할 패키지의 시작 위치를 지정할 수 있다.
    • default: @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치
@ComponentScan(
basePackages = "hello.core",
}
  • basePackages: 스캔할 패키지의 시작 위치 지정, "hello.core"패키지부터 하위 패키지 모두 스캔

  • basePackagesClasses: 지정한 클래스의 패키지를 스캔 시작 위치로 지정

  • 스캔 시작 위치 지정 권장 방법
    • 위와 같은 방식으로 시작 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트
      최상단에 두는 방법(스프링 부트도 이 방법을 기본으로 제공)

컴포넌트 스캔 기본 대상

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

3. 스캔 필터

필터

  • includeFilters : 컴포넌트 스캔 대상을 추가로 지정
  • excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정
  • 특정 애노테이션을 붙인 타입을 컴포넌트 스캔 대상에서 제외하는 방법

컴포넌트 스캔 대상에 추가, 제외할 애노테이션

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

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

컴포넌트 스캔 대상, 제외 대상

//BeanA.java
@MyIncludeComponent
public class BeanA {
}

//BeanB.java
@MyIncludeComponent
public class BeanB {
}

설정 정보와 전체 테스트 코드

@ComponentScan(
includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
)
  • includeFiltersMyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록 O

  • excludeFiltersMyExcludeComponent 애노테이션을 추가해서 BeanB가 스프링 빈에 등록 X

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

4. 중복 등록과 충돌

자동 빈 등록과 자동 빈 등록 충돌

  • 컴포넌트 스캔에 의해 스프링 빈이 자동으로 등록될 때, 이름이 중복되면 오류 발생
    • ConflictingBeanDefinitionException예외 발생

수동 빈 등록과 자동 빈 등록 충돌

  • 스프링에서는 수동 빈이 등록 우선권을 가진다.
    • 수동 빈이 자동 빈을 오버라이딩
    • 수동빈 등록시 남는 로그
      Overriding bean definition for bean 'memoryMemberRepository' 
      with a differentdefinition: replacing
  • 스프링 부트에서는 오류가 발생하도록 기본 값을 바꾸었다.
   Consider renaming one of the beans or enabling overriding by setting
   spring.main.allow-bean-definition-overriding=true
profile
화이팅!

0개의 댓글

관련 채용 정보