[SpringBoot] 스프링 핵심 원리 섹션 6 | 컴포넌트 스캔 | @Bean 수동 등록과 자동 등록 | 필터

본 포스팅은 인프런 김영한 강사님의 스프링 부트 핵심 원리 강의 섹션 6을 수강하고 배운 점을 정리했습니다.

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

 

---

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

이전까지 스프링 빈을 등록하던 방법:

자바 코드에 @Bean 애노테이션을 일일이 작성하거나 XML의 를 통해서 설정정보를 직접 등록했다.

수동 등록의 단점: 등록할 빈이 많을수록 설정 정보가 커지고 누락하는 문제 발생

➡️ 설정 정보 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔 기능 제공한다.

➡️ @Autowired로 의존 관계도 자동 주입해 준다.

 

AutoAppConfig.java

package hello.core;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import static org.springframework.context.annotation.ComponentScan.*;

@Configuration
@ComponentScan(
     excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Configuration.class))

 public class AutoAppConfig {

}

✅ 컴포넌트 스캔 사용 방법: @ComponentScan을 설정 정보에 붙여주기

이때, AppConfig, TestConfig 등 앞서 만들어두었던 설정 정보도 함께 등록되고 실행되어 버리므로, ecxludeFilter를 사용해서 설정 정보는 컴포넌트 스캔 대상에서 제외한다.

 

✅ 각 클래스가 컴포넌트 스캔 대상이 되도록 설정하는 방법: ` @Component ` 애노테이션 붙여주기

 

 

MemoryMemberRepository @Component 추가

@Component
public class MemoryMemberRepository implements MemberRepository {}

 

 

RateDiscountPolicy @Component 추가

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

 

 

MemberServiceImpl @Component, @Autowired 추가

@Component
public class MemberServiceImpl implements MemberService {
 	private final MemberRepository memberRepository;
    
 	@Autowired
 	public MemberServiceImpl(MemberRepository memberRepository) { 
    	this.memberRepository = memberRepository;
 	}
}

 

➡️ 이전에는 @Bean으로 직접 설정 정보를 작성하고 의존 관계도 명시했지만, 이제는 자동 스캔 방식을 사용할 것이므로 의존 관계 주입은 ` @Autowired `를 사용한다. 

 

 

AutoAppConfigTest.java : 자동 컴포넌트 스캔 테스트

package hello.core.scan;
import hello.core.AutoAppConfig;
import hello.core.member.MemberService;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import static org.assertj.core.api.Assertions.*;

public class AutoAppConfigTest {

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

 

 

실행 결과

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

 

 

작동 원리 1. @ComponentScan 자동 스캔 후 스프링 빈 등록 

✅ @ComponentScan은 @Component 가 붙은 모든 클래스를 스프링 빈으로 등록한다.

✅ 이때 스프링 빈의 기본 이름은 클래스명의 맨 앞글자를 소문자로 바꾼 것으로 사용한다.

         ➡️ 빈 이름 기본 전략: MemberServiceImpl 클래스 → memberServiceImpl 빈

         ➡️ 빈 이름 직접 지정: @Component("myBean") 이런 식으로 괄호와 큰 따옴표 안에 이름 부여

 

 

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

생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입

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

 

---

탐색 위치와 기본 스캔 대상

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

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

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

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

✅ 권장 방법: 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것을 권장

✅ 프로젝트 메인 설정 정보 권장 위치: 프로젝트 시작 루트 위치를 권장

 

 

---

 

컴포넌트 스캔 기본 대상

컴포넌트 스캔에 포함되는 다른 애노테이션과 그의 부가기능 

@Component	컴포넌트 스캔에서 사용
@Controller	스프링 MVC 컨트롤러에서 사용 | 스프링 MVC 컨트롤러로 인식
@Service	스프링 비즈니스 로직에서 사용 | 특별한 처리는 하지 않지만 개발자들이 비즈니스 계층을 인식하는데 도움 됨
@Repository	스프링 데이터 접근 계층에서 사용 | 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
@Configuration	스프링 설정 정보에서 사용 |  스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 한다

 

 

---

필터

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

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

 

 

컴포넌트 스캔 대상에 추가할 애노테이션

package scan.filter;

import java.lang.annotation.*;

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

 

컴포넌트 스캔 대상에서 제외할 애노테이션

package hello.core.scan.filter;
import java.lang.annotation.*;

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

 

 

컴포넌트 스캔 대상에 추가할 클래스 BeanA: @MyIncludeComponent 적용

package hello.core.scan.filter;
@MyIncludeComponent
public class BeanA {
}

 

 

컴포넌트 스캔 대상에서 제외할 클래스 BeanB: @MyExcludeComponent 적용

package hello.core.scan.filter;
@MyExcludeComponent
public class BeanB {
}

 

 

설정 정보와 전체 테스트 코드

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan(){
        AnnotationConfigApplicationContext ac =
                new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);

		// BeanA 스프링 빈 등록 -> 테스트 성공
        BeanA beanA = ac.getBean("beanA", BeanA.class);
        Assertions.assertThat(beanA).isNotNull();
        
         // BeanB 스프링 빈 제외 -> 테스트 실패
        org.junit.jupiter.api.Assertions.assertThrows(
                NoSuchBeanDefinitionException.class,
                () -> ac.getBean("beanB", BeanB.class)
        );                     
    }

    @Configuration
    @ComponentScan(
    
            includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, 
            	classes = MyIncludeComponent.class),
                
            excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, 
            	classes = MyExcludeComponent.class)
    )

    static class ComponentFilterAppConfig{
    }
}

 

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

 

테스트 결과

 BeanA가 스프링 빈에 등록된다.

 

BeanB는 스프링 빈에 등록되지 않으므로 테스트에 실패한다.

 

---

FilterType 옵션

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

 

---

중복 등록과 충돌

자동 빈 등록 vs 자동 빈 등록

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

 

수동 빈 등록 vs 자동 빈 등록

➡️ 수동 빈 등록이 우선권을 가진다. (수동 빈이 자동 빈을 오버라이딩 해버린다.)

Overriding bean definition for bean 'memoryMemberRepository' with a different definition: replacing

 

 

---