[spring기본] 6. 컴포넌트 스캔

• 지금까지 스프링 빈을 등록할 때는 자바 코드의 @Bean을 통해 설정 정보에 직접 등록할 스프링 빈을 나열했다.
• 그러나 나중에 등록해야 할 스프링 빈이 수십 수백개가 될 수 있다.
• 그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
• 또 의존관계도 자동으로 주입하는 @Autowired 라는 기능을 제공한다.

• 이제 컴포넌트 스캔을 적용할 새 Appconfig인 AutoAppconfig을 만들어보자

• @ComponentScan 어노테이션을 적용하면, 스프링이 @Component가 붙은 클래스를 찾아 자동으로 스프링 빈에 등록한다.

• 현재 상황에서 이전에 만들어놓은 Appconfig가 등록되면 안되므로 @Configuration이 붙은 클래스는 필터링을 해준다. 여기서만 예외적으로 한 것이다. ->왜냐면 @Configuration을 열어보면 @Component 가 붙어 있어 역시 스프링 빈 스캔 대상이 되기 때문이다.
  
  

• 구현체에 @Component를 붙여 빈으로 등록해준다.

• 한가지를 더 해야 한다. 의존관계 주입이다.
• 이전에 AppConfig에서는 @Bean 으로 직접 설정 정보를 작성했고, 의존관계도 직접 명시했다. 가령 memberService는 memberRepository를 사용한다는 것을 참조값으로 넘겼다. 이제 AutoAppconfig는 이런 설정 정보 자체가 없기 때문에, 의존관계 주입도 이 클래스 안에서 해결해야 한다.
• @Autowired 는 의존관계를 자동으로 주입해준다. 구현체의 생성자에 @Autowired를 붙여주면 위 MemberRepository 타입에 맞는 스프링 빈을 알아서 찾아 넣어준다.

• orderServiceImpl에도 추가

• 이제 AutoAppconfig를 테스트하는 코드다
• MemberService 빈 조회를 해서 MemberService의 클래스가 맞는지 확인한다.

• 로그를 보면 컴포넌트 스캔이 잘 작동됨을 확인할 수 있다. 컴포넌트 스캔으로 빈이 식별됐다는 뜻이다.

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

• 위처럼 @Autowired를 붙여주면 스프링이 스프링 컨테이너에 있는 해당 파라미터 타입, 즉 여기서는 MemberRepository를 전부 뒤진다. 즉 기본 조회 전략은 타입이 같은 빈을 찾아서 주입하는 것이다
• 마치 getBean(MemberRepository.class) 와 같다고 이해하자

• 생성자에 파라미터가 많아도 다 찾아서 주입해 준다.

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

• 탐색할 패키지의 시작 위치를 지정할 수 있다.

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

• 이렇게 지정하면 member 패키지의 하위 @Component 클래스만 컴포넌트 스캔의 대상이 된다
• 이걸 지정하지 않으면 모든 자바 코드를 모두 뒤지게 되므로 이를 통해 적절히 시작 지점을 조절할 수 있다.
• basePackages = {"hello.core", "hello.service"} 이렇게 시작 위치를 여러개 정할 수도 있다.
• basePackageClasses : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• basePackageClasses를 지정하지 않으면 @ComponentScan 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다
• 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것을 권장한다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.
• 예를 들어서 프로젝트가 다음과 같이 구조가 되어 있으면

com.hello
com.hello.serivce
com.hello.repository

• com.hello는 프로젝트 시작 루트이다, 여기에 AppConfig 같은 메인 설정 정보를 두고, @ComponentScan 애노테이션을 붙이고, basePackages 지정은 생략한다.
• 이렇게 하면 com.hello 를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다.
• 그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋다.
• 참고로 스프링 부트를 사용하면 스프링 부트의 대표 시작 정보인 @SpringBootApplication 를 이 프로젝트 시작 루트 위치에 두는 것이 관례이다. (그리고 이 설정안에 바로 @ComponentScan 이 들어있다!)

컴포넌트 스캔 기본 대상

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

• 해당 클래스의 소스 코드를 보면 @Component 를 포함하고 있는 것을 알 수 있다. 즉 위 애들을 붙이면 자동으로 컴포넌트 스캔 대상이 된다.

• 사실 어노테이션에는 상속관계가 없다. 어노테이션이 특정 어노테이션을 들고 있는 것은 자바의 기능이 아니고 스프링의 기능이다.

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

필터

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

• MyIncludeComponent는 컴포넌트 스캔에 등록 MyExcludeComponent 는 컴포넌트 스캔에서 제외할 어노테이션이다.

• 위에서 만든 어노테이션을 각각 BeanA BeanB에 적용해준다.

• 테스트 코드에 includeFilters에 MyIncludeComponent, excludeFilters에 MyExcludeComponent를 지정해준다.

• BeanB는 excludeFilters의 대상이으로 컴포넌트 스캔이 되지 않는다.

• includeFilters 에 MyIncludeComponent 애노테이션을 추가해서 BeanA가 스프링 빈에 등록된다.

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

• FilterType 옵션
  FilterType은 5가지 옵션이 있다.

• 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

-> 예를 들어 BeanA도 빼고 싶으면

• 이런 식으로 excludeFilter에 ASSIFNABLE_TYPE을 사용해 지정하면 된다.

중복 등록과 충돌

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

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

자동빈등록vs자동빈등록

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

• ConflictingBeanDefinitionException 예외가 발생한다

수동빈등록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로 설정하면 오류가 발생하지 않고, false로 설정하면 오류가 발생한다.