Spring

[Spring] @ComponentScan 🌱

woochii 2023. 8. 20. 22:32
728x90
반응형

컴포넌트 스캔

  • 지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean>을 통해 설정 정보에 직접 등록할 스프링 빈을 나열했다.
  • 예제에서는 몇개가 안되었지만, 이렇게 등록해야 할 스프링 빈이 수십, 수백개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생한다.
  • 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 @ComponentScan기능을 제공한다.
  • 또 의존관계도 자동으로 주입하는 @Autowired 라는 기능도 제공한다.

 

@Autowired

  • @Autowired는 의존 관계를 자동으로 주입해준다.

MemberServiceImpl

@Component
public class MemberServiceImpl implements MemberService {
    private final MemberRepository memberRepository;
     
    @Autowired
    public MemberServiceImpl(MemberRepository memberRepository) {
				this.memberRepository = memberRepository;
    }
}
  • 이전에 AppConfig에서는 @Bean 으로 직접 설정 정보를 작성했고, 의존 관계도 직접 명시했다.
    이젠 이런 설정 정보가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다.

OrderServiceImpl

@Component
public class OrderServiceImpl implements OrderService {
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    @Autowired
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
}
  • @Autowired를 사용하면 생성자에서 여러 의존관계도 한번에 주입받을 수 있다.

 

 

package hello.core;
 
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import static org.springframework.context.annotation.ComponentScan.*;
 
@Configuration
@ComponentScan(
    excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {}
  • 컴포넌트 스캔을 사용하려면 먼저 @ComponentScan을 설정 정보에 붙여주면 된다.
  • 기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다.

참고

컴포넌트 스캔을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 등록되기 때문에 AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행된다. 그래서 excludeFilters를 이용해서 설정 정보는 컴포넌트 스캔 대상에서 제외했다.

컴포넌트 스캔은 이름 그대로 @Component 어노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.

참고 

@Configuration이 컴포넌트 스캔의 대상이 된 이유도 @Configuration 소스 코드를 열어보면 @Component 어노테이션이 붙어있기 때문이다.

package hello.core.scan;
 
import hello.core.AutoAppConfig;
import hello.core.member.MemberService;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import static org.assertj.core.api.Assertions.*;
 
public class AutoAppConfigTest {
    @Test
    void basicScan() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);
        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}
  • AnnotationConfigApplicationContext 를 사용하는 것은 기존과 동일하다.
  • 설정 정보로 AutoAppConfig 클래스를 넘겨준다.
  • 실행해보면 기존과 같이 잘 동작하는 것을 확인할 수 있다.

 

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

1. @ComponentScan

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

 

2. @Autowired

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

 

 

탐색 위치와 기본 스캔 대상

모든 자바 클래스를 다 컴포넌트 스캔하면 시간이 오래걸린다.

그래서 꼭 필요한 위치부터 탐색하도록 시작 위치를 지정할 수 있다.

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

 

컴포넌트 스캔 기본 대상

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

  • @Component: 컴포넌트 스캔에서 사용
  • @Controller: 스프링 MVC 컨트롤러에서 사용
    • 스프링 MVC 컨트롤러로 인식
  • @Service: 스프링 비즈니스 로직에서 사용
    • 사실 @Service는 특별한 처리를 하지 않는다. 대신 개발자들로 하여금 핵심 비즈니스 로직이 있다고 인식시키는데 도움이 된다.
  • @Repository: 스프링 데이터 접근 계층에서 사용
    • 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
  • @Configuration: 스프링 설정 정보에서 사용
    • 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

출처: 인프런 스프링 핵심 원리 - 기본편

728x90
반응형