(Spring) @ComponentScan으로 자동 빈 생성 및 의존성 주입하기

스프링 컨테이너에서 IoC에 따라 빈을 생성하고 DI를 수행할 때 아래와 같이 설정파일인 ApplicationConfiguration.xml  또는 ApplicationConfiguraton.class 객체를 생성하여 직접 빈을 관리하곤 했다. (IoC와 DI가 뭔지 모른다면 여기로)

 

(Spring) DI, IOC와 Spring Container란 ?

 

아래는 그 예시이다.

//스프링 컨테이너 생성
ApplicationContext applicationContext = 
new AnnotationConfigApplicationContext(ApplicationConfiguration.class);

 

// ApplicationConfiguration 파일 예시

@Configuration
public class ApplicationConfiguration {

    @Bean
    public MemberService memberService() {
    	return new MemberServiceImpl(memberRepository());
    }
    
    @Bean
    public MemberRepository memberRepository() {
    	return new MemoryMemberRepository();
    }
    
}

그렇다면 빈을 수백, 수천 개 생성해야 한다면 어떨까? 흔한 상황은 아니겠지만 그런 상황이 발생한다면 ApplicationConfiguration을 작성할 때 꽤나 머리가 아플 것이다.

 

이런 경우를 방지하기 위해 스프링에서는 @Component 어노테이션을 통해 빈을 자동 생성하고 @Autowired 어노테이션을 통해 의존성 주입을 해주는 @ComponentScan 이라는 기능이 제공된다.

 

---

 

@ComponentScan

 

 

지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.등록해야 할 스프링 빈이 수십, 수백개가 되면 일일이 등록하기도 귀찮고, 설정 정보도 커지고, 누락하는 문제도 발생할 수 있기 때문에 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을
제공한다.

 

코드로 컴포넌트 스캔과 의존관계 자동 주입을 알아보자

 

먼저, 기존 동작방식인 위의 ApplicationConfiguration.class에서 사용하는 memberService와 memberRepository 클래스는 다음과 같다.

public class MemoryMemberRepository implements MemberRepository {
	//...로직 구현
 }

public class MemberServiceImpl implements MemberService {
	private final MemberRepository memberRepository;
    
	public MemberServiceImpl(MemberRepository memberRepository) {
		this.memberRepository = memberRepository;
	}
}

Member를 관리하는 MemberApp이라는 가상의 어플리케이션에서 아래의 명령어를 통해 스프링 컨테이너를 생성하고 빈으로 등록된 객체를 생성한다 .

//스프링 컨테이너 생성
ApplicationContext applicationContext = 
new AnnotationConfigApplicationContext(ApplicationConfiguration.class);

 

여기서 @ComponentScan을 사용하면 어떻게 될까? 기존의 ApplicationConfiguration 파일은 아래와 같이 변경된다.

// ApplicationConfiguration 파일 예시

@Configuration
@ComponentScan
public class ApplicationConfiguration {
    
}

기존과 다르게 @Bean을 사용한 스프링 빈의 생성 내용이 전부 사라졌다!

 

그렇다면 MemberService와 MemoryMemberRepository는 어떻게 바뀌었을까?

@Component
public class MemoryMemberRepository implements MemberRepository {
	//...로직 구현
 }

@Component
public class MemberServiceImpl implements MemberService {

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

@Component 어노테이션을 통해 MemberService와 MemoryMemberRepository가 스프링 빈으로 등록될 컴포넌트라는 사실을 명시하고 @Autowired 어노테이션을 통해 빈 사이의 의존성을 주입해준다. 

 

참고1: @Configuration이 붙은 설정 파일도 컴포넌트 스캔의 대상이 된다. 그 이유는 @Configuration어노테이션의 소스코드를 열어보면 @Component 애노테이션이 붙어있기 때문이다.

 

참고2: @ComponentScan 어노테이션을 사용할 수 없는 XML방식의 설정 파일에서는 
<context:component-scan base-package="경로"/>
태그를 사용하여 컴포넌트 스캔을 설정한다. 추가로 namespaces의 context를 추가해줘야 함.

 

컴포넌트 스캔과 자동 의존관계 주입이 어떻게 동작하는지 그림으로 알아보자.

 

@ComponentScan의 동작

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

 

@Autowired의 동작

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

 

@Autowired 생성자의 파라매터가 2개 이상일 때

• 생성자에 파라미터가 많아도 다 찾아서 자동으로 주입한다.
  
  

 

---

 

탐색 위치와 기본 스캔 대상

 

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

 

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

 

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

 

권장하는 방법

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

 

예를 들어서 프로젝트가 다음과 같이 구조가 되어 있으면

com.hello
com.hello.serivce
com.hello.repository

 

• com.hello 프로젝트 시작 루트, 여기에 AppConfig 같은 메인 설정 정보를 두고,
• @ComponentScan 애노테이션을 붙이고, basePackages 지정은 생략한다.

 

컴포넌트 스캔 기본 대상

컴포넌트 스캔은 @Component 뿐만 아니라 다음과 내용도 추가로 대상에 포함한다.
@Component : 컴포넌트 스캔에서 사용
@Controlller : 스프링 MVC 컨트롤러에서 사용, 스프링 MVC 컨트롤러로 인식
@Service : 스프링 비즈니스 로직에서 사용, 특별한 처리를 하지 않는다
@Repository : 스프링 데이터 접근 계층에서 사용, 데이터 계층의 예외를 스프링 예외로 변환해준다.
@Configuration : 스프링 설정 정보에서 사용, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다.

 

 

 

 

 

*본 포스팅은 김영한님의 "스프링 핵심 원리 - 기본편" 에서 학습한 내용을 기반으로 작성되었습니다.