[2025 1학기 스프링부트 스터디] 석준환 #6주차

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

등록해야 할 스프링 빈이 수십, 수백개가 되면 일일이 등록하기도 귀찮고,

설정 정보도 커지고, 누락하는 문제도 발생한다. 역시 개발자는 반복을 싫어한다.

그래서 스프링은 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.

또 의존관계도 자동으로 주입하는 `@Autowired` 라는 기능도 제공한다.

즉 그동안은 모든 것을 @Configuration과 @Bean 등으로 스프링 컨테이너에 등록하고 각각의 의존관계를 직접 서술하는 식으로 했다면

ComponentScan을 통해서 Component들을 등록하고 의존관계는 Autowired를 통해 등록한다.

 

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

@Configuration
@ComponentScan(
        basePackages = "hello.core",
        excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
}

컴포넌트 스캔을 사용하려면 먼저 `@ComponentScan` 을 설정 정보에 붙여주면 된다.

기존의 AppConfig와는 다르게 @Bean으로 등록한 클래스가 하나도 없다

 

기존의 AppConfig

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.member.MemoryMemberRepository;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {
    
    @Bean
    public MemberService memberService() {
        System.out.println("call AppConfig.memberService");
        return new MemberServiceImpl(getMemberRepository());
    }
    @Bean
    public MemberRepository getMemberRepository() {
        System.out.println("call AppConfig.getMemberRepository");
        return new MemoryMemberRepository();
    }
    @Bean
    public OrderService orderService() {
        System.out.println("call AppConfig.orderService");
        return new OrderServiceImpl(getMemberRepository(), getDiscountPolicy());
    }
    @Bean
    public static DiscountPolicy getDiscountPolicy() {
        return new RateDiscountPolicy();
    }

}

-> 의존 관계들을 모두 직접 서술하는 방식이면 모두 Bean으로 등록해야 하는 번거로움

 

@Component
@Primary
public class MemoryMemberRepository implements MemberRepository {

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {

@Component
public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

    @Autowired //ac.getBean(MemberRepository.class)
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

@Component
public class OrderServiceImpl implements OrderService {

    private final DiscountPolicy discountPolicy;
    private final MemberRepository memberRepository;
    //인터페이스에만 의존한다!

    @Autowired
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.discountPolicy = discountPolicy;
        this.memberRepository = memberRepository;

-@Component를 붙여서 ComponentScan으로 등록한다.

-@Autowired를 통해 의존관계를 자동으로 주입한다. 따라서 Component에 있는 memoryMemberRepository와 RateDiscountPolicy가 자동으로 사용된다.

 

package hello.core.scan;

import hello.core.AutoAppConfig;
import hello.core.member.MemberService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class AutoAppConfigTest {

    @Test
    void basicScan() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

        MemberService memberService = ac.getBean(MemberService.class);
        Assertions.assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

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

```text

ClassPathBeanDefinitionScanner - Identified candidate component class:

.. RateDiscountPolicy.class

.. MemberServiceImpl.class

.. MemoryMemberRepository.class

.. OrderServiceImpl.class

 

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

이때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.

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

빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면

@Component("memberService2")-->  이런식으로 이름을 부여하면 된다.

getBean(MemberRepository.class)` 와 동일하다

Component가 빈으로 등록되어 스프링 컨테이너에 있어서 그 중 필요로 하는 객체의 타입을 찾아서 제공

 

탐색 위치와 기본 스캔 대상

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

-`basePackages` : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.

-`basePackages = {"hello.core", "hello.service"} ` 이렇게 여러 시작 위치를 지정할 수도

있다.

-`basePackageClasses` : 지정한 클래스의 패키지를 탐색 시작 위치로 지정한다.

즉, "hello.core" 같은 문자열로 패키지 이름을 쓰는 대신,

클래스 자체를 기준으로 경로를 잡는 방법이야.

-만약 지정하지 않으면 `@ComponentScan` 이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

컴포넌트 스캔 기본 대상컴포넌트 스캔은 `@Component` 뿐만 아니라 다음과 내용도 추가로 대상에 포함한다.

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

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

`@Service` : 스프링 비즈니스 로직에서 사용 -> 특별한 처리는 없고 그저 비즈니스 로직임을 인지하는 역할의 어노테이션

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

`@Configuration` : 스프링 설정 정보에서 사용 -> 구성 설정 정보

 

 

 

 스프링 컴포넌트 스캔 필터 

@ComponentScan의 includeFilters와 excludeFilters 완전 이해하기

 왜 필터를 써야 할까?

스프링에서 컴포넌트 스캔을 사용하면 @Component, @Service, @Repository 등을 자동으로 찾아서 빈으로 등록해줘요.

그런데 가끔은…

 

-이 클래스는 원래 @Component 없지만 스캔 대상에 포함하고 싶다

-이 클래스는 @Component 있지만 스캔 대상에서 빼고 싶다

 

이럴 때 사용하는 게 바로 필터 기능

 

-MyIncludeComponent

package hello.core.scan.filter;

import java.lang.annotation.*;

@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와 BeanB를 설정해보자

package hello.core.scan.filter;

@MyIncludeComponent
public class BeanA {
}

package hello.core.scan.filter;

@MyExcludeComponent
public class BeanB {
}

 

필터를 적용한 ComponentScan을 활용해보면

package hello.core.scan.filter;

import org.junit.jupiter.api.Assertions;
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.assertThat;

public class ComponentFilterAppConfigTest {

    @Test
    void filterScan() {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(ComponentFilterAppConfig.class);
        BeanA beanA = applicationContext.getBean("beanA", BeanA.class);
        assertThat(beanA).isNotNull();

        Assertions.assertThrows(
                NoSuchBeanDefinitionException.class,
                () -> applicationContext.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 {

    }
}

-BeanA는 @Component가 없어도 스프링 빈에 등록됨 

-BeanB는 @Component가 있더라도 제외됨 

ComponentFilterAppConfig에 includeFilters와 excludeFilters를 설정하여서 필터 조건을 적용하였기 때문에

beanB는 NoSuchBeanDefinitionException이 발생하는 것

 

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`

 

@ComponentScan(
    includeFilters = {
        @ComponentScan.Filter(
            type = FilterType.ANNOTATION,
            classes = MyIncludeComponent.class
        )
    },
    excludeFilters = {
        @ComponentScan.Filter(
            type = FilterType.ANNOTATION,
            classes = MyExcludeComponent.class
        ),
        @ComponentScan.Filter(
            type = FilterType.ASSIGNABLE_TYPE,
            classes = BeanA.class
        )
    }
)

type = FilterType.ASSIGNABLE_TYPE,
            classes = BeanA.class

이렇게 설정하면 BeanA도 컴포넌트 스캔에서 제외된다.

 

중복 등록과 충돌

자동 빈 등록 vs 자동 빈 등록

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

`ConflictingBeanDefinitionException` 예외 발생

 

수동 빈 등록 vs 자동 빈 등록

 

@Component
public class MemoryMemberRepository implements MemberRepository {}

VS

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

    @Bean(name = "memoryMemberRepository")
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }
}

이 경우 수동 빈 등록이 우선권을 가진다.

(수동 빈이 자동 빈을 오버라이딩 해버린다.)

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`

스프링 부트인 `CoreApplication` 을 실행해보면 오류를 볼 수 있다.

그래서 이런 충돌은 가급적이면 일어나지 않도록 설정하는 것이 좋다