Study/Java&Spring

컴포넌트 스캔

kdhoooon 2021. 7. 20. 17:41

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

  • 스프링 빈을 등록할 떄 자바코드의 @Bean이나 XML의 <bean>등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열하는 방식과 자동으로 주입하는 방식 두가지가 있다.
  • 직접 빈을 일일이 등록하면 설정정보도 커지도 누락하는 문제점이 생기고 무엇보다 반복적으로 계속 적어줘야한다는 단점이 존재한다. 이를 해결하기 위해 자동주입을 한다.
  • 컴포넌트 스캔 기능을 이용해서 자동으로 스프링 빈을 등록한다.
  • 의존관계도 자동으로 주입하는 @Autowired 기능도 제공한다.

<자동 주입 예시코드>

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 {

}

위와 같은 방식으로 @ComponetScan 애노테이션을 사용하여 자동 주입을 할 수 있다.

빈으로 등록하고자 하는 클래스에서 아래와 같이 @Component 애노테이션을 붙여주면 자동으로 주입한다.

이 때, 해당 클래스의 생성자에 @Autowired 애노테이션을 통해서 자동 의존관계주입도 할 수 있다.

 

자동 의존관계 주입은 다음글에서 다루도록 하겠다.

<빈등록 클래스 예시코드>

package hello.core.member;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class MemberServiceImpl implements MemberService{

    private final MemberRepository memberRepository;

    @Autowired  //ac.getBean(MemberRepository.class) 와 같이 동작
    public MemberServiceImpl(MemberRepository memberRepository){
        this.memberRepository = memberRepository;
    }
}

 

<자동 주입이 잘 설정 됐는지 확인하기 위한 Test 코드 예시>

package hello.core.scan;

import hello.core.AutoAppConfig;
import hello.core.member.MemberService;
import hello.core.order.OrderService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import static org.assertj.core.api.Assertions.*;

public class AutoConfigTest {

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

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

 

탐색 위치와 기본 스캔 대상

  • 모든 자바 클래스를 다 컴포넌트를 스캔하면 시간이 오래걸린다. 그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 저장할 수 있다.
  • @ComponentScan(
 	basePackages = "hello.core"
)
    위와 같은 코드를 이용해서 시작 위치 패키지를 지정 가능하다.
  • basePakageClasses : 지정한 클래스의 패키지를 탐색 시작위치로 지정한다.
  • 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 기본 스캔 대상이 된다.
  • 권장하는 방법
    • 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다.

 

컴포넌트 스캔 기본 대상

  1. @Component : 컴포넌트 스캔에서 사용
  2. @Controller : 스프링 MVC 컨트롤러에서 사용, 스프링 MVC컨트롤러로 인식(스프링에서 제공하는 기능)
  3. @Service : 스프링 비즈니스 로직에서 사용, 특별한 처리를 하지는 않으나 개발자들이 핵심 비지니스 로직이 여기에있겠구나 비즈니스 계층을 인식하는데 도움이 된다.(스프링에서 제공하는 기능)
  4. @Repository : 스프링 데이터 접근 계층에서 사용, 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다. (스프링에서 제공하는 기능)
  5. @Configuration : 스프링 설정 정보에서 사용, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 함 (스프링에서 제공하는 기능)

 

필터

  • includeFilters : 컴포넌트 스캔대상을 추가로 지정한다.
  • excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.
  •  위 코드와 같이 사용한다.
  • @Configuration
@ComponentScan(includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class), excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class))
static class ComponentFilterAppConfig{ 
	...
}
  • FilterType 옵션
    1. ANNOTATION : 기본값, 애노테이션을 인식해서 동작한다.
    2. ASSIGNABLE_TYPE : 지정한 타입과 자식 타입을 인식해서 동작한다.
    3. ASPECTJ : AspectJ 패턴 사용
    4. REGEX : 정규 표현식
    5. CUSTOM : TypeFilter 이라는 인터페이스를 구현해서 처리

Component Scan 동작 과정

  1. Configuration 파싱
    • ConfigurationClassParser 가 Configuration 클래스를 파싱한다.
  2. ComponentScan 설정 내역을 파싱한다.
    • 개발자는 basePackages, basePackesClasses, excludeFilters, includeFilters, lazyInit, nameGenerator, resourcePattern, scopedProxy 등 컴포넌트들을 스캔하기 위한 설정을 할 것이다.
    • ComponentScanAnnotationParser가 컴포넌트 후보를 모두 찾고, 스캔하기 위하여 해당 설정을 파싱하여 가져온다.
  3. Class 로딩
    • 위의 basePackage 설정을 바탕으로 모든 클래스를 로딩해야 한다. (*.class)
    • 클래스로더를 이용하여 모든 자원을 Resource 인터페이스 형태로 불러온다.
  4. 빈 정의 설정
    • 클래스 로더가 로딩한 리소스(클래스)를 BeanDefinition으로 정의해놓는다. 그리고 beanName의 key값으로 BeanDefinitionRegistry에 등록해 놓는다. 생성할 빈에 대한 정의(메타데이터 같은)라고 보면 될것 같다.
  5. 빈 생성 & 주입
    • 다시 처음으로 돌아가 AbstractApplicationContext에서 보이는 finishBeanFactoryInitialization(beanFactory) 메서드에서 빈을 생성한다.
    • 위에서 설정한 빈 정의를 바탕으로 객체를 생성하고, 주입한다.

순서 정리

Configuration 클래스 및 Annotation에 사용하는 설정들을 파싱한다. 그리고 basePackage 밑의 모든 .class 자원을 불러와서 component 후보인지 확인하여 BeanDefinition(빈 생성을 위한 정의)을 만든다. 생성된 빈 정의를 바탕으로 빈을 생성하고 의존성있는 빈들을 주입한다.

 

중복 등록과 충돌

  • 결론부터 이야기 하면 자동 빈 등록과 수동 빈 등록이 겹치게 되면 수동 빈 등록이 우선 순위로 등록 된다.
  • 자동 빈 등록과 자동 빈 등록이 겹치면 오류가 발생한다.
  • 스프링부트에서 자동 빈 등록과 수동 빈 등록이 겹치게 되면 오류를 발생시킨다.