Backend/Spring

[Spring]스프링 핵심원리_컴포넌트 스캔

초보개발자.. 2022. 2. 24. 12:06

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

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

 

코드

AppConfig

package hello.core;

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


@Configuration
@ComponentScan(
		excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
	
}

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

기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다는 점이 특징입니다.

 

컴포넌트 스캔은 이름 그대로 @Component 어노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록하는 과정을 진행합니다.

이제 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 어노테이션을 붙여주겠습니다.

이전에 AppConfig에서는 @Bean으로 직접 설정 정보를 작성했고, 의존 관계도 직접 명시하였습니다. 하지만 이제는 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 합니다.

@Autowired는 의존관계를 자동으로 주입해주는 어노테이션임으로 @Autowired를 활용하겠습니다.

 

테스트 코드

AutoAppConfigTest

package hello.core.scan;

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

import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import hello.core.AutoAppConfig;
import hello.core.member.MemberService;

public class AutoAppConfigTest {
	@Test
	void basicScna() {
		AnnotationConfigApplicationContext ac= new AnnotationConfigApplicationContext(AutoAppConfig.class);
		MemberService memberService= ac.getBean(MemberService.class);
		assertThat(memberService).isInstanceOf(MemberService.class);
	}

}

아래의 로그를 보면 컴포넌트 스캔이 잘 작동되는 것을 확인할 수 있습니다.

 

컴포넌트 스캔과 자동 의존관계 주입이 어떻게 동작하는지 알아봅시다.
1.ComponentScan

  • @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록합니다.
  • 이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용합니다.
    • 빈 이름 기본전략: MemberServiceImpl 클래스 -> memberServiceImpl

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

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

 

탐색 위치와 기본 대상

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

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

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

basePackages: 탐색할 패키지의 시작 위치를 지정합니다. 이 패키지를 포함해서 하위 패키지를 모두 탐색합니다.

basePackages = {"hello.core","hellos.service"}이렇게 여러 시작 위치를 지정할 수도 있습니다.

basePackageClasses:지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.

만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

권장하는 방법

패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다. 이것은 최근 스프링 부트도 이 방법을 기본으로 제공합니다.

 

예를 들어 프로젝트가 다음과 같은 구조라면

 

com.hello

com.hello.service

com.hello.repository

 

com.heelo -> 프로젝트 시작 루트, 여기에 AppConfig 같은 메인 설정 정보를 두고, @ComponentScan 어노테이션을 붙이고, basePackages 지정은 생략합니다.

 

이렇게 하면 com.hello를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 됩니다. 그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋습니다.

참고로 스프링 부트를 사용하면 스프링 부투의 대표 시작 정보인 @SpringBootApplication를 프로젝트 시작 루트 위치에 두는 것이 관례입니다.(그렇게 한다면 SpringBootApplication안에 있는 ComponentScan이 전부 Scan 하기 때문에)

 

컴포넌트 스캔 기본 대상

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

@Component: 컴포넌트 스캔에서 사용

@Controller : 스프링 MVC 컨트롤러에서 사용

@Service : 스프링 비즈니스 로직에 사용

@Repository : 스프링 데이터 접근 계층에서 사용

@Configuration:스프링 설정 정보에서 사용

 

해당 클래스의 소스 코드를 보면 @Component를 포함하고 있는 것을 알 수 있습니다.

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

@Controller: 스프링 MVC 컨트롤러로인식
@Repository: 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다. 

@Configuration: 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.
@Service: 사실 @Service는특별한처리를하지않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나라고 비즈니스 계층을 인식하는데 도움이 된다.