[Spring boot] 6. 컴포넌트 스캔

김영한 스프링 핵심 원리 - 기본편 정리

스프링 핵심 원리 - 기본편 - 인프런 | 강의

목차

• 컴포넌트 스캔과 의존관계 자동 주입 시작하기
• 탐색 위치와 기본 스캔 대상
• 필터
• 중복 등록과 충돌

 

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

---

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

 

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

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

 

컴포넌트 스캔

@Component 어노테이션이 붙은 클래스를 스캔해서 스프링 빈으로 등록한다.

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

 

각 클래스 컴포넌트 스캔의 대상이 되도로 @Component 애노테이션을 붙여준다.

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

 

@Autowired 추가 및 Test

• @Autowired를 사용하면 생성자에서 여러 의존 관계도 한 번에 주입받을 수 있다.
• "AnnotationConfigApplicationContext"를 사용하는 것은 기존과 동일하다.
• 설정 정보로 AutoAppConfig 클래스를 넘겨준다.
• 로그를 잘 보면 컴포넌트 스캔이 잘 동작하는 것을 확인할 수 있다.

 

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

1. @Componentscan

• @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
• 이 때 스프링 빈의 기본 이름은 클래스 명을 사용하되 맨 앞글자만 소문자를 사용한다.
  • 직접 지정 : @Component("지정하고 싶은 이름")

 

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

• 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.
• 이때 기본 조회 전략은 타입이 같은 빈을 찾아 주입한다.
  • ac.getBean(MemberRepository.class) 코드와 같은 역할
  • 더 자세한건 뒤에

 

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

 

탐색 위치와 기본 스캔 대상

---

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

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

@ComponentScan(
	basePackages = "hello.core";
)

// 여러 시작 위치 지정
@ComponentScan(
	basePackages = {"hello.core", "hello.service"};
)

• basePackages
  • 탐색할 패키지의 시작 위치를 지정한다.
  • 이 패키지를 포함해 하위 패키지를 모두 탐색한다.
• basePackageClasses
  
  • 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.
• 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

권장하는 방법

• 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다.
• 최근 스프링 부트도 이 방법을 기본으로 제공한다.

ex)

• com.hello
• com.hello.service
• com.hello.repository
  
  
• 에서 com.hello가 프로젝트 시작 루트다.
• 여기에 AppConfig 같은 메인 설정 정보를 두고,
• @ComponentScan 애노테이션을 붙이고, basePackages 지정은 생략한다.

이렇게 하면 com.hello를 포함한 하위는 모두 자동으로 컴포넌트 스캔의 대상이 된다.
그리고 프로젝트 메인 설정 정보는 프로젝트를 대표하는 정보이기 때문에 프로젝트 시작 루트 위치에 두는 것이 좋지 않을까.

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

 

컴포넌트 스캔 기본 대상

컴포넌트 스캔은 다음 내용을 대상에 포함한다.

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

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

 

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

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

 

 

필터

---

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

FilterType 옵션

ANNOTATION	기본값, 애노테이션을 인식해 동작한다.
ASSIGNABLE_TYPE	지정한 타입과 자식 타입을 인식해 동작한다.
ASPECTJ	AspectJ 패턴 사용
REGEX	정규 표현식
CUSTOM	TypeFilter라는 인터페이스를 구현해서 처리

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

 

 

중복 등록과 충돌

---

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

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

 

자동 빈 등록 vs 자동 빈 등록

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

 

수동 빈 등록 vs 지동 빈 등록

• 만약 수동 빈 등록과 자동 빈 등록에서 이름이 충돌되면
• 이 경우 수동 빈 등록이 우선권을 가진다.
• 수동 빈이 자동 빈을 오버라이딩 해버린다.

• 개발자가 의도적으로 이런 결과를 기대했을 수 있다.
• 하지만 현실은 개발자가 의도적으로 설정해 이런 결과가 만들어지기 보다는 여러 설정이 꼬여 이런 결과가 만들어지는 경우가 대부분이다.
• 그러면 정말 잡기 어려운 버그가 만들어진다. 항상 잡기 어려운 버그는 애매한 버그다.

 

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