섹션6. 컴포넌트 스캔

wnajsldkf·2023년 1월 5일
0

스프링 핵심 원리-기본편

목록 보기
7/9
post-thumbnail

김영한 선생님의 스프링 핵심 원리 - 기본편 강의를 듣고 정리하였습니다.

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

스프링 빈을 등록할 때는 자바 코드의 @Bean 애노테이션을 사용하거나 <bean>을 통해서 설정 정보에 직접 증록할 스프링 빈을 나열한다. 이 경우, 등록해야 할 빈이 많아지면 하나하나 등록하는 과정이 복잡하다. 스프링에서는 설정 정보 없이 자동으로 스프링 빈을 등록할 수 있는 컴포넌트 스캔이라는 기능을 제공한다. 또한 의존관계를 자동으로 주입하는 @Autowired라는 기능을 제공한다.

AutoAppConfig.java

package hello.core;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

@Configuration
@ComponentScan(
	// 내용 작성
)

public class AutoAppConfig {

}

컴포넌트 스캔을 사용하려면 @ComponentScan을 설정 정보에 붙이면, 기존의 @Bean으로 등록된 클래스가 없다.

+) 컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보가 자동으로 등록되어, 설정 정보가 함께 등록되어 실행된다. excludeFilters를 이용하면 설정 정보는 컴포넌트 스캔 대상에서 제외하고 탐색할 수 있다.

컴포넌트 스캔 대상은 @Component 애노테이션을 붙이면 해당 클래스를 스캔해서 스프링 빈으로 등록한다.

+) @Configuration 애노테이션을 확인하면 @Component 애노테이션이 붙어있기 때문에 스캔이 된다.

각 클래스가 컴포넌트 스캔 대상이 되로고 @Component 애노테이션을 추가한다.
MemoryMemberRepository @Component 추가

@Component
public class MemoryMemberRepository implements MemberRepository {
	...
}

RateDiscountPolicy @Component 추가

@Component
public class RateDiscountPolicy implements DiscountPolicy {
	...
}

AppConfig 사용 시 @Bean으로 직접 설정 정보를 작성했고, 의존 관계를 명시했다. @Component 애노테이션 사용 시, 설정 정보가 없기 때문에 의존관계 주입을 클래스 안에서 해결해야 한다.
이는 @Autowired라는 기능을 생성자에 추가하면, MemberRepository 타입에 맞는 것을 찾아와서 자동으로 의존관계를 주입하여 해결할 수 있다.
MemberServiceImpl.java

@Component
public class MemberServiceImpl implements MemberService {
    private final MemberRepository memberRepository;

    @Autowired  
    // 자동으로 MemberRepository를 생성한 것을 찾아와서 자동으로 의존관계를 주입해준다. 
    // 디테일하게 다르지만, `ac.getBean(MemberRepository.class)`과 비슷하다.
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
}

간단하게 스캔을 위한 코드를 작성하여 확인해보면,
AutoAppConfigTest.java

public class AutoAppConfigTest {

    @Test
    void basicScan() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

로그를 확인해보면 @ComponentScan이 잘 동작하는 것을 확인할 수 있다.

12:19:03.519 [main] DEBUG org.springframework.context.annotation.ClassPathBeanDefinitionScanner - Identified candidate component class: file [/Users/mywnajsldkf/Desktop/ongoing/study/스프링 핵심 원리/core/out/production/classes/hello/core/discount/RateDiscountPolicy.class]
12:19:03.523 [main] DEBUG org.springframework.context.annotation.ClassPathBeanDefinitionScanner - Identified candidate component class: file [/Users/mywnajsldkf/Desktop/ongoing/study/스프링 핵심 원리/core/out/production/classes/hello/core/member/MemberServiceImpl.class]
12:19:03.524 [main] DEBUG org.springframework.context.annotation.ClassPathBeanDefinitionScanner - Identified candidate component class: file [/Users/mywnajsldkf/Desktop/ongoing/study/스프링 핵심 원리/core/out/production/classes/hello/core/member/MemoryMemberRepository.class]
12:19:03.524 [main] DEBUG org.springframework.context.annotation.ClassPathBeanDefinitionScanner - Identified candidate component class: file [/Users/mywnajsldkf/Desktop/ongoing/study/스프링 핵심 원리/core/out/production/classes/hello/core/order/OrderServiceImpl.class]

컴포넌트 스캔과 자동 의존 관계 주입은 어떻게 동작할까?

1. 컴포넌트 스캔

@Component	
// 스프링 컨테이너: 스프링 빈 저장소(빈 이름: memberServiceImpl, 빈 객체: MemberServieImpl@x01)
public class MemberServiceImpl implements MemberService {
}

@Component
// 스프링 컨테이너: 스프링 빈 저장소(빈 이름: orderServiceImpl, 빈 객체: OrderServieImpl@x02)
public class OrderServiceImpl implements OrderService {
}

@Component
// 스프링 컨테이너: 스프링 빈 저장소(빈 이름: memoryMemberServiceImpl, 빈 객체: MemoryMemberServieImpl@x03)
public class MemoryMemberRepository implements MemberRepository {
}

@Component
// 스프링 컨테이너: 스프링 빈 저장소(빈 이름: rateDiscountPolicy, 빈 객체: RateDiscountPolicy@x04)
public class RateDiscountPolicy implements DiscountPolicy {
}

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

스프링 빈 기본 이름
클래스명을 사용하되, 맨 앞글자만 소문자를 사용한다.

  • 빈 이름 기본 전략: MemberServiceImpl -> memberServiceImpl
  • 빈 이름 직접 지정: 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("meberService") 처럼 이름을 직접 부여한다.

2. 의존관계 자동 주입

@Component
public class MemberServiceImpl implements MemberService {
    private final MemberRepository memberRepository;

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

생성자에 @Autowird를 지정하며, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아 주입한다. 조회 전략은 타입이 같은 빈을 찾아서 주입한다.

  • (getBean(MemberRepository.class)와 동일하다고 이해하면 된다!) 
@Component
public class MemberServiceImpl implements MemberService {
    private final MemberRepository memberRepository;

	@Autowired
    public MemberServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
	}
}

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

탐색 위치와 기본 스캔 대상

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

@ComponentScan(
		basePackages = "hello.core",  
        basePackageClasses = AutoAppConfig.class
)
  • basePackages: 탐색할 패키지의 시작 위치를 지정한다. 해당 패키지를 포함해서 하위 패키지를 모두 탐색한다.
    • basePackages = {"hello.core", "hello.service"} 등 여러 시작 위치를 지정할 수 있다.
  • basePackageClasses: 지정한 클래스의 패키지를 탐색 시작 패키지로 지정한다.
  • 탐색을 시작할 패키지를 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스가 패키지의 시작 위치가 된다. 여기서는 AutoAppConfig가 위치해있는 가장 상위의 hello.core부터 탐색을 시작한다.

강의에서는 탐색할 패키지 위치를 지정하지 않고, 설정 정보 클래스를 프로젝트 최상단에 둘 것을 제안한다.

  • com.hello
  • com.hello.service
  • com.hello.repository
    이와 같은 구조에서 com.hello가 시작 루트이고, 설정 정보를 위치에 두고 @ComponentScan 애노테이션을 붙인다. basePackages는 생략한다.
    이러면 com.hello를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다. 또한 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다.
    실제 스프링 부트의 시작 정보인 @SproingBootApplication을 확인해보면 설정 안에 @ComponentScan이 있는 것을 확인할 수 있다.

컴포넌트 스캔 대상

@Component 애노테이션 뿐만 아니라 다음의 내용도 자동으로 스캔 대상에 포함된다. 스캔 외에도 다음 애노테이션이 있으면 스프링은 부가 기능을 수행한다.

  • @Component: 컴포넌트 스캔에서 사용
  • @Controller: 스프링 MVC 컨트롤러에서 사용, 컨트롤러로 인식
  • @Service: 스프링 비즈니스 로직에서 사용, 개발자들이 핵심 비즈니스 계층을 인식하는데 도움을 줌
  • @Repository: 스프링 데이터 접근 계층에서 사용, 스프링 데이터 접근 계층으로 인식하고 데이터 계층의 예외를 스프링 예외로 변환함
  • @Configuration: 스프링 설정 정보에서 사용, 스프링 빈이 싱글톤을 유지하도록 추가 처리함

각각 클래스의 소스 코드를 확인해보면 모두 @Component 애노테이션을 포함하고 있는 것을 확인할 수 있다.

@Component
public @interface Controller {
}

@Component
public @interface Service {
}

@Component
public @interface Configuration {
}

애노테이션은 상속 개념이 아니다. 따라서 이 기능은 자바가 아닌, 스프링에서 지원하는 기능이다.
+) useDefaultFilters 옵션을 끄면 스캔 대상들이 제외된다.

필터

스캔에 포함할 것과 포함하지 않을 것들을 설정할 수 있다.

@ComponentScan{
	includeFilters = {
    	@Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class)
   },
    excludeFilters = {
    	@Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
   }
}
  • includeFilters: MyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.
  • excludeFilters: MyExcludeComponent 애노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않는다.

FilterType 옵션

FilterType은 5가지 옵션이 있다.

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

만약 BeanA를 스캔 대상에서 빼고 싶다면, 다음과 같이 추가한다.

@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)
   }
}

+) includeFilters의 기능은 @Component로 충분하기 때문에 사용할 일이 없다. excludeFilters는 여러 이유로 충분히 사용되지만 많지는 않다.
최근에는 스프링 부트에서 컴포넌트 스캔을 기본으로 제공하기 때문에 별도로 옵션을 변동하기보다 주어진 설정에 맞추어서 사용하는 것을 권장한다.

중복 등록과 충돌

컴포넌트 스캔에서 자동 빈 등록 vs 자동 빈 등록, 수동 빈 등록 vs 자동 빈 등록 상황에서 같은 빈 이름이 등록될 수 있다.

자동 빈 등록 vs 자동 빈 등록

컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되었을 경우, 스프링에서 ConflictingBeanDefinition 이라는 이미 빈이 있음을 나타내는 오류 메시지가 나온다.

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

이러한 버그는 현실적으로 개발자가 의도하기보다 꼬여서 발생한 경우가 많아 잡기 어렵다.
따라서 최근 스프링 부트에서는 수동 빈 등록과 자동 빈 등록이 충돌나면 오류가 발생하도록 기본 값을 바꾸었다. 스프링 부트인 CoreApplication을 실행해보면 오류를 확인할 수 있다.

profile
wnajsldkf
https://mywnajsldkf.tistory.com -> 이사 중
이전 포스트

섹션5. 싱글톤 컨테이너

다음 포스트

섹션8. 빈 생명주기 콜백

0개의 댓글