스프링 핵심 원리 - 기본편 [컴포넌트 스캔]

윤현우·2023년 1월 29일

Spring boot bean 컴포넌트 스캔

스프링 핵심 원리 - 기본편

목록 보기

8/11

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

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

먼저 기존 AppConfig.java는 과거 코드와 테스트를 유지하기 위해 남겨두고, 새로운
AutoAppConfig.java를 만들자.

1-1. AutoAppConfig.java

package hello.core;


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

@Configuration
@ComponentScan(
        basePackages = "hello.core",
        //AppConfig 파일이 실행되면 동시에 빈이 생성 되기 때문에, 이를 방지하기 위해 설정해둔다.
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
}

컴포넌트 스캔을 사용하려면 먼저 @ComponentScan 을 설정 정보에 붙여주면 된다.
기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다!

참고: 컴포넌트 스캔을 사용하면 @Configuration 이 붙은 설정 정보도 자동으로 등록되기 때문에, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고, 실행되어 버린다.
그래서 excludeFilters 를 이용해서 설정정보는 컴포넌트 스캔 대상에서 제외했다. 보통 설정 정보를 컴포넌트 스캔 대상에서 제외하지는 않지만, 기존 예제 코드를 최대한 남기고 유지하기 위해서 이 방법을 선택했다.

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

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

이전에 AppConfig에서는 @Bean 으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다.
이제는 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다.
@Autowired 는 의존관계를 자동으로 주입해준다. 자세한 룰은 조금 뒤에 설명하겠다.

1-2. 컴포넌트 스캔 동작 원리

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

1-3. @Autowired 동작 원리

생성자에 @Autowired 를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.

이때 기본 조회 전략은 타입이 같은 빈을 찾아서 주입한다.

getBean(MemberRepository.class) 와 동일하다고 이해하면 된다.

📌1-4. 복습 및 정리

스프링에서 싱글톤 패턴을 유지하며 스프링 빈을 생성하기 위해서는 두가지 방법이 있다.

순수 자바 코드로 스프링 빈 생성
컴포넌트 스캔

순수 자바 코드로 스프링 빈 생성

순수 자바 코드로 스프링 빈을 생성 하려면 제일 먼저 설정 정보 파일이 필요하다.(대부분 AppConfig라는 이름으로 만듬)

파일에 @Configuration 어노테이션을 붙여서 이 파일이 설정 정보임을 설정한다.

이후 @Bean 어노테이션으로 각각의 생성자에 붙여 스프링 빈을 생성한다.

@Configuration

@Configuration이 붙은 파일은 자동으로 바이트 코드가 붙은 새로운 똑같은 파일이 생겨 싱글톤 패턴을 유지할 수 있게 해준다.
@Configuration 위에 @Component 어노테이션이 붙어 설정정보 파일도 빈으로 생성된다.

컴포넌트 스캔

순수 자바 코드로 스프링 빈을 생성하려면 유지보수에는 좋지만, 수많은 빈들을 지정해야 할 때는 생산력 저하를 일으키기 때문에 컴포넌트 스캔을 사용한다.(대부분 사용)

@ComponentScan

@Configuration과 비슷하게 설정 정보에 이 어노테이션을 붙여준다.
이후 스프링 빈이 필요한 파일에 @Component 어노테이션을 붙여주면, @ComponentScan이 @Component어노테이션을 찾아 스프링 빈을 자동으로 생성한다.
- @Controller, @Service, @Repository등의 어노테이션에 @Component 어노테이션이 붙어있다.
또한 @Autowired를 사용해 알맞게 DI해준다.
@ComponentScan은 해당 어노테이션이 붙은 설정 정보 클래스의 패키지에서 부터 @Component 파일을 찾아서 스프링 빈으로 등록한다.
그리고 메인 클래스에 @SpringBootApplication 어노테이션이 붙는데, 이 어노테이션안에 바로 @ComponentScan이 들어있다.

따라서 우리는 우리가 싱글톤으로 만들기 위한 클래스들에 @Component(@Controller, @Service, @Repository 등)을 붙여주기만 하면 자동으로 스프링 빈이 생성된다!!

2. 탐색 위치와 기본 스캔 대상

2-1. 컴포넌트 스캔 기본 대상

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

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

참고: 사실 애노테이션에는 상속관계라는 것이 없다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.

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

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

3. 필터

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

4. 중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까?
다음 두가지 상황이 있다.

자동 빈 등록 vs 자동 빈 등록
수동 빈 등록 vs 자동 빈 등록

4-1. 자동 빈 등록 vs 자동 빈 등록

컴포넌트 스캔에 의해 자동으로 스프링 빈이 등록되는데, 그 이름이 같은 경우 스프링은 오류를 발생시킨다.
--> ConflictingBeanDefinitionException 예외 발생

4-2. 수동 빈 등록 vs 자동 빈 등록

만약 수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌되면 어떻게 될까?
--> 이 경우 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩 해버린다.)

수동 빈 등록시 남는 로그

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

References(참고자료)
https://www.inflearn.com/

윤현우

개발자가 되는 그날까지

이전 포스트

스프링 핵심 원리 - 기본편 [싱글톤 컨테이너]

다음 포스트

스프링 핵심 원리 - 기본편 [컴포넌트 스캔]