<aside> ❗

컴포넌트 스캔

</aside>

<aside> ❗

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

• 등록해야 할 빈이 수십 수백개가 되면 일일이 등록하기 귀찮고 설정 정보도 커지고, 누락하는 문제가 발생한다.
• 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔 기능 제공
• 의존 관계도 자동으로 주입해주는 @Autowired 기능도 제공한다.

package hello.core;

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

@Configuration
// @Component 애너테이션이 붙은 클래스를 찾아서 자동으로 스프링 빈으로 등록
@ComponentScan(
        // @Configuration 내부에 @Component 애너테이션이 들어있다. 그러므로 컴포넌트 스캔시 스프링 빈으로 자동 등록됨
        // 컴포넌트 스캔으로 검색하는데 스프링 빈으로 등록하지 않을 것을 설정 (여기서는 @Configuration이 붙은 클래스를 제외)
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
        // -> Configuration 애너테이션이 붙은 클래스를 제외하겠다는 필터

)
public class AutoAppConfig {
    

}

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

[참고]

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

• 컴포넌트 스캔은 이름 그대로 @Component 애너테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다. // classPath를 모두 뒤져서 찾은 후, 빈으로 등록

[참고]

• @Configuration이 컴포넌트 스캔의 대상이 된 이유도, @Configuration 소스 코드를 보면 @Component가 붙어있다.

• @Component를 스프링 빈으로 등록할 클래스에 붙여준다.
• 단, @Component 애너테이션만 붙이면 의존관계 주입이 되지 않는다. → @Autowired 애너테이션을 생성자에 붙여서 의존관계 자동 주입을 설정한다.
• @Autowired 애너테이션을 붙여서 의존 관계를 자동으로 주입해줘야한다. ac.getBean(MemberRepository.class)를 자동으로 해주는 것과 유사

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// ac.getBean(MemberRepository.class)를 자동으로 해주는 것과 유사
    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.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import static org.assertj.core.api.Assertions.*;

public class AutoAppConfigTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

    @Test
    @DisplayName("모든 빈 출력하기")
    void findAllBean() {
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for(String beanDefinitionName : beanDefinitionNames){
            Object bean = ac.getBean(beanDefinitionName);
            System.out.println("bean = " + bean);
        }
    }

    @Test
    @DisplayName("내가 등록한 빈 출력하기")
    void findByMyApplication() {
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for(String beanDefinitionName : beanDefinitionNames){
            Object bean = ac.getBean(beanDefinitionName);
            BeanDefinition beanDefinition = ac.getBeanDefinition(beanDefinitionName);
            if(beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION){
                System.out.println("bean = " + bean);
            }
        }
    }

    @Test
    void basicScan() {
        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

• AnntaionConfigApplicationContext를 사용하는 것은 기존과 동일
• 설정 정보로 AutoAppConfig 클래스를 넘겨준다.
• 로그에 빈 등록 정보가 출력된다. </aside>

<aside> ❗

1. @ComponentScan

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

2. @Autowired 의존관계 자동 주입

• 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입 → @Component 애너테이션이 붙은 클래스를 생성하면서 스프링이 스프링 컨테이너에서 의존관계에 있는 빈을 타입으로 컨테이너에서 찾아서 주입 ** 같은 타입이 여러 개인 경우 충돌이 발생 (이후 강의에서 설명)
• 이 때, 기본 조회 전략은 [타입이 같은 빈]을 찾아서 주입한다.
  • getBean(MemberRepository.class)와 동일하다고 이해하면 됨
  • 더 자세한 내용은 뒤에서

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

<aside> ❗

컴포넌트 탐색 위치와 기본 스캔 대상

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

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

@Component(
  // hello.core 부터 탐색 시작
	basePackages = "hello.core",
)

• basePackates - 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
• basePackages = {”hello.core”, “hello.service”} 처럼 여러 시작 위치 지정 가능
• basePackageClasses - 지정한 클래스의 패키지를 탐색 시작 위치로 지정
• 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치

권장하는 방법

• 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것, 최근 스프링 부트도 이 방법을 기본으로 제공한다.
• 스프링 부트는 @SpringBootApplication를 이 프로젝트 시작 루트 위치에 두는 것이 관례 (이 설정 정보 안에 @Component가 들어있다.) </aside>

<aside> ❗

컴포넌트 스캔 기본 대상

@Component 뿐만 아니라 다음과 내용도 추가로 대상에 포함됨

@Component - 컴포넌트 스캔에서 사용

@Controller - 스프링 MVC 컨트롤러에서 사용

@Service - 스프링 비즈니스 로직에서 사용

@Repository - 스프링 데이터 접근 계층에서 사용

@Configuration - 스프링 설정 정보에서 사용

컴포넌트 스캔 뿐만 아니라, 다음 애너테이션이 있으면 스프링은 부가 기능을 수행

애너테이션은 메타 정보, 이 정보를 보고 부가 기능 수행

• @Controller - 스프링 MVC 컨트롤러로 인식
• @Repository - 스프링 데이터 접근 계층으로 인식, 데이터 계층의 예외를 스프링 예외로 변환 DB에 따라 예외가 다름 → 다른 계층도 흔들림 이를 위해 추상화해서 예외를 반환해준다.
• @Configuration - 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리
• @Service - 특별한 처리를 하지 않음, 대신 개발자들이 핵심 비즈니스 로직이 여기에 있겠구나 라고 비즈니스 계층을 인식하는데 도움이 됨 보통 @Service 계층에서 애너테이션을 걸어서 트랜잭션을 시작 → 비즈니스 로직이 시작할 때 트랜잭션이 걸려있는게 맞기 때문

[참고]

• 사실 애너테이션에는 상속관계라는 것이 없다. 특정 애너테이션을 들고 있는 것을 인식할 수 있는 것은 자바가 아닌 스프링이 지원하는 기능
• useDefaultFilters 기본으로 꺼져 있음 이 옵션을 끄면 기본 스캔 대상들이 제외된다. 그냥 이런 옵션이 있구나하고 넘어가자 </aside>

<aside> ❗

필터

includeFilter - 컴포넌트 스캔 대상을 추가로 지정

excludeFilter - 컴포넌트 스캔에서 제외할 대상 지정

• MyIncludeComponent 애너테이션 생성

// 해당 애너테이션이 붙은 클래스는 스프링 빈으로 등록하기 위해 생성 
package hello.core.scan.filter;

import java.lang.annotation.*;

// Target - 어디에 붙는지 지정할 때 사용, Type이라고 하면 클래스에 붙는 것
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}

• MyExcludeComponent 애너테이션 생성

//해당 애너테이션이 붙은 클래스는 스프링 빈으로 등록 못하도록 하기 위해 생성
package hello.core.scan.filter;

import java.lang.annotation.*;

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

• BeanA 클래스 생성

// 스프링 빈에 등록할 것 
package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA {
}

• BeanB

// 스프링 빈에 등록하지 않을 것
package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB {
}

• ComponentFilterAppConfigTest

// 애너테이션에 따라 스프링 빈이 등록되는지 안 되는지 테스트
package hello.core.scan.filter;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
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.*;
import static org.junit.jupiter.api.Assertions.*;
import static org.springframework.context.annotation.ComponentScan.*;

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(FilterConfig.class);
        assertThat(ac.getBean("beanA", BeanA.class)).isNotNull();
        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 FilterConfig {

    }
}

• includeFilters에 MyIncludeComponent 애너테이션을 추가해서 BeanA가 스프링 빈으로 등록
• excludeFilters에 MyExcludeComponent 애너테이션을 추가해서 BeanB가 스프링 빈으로 등록 X

FilterType 옵션

ANNOTAION - 기본값, 애너테이션을 인식해서 동작 (생략 가능)

ASSIGNABLE_TYPE - 지정한 타입과 자식 타입을 인식해서 동작 (클래스 직접 선택 가능)

ASPECTJ - AspectJ 패턴 사용 (패턴으로 찾아오는 것)

REGEX - 정규 표현식 (정규 표현식 사용해서 가져오는 것

CUSTOM - TypeFilter 이라는 인터페이스를 구현해서 처리 (조건을 직접 프로그래밍해서 사용)

@Component
  includeFilters = 
       @Filter(FilterType.ANNOTATION, classes = MyIncludeComponent.class)
  
  excludeFilters = {
			 @Filter(FilterType.ANNOTATION, classes = MyExcludeComponent.class),
			 @Filter(FilterType.ASSIGNABLE, classes = BeanA.class)
  }

• BeanA도 빼고 싶다면 다음과 같이 작성

[참고]

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

<aside> ❗

중복 등록과 충돌

컴포넌트 스캔에서 같은 빈 이름을 등록하면 어떻게 될까 ??

다음 두 가지 상황이 있다.

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

자동 빈 등록 VS 자동 빈 등록

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

수동 빈 등록 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`

• 만약 의도적으로 구현하고 싶으면 오버라이딩 옵션을 켜줘야 한다. application.properties에서 설정해주면 된다. spring.main.allow-bean-definition-overriding=true

**

개발에서 명확하지 않은 것은 하면 안 된다. 개발은 혼자하는 것이 아니기 때문에 애매한 상황을 만들지 않는게 좋다. 어설픈 우선순위가 있을 때, 잡기 힘든 버그가 된다. 코드를 조금 더 쓰더라도 명확한 것을 항상 선택하는 것이 베스트이다.

</aside>