[Spring] @ComponentScan (컴포넌트 스캔)

 

 

@ComponentScan

• @ComponentScan은 @Component 및 Stereo Type(@Service, @Repository, @Controller)이 부여된 클래스들을 자동으로 스캔하여 스프링 빈으로 등록해주는 역할을 한다.
• 빈으로 등록될 준비를 마친 클래스들은 스캔하여 스프링빈으로 등록해주는 것이다.
  • 빈으로 등록될 준비란, 클래스에 @Component 및 Stereo Type 애노테이션을 붙이는 행위를 말한다.
• 이전에는 xml 파일에 <context:component-scan base-package="패키지경로"/> 을 이용해 지정해주었던 것을 java 파일을 이용하여 스프링 빈을 스캔하기 위해 생겨났다.
• 어떤 애노테이션을 스캔할지 또는 하지 않을지 결정하는 Filter 기등도 가지고 있다.
• SpringBoot를 사용한다면 @SpringBootApplication 애노테이션에 @ComponentScan과 @Configuration 애노테이션이 포함되어 있다.

 

🔍 @ComponentScan의 기본 스캔 대상

• @Component : 컴포넌트 스캔에서 사용
• @Controller : 스프링 MVC 컨트롤러에서 사용
• @Service : 스프링 비즈니스 로직에서 사용
• @Repository : 스프링 데이터 접근 계층에서 사용
• @Configuration : 스프링 설정 정보에서 사용

 

🔍 @ComponentScan 동작 과정

1. @Configuration 파싱
   • ConfigurationClassParser가 @Configuration 클래스를 파싱한다.
2. @ComponenScan 설정 파싱
   • 개발자는 basePackage, basePackesClasses, excludeFilters, includeFilters, lazyInit, nameGenerator, resourcePattern, scopeProxy 등 컴포넌트들을 스캔하기 위한 설정을 정의한다.
   • ComponentScanAnnotationParser가 컴포넌트 후보를 모두 찾고, 스캔하기 위해 설정을 파싱한다.
3. 클래스 로딩
   • base-package 설정을 바탕으로 해당 범위에 속해있는 클래스를 로딩한다.
   • 클래스 로더를 이용하여 모든 자원을 Resource 인터페이스 형태로 불러온다.
4. 빈 정의 설정
   • ClassLoader가 로딩한 클래스를 BeanDefinition으로 정의한다.
   • 그리고 beanName을 key 값으로 BeanDefintionRegistry에 등록한다.
   • 생성할 빈에 대한 정의(메타 데이터)다.
5. 빈 생성 & 주입
   1. 설정한 빈 정의를 바탕으로 객체를 생성하고, 주입한다.

 

🧷 정리
Configuration 클래스 및 애노테이션에 사용하는 설정들을 파싱한다.
basePackage 의 하위 클래스들을 불러와서 Component 후보인지 확인 후 BeanDefinition (빈 생성을 위한 정의)을 만든다.
생성된 빈 정의를 바탕으로 빈을 생성하고 의존성있는 빈들을 주입한다

 

🔍 @ComponentScan 사용방법

• @ComponentScan 사용 방법은 xml 파일에 설정하는 방법과 자바 파일 안에서 설정하는 방벙이 있다.

 

💡 xml 파일에 설정

<context:component-scan base-package="com.rcod.lifelog"/>

• xml 파일에 설정하고, base-package을 적어주면 base-package 기준으로 클래스들을 스캔하여 빈으로 등록한다. base-package에 여러개의 패키지를 쓸 수 있다.

 

<context:component-scan base-package="com.rcod.lifelog, com.rcod.example"/>

• 위와 같이 설정하면, base package하위의 @Controll, @Service, @Repository, @Component 클래스가 모두 빈으로 등록되므로, 특정한 객체만 빈으로 등록하여 사용하고 싶다면 include-filter 또는 exclude-filter를 통해 설정할 수 있다.

 

✔ include-filter

<context:component-scan base-package="com.rcod.lifelog" use-default="false">
    <context:include-filter type="annotation" 
        expression="org.springframework.stereotype.Controller"/>
</context:component-scan>

• use-default="false"는 기본 애노테이션 @Controller, @Component등을 스캔하지 않는 다는 것이다.
• 기본 애노테이션을 스캔하지 않는다고 설정하고, include-filter을 통해서 특정 애노테이션만 스캔할 수 있다.

✔ exclude-filter

<context:component-scan base-package="com.rcod.lifelog">
    <context:exclude-filter type="annotation" 
        expression="org.springframework.stereotype.Controller"/>
</context:component-scan>

• @Controller를 제외하고 싶다면 exclude-filter를 사용하여 org.springframework.stereotype.Controller 를 명시한다.

 

💡 java 파일에 설정

1. 설정 클래스에 @Configuration, @ComponentScan 지정
2. 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 지정
3. @Component로 지정된 클래스에서 생성자 메서드에 @Autowired을 지정하여 의존관계 주입

 

1. 설정 클래스에 @Configuration, @ComponentScan 지정

package hello.core;

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

@Configuration
@ComponentScan
public class AutoAppConfig {}

• @Configuration을 이용하여 빈 설정파일(XML 파일을 대체하는)임을 알려준다.
• @ComponentScan 을 이용해 빈으로 등록되기 위한 애노테이션이 부여된 클래스들을 자동으로 IoC컨테이너에 등록하도록 한다.
• @ComponentScan을 사용하면 @Configuration이 붙은 설정 정보도 자동으로 스프링 IoC 컨테이너의 빈으로 등록된다.
• @Configuration의 소스코드에 @Component가 포함되어 있기 때문이다.

 

2. 각 클래스가 컴포넌트 스캔의 대상이 되도록 @Component 지정

package hello.core.member;

import org.springframework.stereotype.Component;

import java.util.HashMap;
import java.util.Map;

@Component
public class MemoryMemberRepository implements  MemberRepository{

    private  static Map<Long, Member> store = new HashMap<>();

    @Override
    public void save(Member member) {
        store.put(member.getId(), member);
    }

    @Override
    public Member findById(Long memberId) {
        return store.get(memberId);
    }
}

• @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
• 이 때 스프링 빈의 기본 이름은 클래스 명을 사용하되 맨 앞글자만 소문자를 사용한다.
• 빈 이름을 직접 지정하고 싶을 때는 @Component("원하는이름") 으로 작성한다.

 

3. @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 
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    @Override
    public void join(Member member) {
        memberRepository.save(member);
    }

    @Override
    public Member findMember(Long memberId) {
        return memberRepository.findById(memberId);
    }
}

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

 

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

 

💡 @ComponentScan 범위

✔ basePackages

@Configuration
@ComponentScan(basePackages = "com.kureungkureung.spring")
public class ApplicationConfig {}

• basePackages의 경우 괄호안에 직접 패키지 경로를 적어주어 스캔할 위치를 정한다.
• basePackages = {"hello.core", "hello.service"} 처럼 여러 시작 위치를 지정할 수도 있다.
• basePackages는 Typesafe하지 않았기 떄문에 조금만 철자가 잘못되더라도 스캔을 못하는 오류가 나타날 수 있다.

 

✔ basePackagesClasses

@Configuration
@ComponentScan(basePackageClasses = Application.class)
public class ApplicationConfig {}

• basePackageClasses의 경우에는 괄호안에 적힌 클래스가 위치한 곳에서부터 모든 애노테이션이 부여된 클래스를 빈으로 등록한다.
• basePackageClasses를 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
• basePackagesClasses는 클래스를 통해 기입하기 때문에 훨씬 Typesafe한 방법이다.

 

🧷 권장 방법

• 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다.
• 최근 스프링 부트도 이 방법을 기본으로 제공한다.
• ex) 프로젝트 구조
  • com.hello
  • com.hello.service
  • com.hello.repository
  • 이렇게 있다고 가정할 때,
  • com.hello 에 프로젝트 시작 루트인 AppConfig같은 메인 설정 정보를 두고 @ComponentScan 을 붙이고 basePackages 지정을 생략한다.
• 참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication을 프로젝트 시작 루트 위치에 둬야한다.

 

💡 필터

✔ includeFilters

• 컴포넌트 스캔 대상을 추가로 지정한다.
• @Component 를 써도 충분하기 때문에 includeFilters를 사용할 일은 거의 없다.

package hello.core.scan.filter;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented

public @interface MyIncludeComponent { }

package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA { }

 

📍 @Target

• 애노테이션이 적용할 위치를 선택한다.
• 애노테이션이 생성될 수 있는 위치를 지정한다.

 

• ElementType.PACKAGE : 패키지 선언
• ElementType.TYPE : 타입 선언
• ElementType.ANNOTATION_TYPE : 애노테이션 타입 선언
• ElementType.CONSTRUCTOR : 생성자 선언
• ElementType.FIELD : 멤버 변수 선언
• ElementType.LOCAL_VARIABLE : 지역 변수 선언
• ElementType.METHOD : 메서드 선언
• ElementType.PARAMETER : 메소드의 파라미터로 선언된 객체에서만 사용 가능
• ElementType.TYPE_PARAMETER : 전달인자 타입 선언
• ElementType.TYPE_USE : 타입 선언

 

📍 @Retention

• 해당 애노테이션이 언제까지 유지할지 알려주는 애노테이션이다.
• 자기 자신이 어느 시점까지 유효한지를 명시해줘야한다.

 

• RetentionPolicy.SOURCE : 컴파일 전까지만 유효. (컴파일 이후에는 사라짐)
• RetentionPolicy.CLASS : 컴파일러가 클래스를 참조할 때까지 유효.
• RetentionPolicy.RUNTIME : 컴파일 이후에도 JVM에 의해 계속 참조가 가능. (리플렉션 사용)

 

📍 @Documented

• 메타 데이터 애노테이션이다.
• 문서에 애노테이션의 정보가 표현된다.
• 애노테이션을 정의할 때, @Documented형태로 적용하여, 해당 애노테이션을 사용하는 클래스가 javadoc과 같은 문서화 될 때, 해당 애노테이션이 적용 되었음을 명시하도록 한다.

 

✔ excludeFilters

• 컴포넌트 스캔에서 제외할 대상을 지정한다.
• excludeFilters는 여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.

package hello.core.scan.filter;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented

public @interface MyExcludeComponent { }

package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB { }

• 스프링 부트는 컴포넌트 스캔을 기본으로 제공한다. 옵션을 변경하면서 사용하기 보다는 스프링의 기본 설정에 최대한 맞추어 사용하는것이 좋다.

 

@ComponentScan(
 includeFilters = @Filter(type = FilterType.ANNOTATION, classes =

MyIncludeComponent.class),
 excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =

MyExcludeComponent.class)
)

• includeFilters에 MyIncludeConponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.
• excludeFilters에 MyExcludeComponent 애노테이션을 추가해서 BeanB는 스프링 빈에 등록되지 않는다.

 

 

 

 

 

 

 

---

👀 참고 영상

스프링 핵심원리 - 기본편 (인프런 - 김영한)

https://jess-m.tistory.com/14

https://galid1.tistory.com/510

https://velog.io/@hyun-jii/%EC%8A%A4%ED%94%84%EB%A7%81-component-scan-%EA%B0%9C%EB%85%90-%EB%B0%8F-%EB%8F%99%EC%9E%91-%EA%B3%BC%EC%A0%95

https://jjingho.tistory.com/9