Spring Framework - 컴포넌트 스캔

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

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

컴포넌트 스캔은 @Component 어노테이션이 붙은 클래스를 스캔하여 스프링 빈으로 등록함

@ComponentScan 으로 인하여 직접 @Bean으로 설정정보를 작성하고 의존관계를 직접 명시하지 않기 때문에 @Autowired 를 통해 의존관계를 자동으로 주입해 주어야 함

@Configuration
@ComponentScan
public class AutoAppConfig {    
}


@Component  // ComponentScan 에 의해 등록 되도록 @Component 사용
public class OrderServiceImpl implements OrderService {
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    @Autowired  // 직접 설정정보를 명시 하지 않고 스프링 내부에서 처리하도록 @Autowired 사용
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
}

@ComponentScan

• @ComponentScan 은 @Compnent가 붙은 모든 클래스를 스프링 빈으로 등록함
• 기본적인 네이밍은 클래스명을 그대로 사용하되 앞글자만 소문자임
  • MemberServiceImpl 클래스 -> memberServiceImpl
  • @Component(“memberServiceTest”) 와 같이 이름 지정 가능

@Autowired 의존관계 자동주입

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

탐색 위치과 기본 스캔 대상

컴포넌트 탐색 위치

모든 자바 클래스를 다 컴포넌트 스캔하면 오랜 시간이 걸리기 때문에 필요한 위치부터 탐색하도록 지정할 수 있음

@ComponentScan(
  basePackage = "hello.core",
)

• basePackage : 탐생할 패키지의 시작 위치 지정. 해당 패키지를 포함하여 하위 모든 패키지는 탐색
  • basePackage = “hello.core”, “hello.service”, 와 같이 여러 시작위치 설정 가능
• basePackageClass : 지정한 클래스 패키지를 탐생 시작 위치로 지정
• 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작위치가 됨

컴포넌트 스캔의 기본 대상

@ComponentScan은 @Component뿐만 아니라 아래 다른 어노테이션들도 스캔의 대상으로 함 또한 다음 어노테이션이 있으면 스프링은 추가 부가 기능을 수행함

• @Component
  • 컴포넌트 스캔에서 사용
• @Controller
  • 스프링 MVC 컨트롤러에서 사용
  • 스프링 MVC 컨트롤러로 인식
• @Service
  • 스프링 비즈니스 로직에서 사용
  • 틀별한 처리를 하지 않지만 개발자들의 핵심 비지니스 로직을 해당 어노테이션 하위에 구현
• @Repository
  • 스프링 데이터 접근 계층에서 사용
  • 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환
• @Configuration
  • 스프링 설정 정보에서 사용
  • 스프링 설정정보로 인식하고 스프링 빈이 싱글턴을 유지하도록 추가 처리

실제 코드를 확인해보면 @Component를 포함하고 있는것을 확인 할 수 있음

@Component
public @interface Controller {
}

@Component
public @interface Service {
}

@Component
public @interface Configuration {
}

어노테이션은 상속관계라는 것이 없음. 따라서 어노테이션이 특정 어노테이션을 들고 있는 것을 인식하는것은 자바 언어가 아닌 스프링의 기능 임

필터

컴포넌트 스캔 대상에 추가 및 제거 애노테이션 예시

package hello.core.scan.filter;

import java.lang.annotation.*;

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

package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA {
}

package hello.core.scan.filter;

import java.lang.annotation.*;

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

package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB {
}

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

중복 등록과 충돌

컴포넌트 스캔에서 빈 이름에 대하여 다음 두가지 상황이 있음

• 자동 빈 등록 vs 자동 빈 등록
• 수동 빈 등록 vs 자동 빈 등록

자동 빈 등록 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();
    }
}

이러한 경우 수동 빈 등록이 우선권을 가짐(수동 빈이 자동 빈을 오버라이딩 해버림)

# 수동 빈 등록시 출력되는 로그
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

해당 설정은 application.properties 파일에 아래 와 같이 설정으로 오버라이딩 허용, 불허용 설정 가능

spring.main.allow-bean-definition-overriding= true or false

---

참고

• 스프링 핵심 원리 - 기본편(김영한)