스프링 - 컴포넌트 스캔

meluu_·2023년 8월 12일

스프링

🌿 컴포넌트 스캔

☘️ 컴포넌트 스캔 사용

🧫 기본 스캔 대상

⚙️ 컴포넌트 스캔 설정

💥 중복 등록과 충돌

스프링

목록 보기

4/27

🌿 컴포넌트 스캔

스프링은 @Bean을 통한 수동 빈 등록 뿐만 아니라
설정 정보가 없어도 자동으로 스프링 빈을 등록해주는 @ComponentScan,
의존관계도 자동으로 주입하는 @Autowired 기능을 제공

☘️ 컴포넌트 스캔 사용

✔️ 설정 정보

@Configuration
@ComponentScan
public class AutoAppConfig {

}

설정 정보에 @ComponentScan을 붙여주면 된다.
기존 AppConfig와 다르게@Bean으로 등록한 클래스가 하나도 없다.

💠 참고 : @Configuration 에는 @Component 이 있다.

✔️ 빈 자동 등록

@Component    // 자동 스프링 빈 등록
public class OrderServiceImpl implements OrderService {
 
 	private final MemberRepository memberRepository;
 	private final DiscountPolicy discountPolicy;
 
 	@Autowired // 의존관계 자동 주입
 	public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
	 	this.memberRepository = memberRepository;
 		this.discountPolicy = discountPolicy;
 		}
	}
}

컴포넌트 스캔의 대상이 되도록 @Component 를 붙여준다.
@Autowired를 사용하여 의존관계를 자동으로 주입
@Autowired사용시 생성자의 여러 의존관계도 한번에 주입 가능

✔️ 테스트

public class AutoAppConfigTest {
 	@Test
 	void basicScan() {
 		ApplicationContext ac = new nnotationConfigApplicationContext(AutoAppConfig.class);
	 	MemberService memberService = ac.getBean(MemberService.class);

		assertThat(memberService).isInstanceOf(MemberService.class);
	 }
}

AnnotationConfigApplicationContext 를 사용하는 것은 기존과 동일
설정 정보로 AutoAppConfig 클래스를 넘겨준다

✔️ 동작 원리

1. ComponentScan

@ComponentScan 은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록
등록된 빈의 이름은 클래스 명을 사용 (단, 앞글자만 소문자로 사용)
- 빈 이름 직접 지정 : @Component("빈 이름") 으로 부여

2. Autowired 의존관계 자동 주입

생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입
기본 조회 전략은 타입이 같은 빈을 찾아서 주입
- getBean(MemberRepository.class)와 동일하다고 이해하면 된다.
생성자의 파라미터가 많아도 다 찾아서 자동 주입

🧫 기본 스캔 대상

✔️ 컴포넌트 스캔 기본 대상

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

✔️ 부가 기능

종류	기능
@Controller	스프링 MVC 컨트롤러로 인식
@Repository	스프링 데이터 접근 계층으로 인식, 데이터 계층의 예외를 스프링 예외로 변환
@Configuration	스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리
@Service	특별한 처리를 하지 않음, 단지 비즈니스 계층을 인식하는데 도움

💠 참고 : 애노테이션은 상속관계가 없다. 애노테이션이 특정 애노테이션을 들고 있는 것을 인식 가능한 것은 스프링이 지원하는 기능

⚙️ 컴포넌트 스캔 설정

✔️ basePackages

모든 자바 클래스를 다 컴포넌트 스캔시 시간이 오래 걸림
→ 탐색 위치를 설정

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

basePackages: 탐색할 패키지의 시작 위치를 지정,
이 패키지를 포함해서 하위 패키지를 모두 탐색
basePackageClasses: 지정한 클래스의 패키지를 탐색 시작 위치로 지정
미지정 시 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치

권장
패키지 위치를 미지정, 설정 정보 클래스의 위치를 프로젝트 최상단에 위치

스프링 부트도 이방법을 기본으로 제공

스프링 부트를 사용 시 스프링 부트의 대표 시작 정보인 @SpringBootApplication을 프로젝트 시작 루트 위치에 두는 것이 관례

이 설정안에 @ComponentScan이 들어있음

✔️ Filter

includeFilters : 컴포넌트 스캔 대상을 추가로 지정

excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정

 // ex)
includeFilters = @Filter(type = FilterType.ANNOTATION,
                                classes = MyIncludeComponent.class)

FilterType 옵션

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

✔️ useDefaultFilters

기본 True , False 시 기본 스캔 대상들이 제외

✔️ lazyInit

기본 False : 바로 초기화하여 스프링 빈에 등록
True : 실제 해당 클래스가 사용될때 초기화

💥 중복 등록과 충돌

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

✔️ 1번의 경우

중복시 ConflictingBeanDefinitionException 예외 발생

✔️ 2번의 경우

수동 빈 등록이 우선권을 가짐

수동 빈이 자동 빈을 오버라이딩

// 수동 빈 등록시 남는 로그
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

🔖 학습내용 출처

스프링 핵심 원리 - 기본편