본문 바로가기
카테고리 없음

컴포넌트 스캔

by BottleCoffin 2022. 8. 25.

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

스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.

또 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공한다.

 

컴포넌트 스캔을 사용하려면 설정 정보 클래스에 @ComponentScan을 붙여주면 된다.

=> @Component 가 붙은 클래스들을 자동으로 스프링 컨테이너에 등록해준다

*** @Configuration도 내부적으로 @Component가 붙어 있다.

 

 

 

@Configuration
public class AppConfig {
    @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }
}

 

@Component
public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
}

 

 

기존 AppConfig에서는 의존관계에 대해서 명시되어 있지만 @Component를 붙이고 나면

스프링빈에 등록만 되고 의존관계에 대해 알 수가 없다.

=> 생성자에 @Autowired를 붙여주면 스프링에서 필요한 의존관계를 자동으로 주입해준다.

 

 

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

 

1. @ComponentScan

- @ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.
- 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
   빈 이름 기본 전략: MemberServiceImpl 클래스 memberServiceImpl
   빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면
   @Component("memberService2") 이런식으로 이름을 부여하면 된다

 

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

- 생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
- 이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.
   getBean(MemberRepository.class) 와 동일하다고 이해하면 된다.

  생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.

*****@Autowired가 있으면 스프링 컨테이너가 파라미터를 확인하고 파라미터의 타입으로 컨테이너에 있는지 조회 후 의존성 주입 => 타입이 같을경우?

 

 

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

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


모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래 걸린다. 그래서 꼭 필요한 위치부터 탐색하도록 시작
위치를 지정할 수 있다.

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

디폴트 설정은 @ComponentScan이 붙은 클래서의 패키지부터 하위패키지까지 찾는다.

=> 패키지 위치를 따로 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것을 권장(관례)

 

🎈 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다.

(@SpringBootApplication에 @ComponentScan이 들어있어서 Springboot를 쓰면 @ComponentScan을 쓸 필요가 없다.)

 

 

컴포넌트 스캔 기본 대상

 

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

  • @Component : 컴포넌트 스캔에서 사용
  • @Controlller : 스프링 MVC 컨트롤러에서 사용
  • @Service : 스프링 비즈니스 로직에서 사용
  • @Repository : 스프링 데이터 접근 계층에서 사용
  • @Configuration : 스프링 설정 정보에서 사용
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Service {

   /**
    * The value may indicate a suggestion for a logical component name,
    * to be turned into a Spring bean in case of an autodetected component.
    * @return the suggested component name, if any (or empty String otherwise)
    */
   @AliasFor(annotation = Component.class)
   String value() default "";

}

🎈 애노테이션에는 상속관계라는 것이 없다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능이 아닌, 스프링이 지원하는 기능이다.

 

 

컴포넌트 스캔의 용도 뿐만 아니라 다음 애노테이션(=메타정보)이 있으면 스프링은 부가 기능을 수행한다.

  • @Controller : 스프링 MVC 컨트롤러로 인식
  • @Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링의 추상화 된 예외로 변환해준다.
    (DB를 변경했을 때 예외 자체가 바뀌어서 문제가 생길 수 있기 때문에)
  • @Configuration : 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가
    처리를 한다.
  • @Service : 사실 @Service 는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에
    있겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다.

 

3. 필터

FilterType 옵션

FilterType은 5가지 옵션이 있다.

  1. ANNOTATION: 기본값, 애노테이션을 인식해서 동작한다.
    ex) org.example.SomeAnnotation
  2. ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.
    ex) org.example.SomeClass
  3. ASPECTJ: AspectJ 패턴 사용
    ex) org.example..*Service+
  4. REGEX: 정규 표현식
    ex) org\.example\.Default.*
  5. CUSTOM: TypeFilter 이라는 인터페이스를 구현해서 처리
    ex) org.example.MyTypeFilter

 

 

4. 중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면?
다음 두가지 상황이 있다.
1. 자동 빈 등록 vs 자동 빈 등록
2. 수동 빈 등록 vs 자동 빈 등록

 

자동 빈 등록 vs 자동 빈 등록

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

 

수동 빈 등록 vs 자동 빈 등록

이 경우 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩 해버린다.)

 

수동 빈 등록시 남는 로그

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

🎈스프링에서는 가능하지만 스프링부트에서는 에러가 나도록 설정되어 있다.

댓글