[스프링기본1]섹션6- 컴포넌트 스캔

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

 

@Bean은 수동으로 스프링 컨테이너에 등록할 스프링 빈을 직접 등록하는 것이고,

@Component는 자동으로 스프링 컨테이너에 스프링 빈을 등록하는 기능 입니다.

추가로 @Configuration 애노테이션도 코드를 열어보면 내부에 @Component가 붙어 있기 때문에

설정 정보 자체도 스프링 빈으로 자동으로 등록됩니다.

 

 

 

 

지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean이나 XML의 <bean> 등을 통해서 설정 정보에 직접 등록할 스프링 빈을 나열했다.
예제에서는 몇개가 안되었지만, 이렇게 등록해야 할 스프링 빈이 수십, 수백개가 되면 일일이 등록하기도 귀찮고, 
설정 정보도 커지고, 누락하는 문제도 발생한다. 역시 개발자는 반복을 싫어한다.(무엇보다 귀찮다 ㅠㅠ)

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

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

 

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

 

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)
        //Configuration이 붙은것도 스프링빈으로 되어 있어서 , 빈설정을 도와주는 클래스임으로 필터링 해야함 (컴포넌트 스캔 안되도록)
)
public class AutoAppConfig {


}

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

 

컴포넌트 스캔은 이름 그대로 @Component 애노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다. 
@Component 를 붙여주자.
참고: @Configuration 이 컴포넌트 스캔의 대상이 된 이유도 @Configuration 소스코드를 열어보면
@Component 애노테이션이 붙어있기 때문이다.
이제 각 클래스가 컴포넌트 스캔의 대상이 되도록 @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);
    }
}

이전에 AppConfig에서는 @Bean 으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다. 

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

 

package hello.core.member;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class MemberServiceImpl implements MemberService{

    //private MemberRepository memberRepository = new MemoryMemberRepository();
    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);
    }

    //테스트용
    public MemberRepository getMemberRepository(){
        return memberRepository;
    }
}

package hello.core.scan;

import hello.core.AutoAppConfig;
import hello.core.member.MemberService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class AutoAppConfigTest {
    @Test
    void basicScan(){
        //AutoAppConfig 코드 비어있다는걸 까먹지 말것 
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);
        MemberService memberService = ac.getBean(MemberService.class);
        Assertions.assertThat(memberService).isInstanceOf(MemberService.class);

    }
}

로그를 잘 보면 컴포넌트 스캔이 잘 동작하는 것을 확인할 수 있다

 

스프링은 싱글톤!!

탐색 위치와 기본 스캔 대상

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

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.member",
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION,classes = Configuration.class)
        //Configuration이 붙은것도 스프링빈으로 되어 있어서 , 빈설정을 도와주는 클래스임으로 필터링 해야함 (컴포넌트 스캔 안되도록)
)
public class AutoAppConfig {


}

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

권장하는 방법
개인적으로 즐겨 사용하는 방법은 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것
이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.
예를 들어서 프로젝트가 다음과 같이 구조가 되어 있으면
com.hello
com.hello.serivce
com.hello.repository
com.hello 프로젝트 시작 루트, 여기에 AppConfig 같은 메인 설정 정보를 두고, @ComponentScan 애노테이
션을 붙이고, basePackages 지정은 생략한다.
이렇게 하면 com.hello 를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다. 그리고 프로젝트 메인 설정
정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다 생각한다.

 

참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 이 프로젝트 시작
루트 위치에 두는 것이 관례이다. (그리고 이 설정안에 바로 @ComponentScan 이 들어있다!)

 

컴포넌트 스캔 기본 대상

컴포넌트 스캔은 @Component 뿐만 아니라 다음과 내용도 추가로 대상에 포함한다.
@Component : 컴포넌트 스캔에서 사용
@Controller : 스프링 MVC 컨트롤러에서 사용 (인터페이스 가보면 컴포넌트 스캔이 붙어있음)
@Service : 스프링 비즈니스 로직에서 사용 (인터페이스 가보면 컴포넌트 스캔이 붙어있음)
@Repository : 스프링 데이터 접근 계층에서 사용 (인터페이스 가보면 컴포넌트 스캔이 붙어있음)
@Configuration : 스프링 설정 정보에서 사용 (인터페이스 가보면 컴포넌트 스캔이 붙어있음)

 

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

 

컴포넌트 스캔의 용도 뿐만 아니라 다음 애노테이션이 있으면 스프링은 부가 기능을 수행한다.
@Controller : 스프링 MVC 컨트롤러로 인식
@Repository : 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
@Configuration : 앞서 보았듯이 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리
를 한다.
@Service : 사실 @Service 는 특별한 처리를 하지 않는다. 대신 개발자들이 핵심 비즈니스 로직이 여기에 있
겠구나 라고 비즈니스 계층을 인식하는데 도움이 된다.
참고: useDefaultFilters 옵션은 기본으로 켜져있는데, 이 옵션을 끄면 기본 스캔 대상들이 제외된다. 그냥
이런 옵션이 있구나 정도 알고 넘어가자

 

 

필터

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

 

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

package hello.core.scan.filter;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.ApplicationContext;
import
        org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.context.annotation.ComponentScan.Filter;
public class ComponentFilterAppConfigTest {
    @Test
    void filterScan() {
        ApplicationContext ac = new
                AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
        BeanA beanA = ac.getBean("beanA", BeanA.class);
        assertThat(beanA).isNotNull();
        Assertions.assertThrows(
                NoSuchBeanDefinitionException.class,
                () -> ac.getBean("beanB", BeanB.class));
    }
    @Configuration @ComponentScan(
            includeFilters = @Filter(type = FilterType.ANNOTATION, classes =
                    MyIncludeComponent.class),
            excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
                    MyExcludeComponent.class)
    )
    static class ComponentFilterAppConfig {
    }
}

참고: @Component 면 충분하기 때문에, includeFilters 를 사용할 일은 거의 없다. excludeFilters 는
여러가지 이유로 간혹 사용할 때가 있지만 많지는 않다.
특히 최근 스프링 부트는 컴포넌트 스캔을 기본으로 제공하는데, 개인적으로는 옵션을 변경하면서 사용하기 보다
는 스프링의 기본 설정에 최대한 맞추어 사용하는 것을 권장하고, 선호하는 편이다

 

물론입니다. 위의 코드를 단계별로 분석하겠습니다.

### 1. 테스트 클래스: ComponentFilterAppConfigTest

- **filterScan 메서드**: 이 메서드는 JUnit 5에서 제공하는 `@Test` 어노테이션이 붙어있어서 테스트 메서드임을 나타냅니다.
  - `ApplicationContext ac = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);`: 스프링의 `ApplicationContext`를 초기화하는데, `ComponentFilterAppConfig` 설정 클래스를 사용하여 빈들을 스캔 및 등록합니다.
  - `BeanA beanA = ac.getBean("beanA", BeanA.class);`: `ApplicationContext`에서 "beanA"라는 이름으로 등록된 `BeanA` 타입의 빈을 가져옵니다.
  - `assertThat(beanA).isNotNull();`: 가져온 `beanA`가 `null`이 아니어야 한다는 것을 검증합니다. 즉, `BeanA`가 제대로 스프링 빈으로 등록되었는지를 검사하는 코드입니다.
  - `Assertions.assertThrows(...)`: 해당 코드는 `BeanB` 타입의 빈을 가져올 때 `NoSuchBeanDefinitionException` 예외가 발생해야 한다는 것을 검증합니다. 

### 2. 설정 클래스: ComponentFilterAppConfig

- **@Configuration**: 이 클래스가 스프링의 설정 클래스임을 나타냅니다.
- **@ComponentScan**: 이 어노테이션은 스프링 빈들을 스캔하라는 지시를 나타냅니다. 그리고 `includeFilters`와 `excludeFilters`를 통해 스캔 범위를 조절할 수 있습니다.
  - `includeFilters`: `MyIncludeComponent` 어노테이션이 붙은 클래스만 빈으로 등록하라는 지시입니다.
  - `excludeFilters`: `MyExcludeComponent` 어노테이션이 붙은 클래스는 빈으로 등록하지 말라는 지시입니다.

### 3. BeanA 클래스

- **@MyIncludeComponent**: `BeanA` 클래스 위에 이 어노테이션이 붙어 있어서, `ComponentFilterAppConfig`의 설정에 따르면 이 클래스는 스프링 빈으로 등록되어야 합니다.

요약하면, 이 코드는 스프링의 ComponentScan과 필터링 기능을 이용하여 특정 어노테이션이 붙은 클래스만 빈으로 등록하도록 하는 설정을 테스트하고 있습니다.

 

 

중복 등록과 충돌

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

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

자동 빈 등록 vs 자동 빈 등록

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

ConflictingBeanDefinitionException 예외 발생

 

`ConflictingBeanDefinitionException`는 두 개 이상의 빈이 동일한 이름으로 등록될 경우에 발생하는 예외입니다. 컴포넌트 스캔 기능을 사용할 때 이러한 상황이 발생할 수 있습니다.

예제로 상황을 설명하겠습니다:

1. **두 개의 클래스가 동일한 이름의 빈으로 등록되려 할 때**

예를 들어, 두 개의 패키지(`packageA`와 `packageB`)에 동일한 클래스 이름(`SomeService`)이 있을 경우입니다.

```java
// packageA/SomeService.java
package packageA;

import org.springframework.stereotype.Component;

@Component
public class SomeService {
}
```

```java
// packageB/SomeService.java
package packageB;

import org.springframework.stereotype.Component;

@Component
public class SomeService {
}
```

2. **테스트 및 설정**

```java
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

@Configuration
@ComponentScan(basePackages = {"packageA", "packageB"})
public class AppConfig {
    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
    }
}
```

위의 코드를 실행하면, `SomeService`라는 이름의 빈을 `packageA`와 `packageB`에서 둘 다 등록하려고 시도하기 때문에 `ConflictingBeanDefinitionException` 예외가 발생합니다.

이러한 상황을 피하려면:

1. 다른 이름의 빈으로 등록하거나
2. 특정 패키지만 컴포넌트 스캔의 대상으로 설정하거나
3. `@Component("uniqueBeanName")`와 같이 빈의 이름을 직접 지정해주는 방법 등이 있습니다.

 

수동 빈 등록 vs 자동 빈 등록

만약 수동 빈 등록과 자동 빈 등록에서 빈 이름이 충돌되면 어떻게 될까?

@Component
public class MemoryMemberRepository implements MemberRepository {}

 

 -> memoryMemberRepository로 등록된다. (첫글자가 소문자로 등록된다.)

@Configuration
@ComponentScan(
 excludeFilters = @Filter(type = FilterType.ANNOTATION, classes =
Configuration.class)
)
public class AutoAppConfig {
 @Bean(name = "memoryMemberRepository")
 public MemberRepository memberRepository() {
 return new MemoryMemberRepository();
 }
}

이 경우 수동 빈 등록이 우선권을 가진다.
(수동 빈이 자동 빈을 오버라이딩 해버린다.)
수동 빈 등록시 남는 로그
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

스프링 부트인 CoreApplication 을 실행해보면 오류를 볼 수 있다.