[Spring] 컴포넌트 스캔

본 포스팅은 학습용으로, 김영한 님의 강의를 바탕으로 복습용도로 작성되었습니다.

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

컴포넌트 스캔

컴포넌트 스캔은 스프링이 설정 정보 없이, 자동으로 스프링 빈을 등록하는 것을 말한다.

의존관계도 자동을 주입하는 @Autowired라는 기능도 제공한다.

컴포넌트 스캔을 사용하는 예)

 

AutoAppConfig.java

package hello.core;

import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import org.springframework.stereotype.Service;

@Configuration
@ComponentScan(

        basePackages = "hello.core", //해당위치부터 찾도록 스캔범위 설정, 해당 코드가 없으면, 모든 자바코드까지 다 탐색하므로 비효율적이다.
        //자동으로 컴포넌트 스캔을 하지 않을 configuration 제외
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
        //디폴트는 해당 컴포넌트스캔이 붙은 설정 정보클래스의 패키지가 시작 위치가 된다.
) // 컴포넌트 스캔
public class AutoAppConfig {

    /*@Bean(name = "memoryMemberRepository")
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }*/

    //자동과 수동 빈 등록 시, 수동으로 빈 등록한것이 우선권을 가진다.
    //개발자가 의도적으로 설정해서 이런 결과가 만들어지기 보다 설정들이 꼬여서 만들어지는 경우가 대부분이기 때문에, 스프링부트에서는
    // 수동 빈등록과 자동빈 등록이 충돌이 나면 오류가 발생하도록 기본값을 바꾸었다.

}

컴포넌트 스캔을 사용 → @ComponentScan을 설정 정보 클래스에 선언

AutoAppConfig 클래스에 아무런 소스가 없다. → @Bean으로 등록한 객체가 없다.

@ComponentScan 이 Bean으로 등록할 객체를 찾기 위해 대상 클래스에 @Component를 선언

 

@Component
public class MemberServiceImpl implements MemberService {

	 private final MemberRepository memberRepository;

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

@Bean으로 직접설정한 정보가 없기 때문에 의존관계 주입도 해당 클래스 안에서 해결해야 한다 → @Autowired는 의존관계를 자동으로 주입해 준다.

 

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

@ComponentScan

• @ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록
  • 스프링 빈의 기본 이름은 클래스명으로 사용한다. ( 단, 맨 앞글자는 소문자)
  • 빈 이름 직접 지정 → @Component(”beanName”)

@Autowired 의존관계 자동 주입

• @Autowired 가 지정된 생성자를 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다. → getBean(MemberRepository.class)와 동일하다.
• 생성자 파라미터가 두 개 이상이어도, 찾아서 자동으로 주입한다.

탐색 위치와 기본 스캔 대상

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

모든 자바 클래스를 다 컴포넌트 스캔을 하면 비효율적

꼭 필요한 위치부터 탐색하도록 위치를 지정해야 한다.

 

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

 

basePackages : 탐색할 패키지의 시작 위치를 지정하고, 지정한 패키지의 하위 패키지 모두 탐색

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

Default : @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다

⇒ 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다.

 

컴포넌트 스캔 기본 대상

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

애노테이션은 상속관계라는 개념이 없다. 애노테이션이 특정 애노테이션을 들고 있는 것을 인식하는 것은 스프링이 지원하는 기능이다.

 

컴포넌트 스캔용도 외 스프링의 부가기능

@Controller : 스프링 MVC 컨트롤러로 인식

@Repository 스프링 데이터 접근 계층으로 인식, 데이터 계층의 예외를 스프링 예외로 변환

@Configuration : 스프링 설정 정보로 인식, 스프링 빈이 싱글톤을 유지하도록 추가 처리

@Service : 특별한 처리는 없고, 개발자들이 핵심 비즈니스 로직에 집중하고 비즈니스 계층을 인식하는데 도움이 된다.

 

필터

필터는 컴포넌트 스캔 대상을 제외하고 추가하는 데 사용된다.

• includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
• excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.

 

컴포넌트 스캔 대상에서 추가할 애노테이션

package hello.core.scan.filter;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}

 

컴포넌트 스캔 대상에서 제외할 애노테이션

package hello.core.scan.filter;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
}

 

컴포넌트 스캔 대상에 추가할 클래스

package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA {
}

 

컴포넌트 스캔 대상에 제외할 클래스

package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB {
}

 

설정 클래스

@Configuration
    @ComponentScan(
            includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class), // 기본값이어서 생략해도된다. ANNOTATION
            excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
    )
    public class ComponentFilterAppConfig{

    }

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

FilterType 옵션

ANNOTATION: 기본값, 애노테이션을 인식해서 동작한다.

ex) org.example.SomeAnnotation

ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.

ex) org.example.SomeClass

ASPECTJ: AspectJ 패턴 사용

ex) org.example..Service+

REGEX: 정규 표현식

ex) org\.example\.Default.

CUSTOM: TypeFilter 이라는 인터페이스를 구현해서 처리

ex) org.example.MyTypeFilter

중복 등록과 충돌

컴포넌트 스캔에서 중복된 이름이 존재하면 어떤 현상이 발생할까?

1. 자동 빈 등록 vs 자동 빈 등록
2. 수동 빈 등록 vs 자동 빈 등록

먼저 1번과 같은 자동 빈등록끼리 충돌은 스프링에서 ConflictingBeanDefinitionException를 발생시킨다.

2번과 같은 수동 빈과 자동 빈의 등록은 우선적으로 수동 빈 등록이 우선권을 가진다.

 

수동 빈 등록 시 스프링이 남기는 로그

Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing

최근 스프링 부트에서는 수동 빈 등록과 자동 빈등록이 충돌하면 오류가 발생하도록 기본 값을 바꾸었다.

 

수동 빈 등록, 자동 빈 등록 오류시 스프링 부트 에러

Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true