[Spring] 김영한 기본편_ 섹션 7. 컴포넌트 스캔

<출처 인프런>

 

컴포넌트 스캔까지 어찌저찌 왔다. 사실 블로그 정리만 아니었어도 강의는 한달 안에 끝냈을 듯... 그래도 블로그 정리하면서 평소 그냥 넘겼을 질문들 몽땅 찾아보는 중이다. 시간이 오래 걸리지만 그만큼 내 머리의 지식도 하나 둘 채워지고 있음을 느낀다. (사실 블로그 정리에 오랜 시간이 걸려 현타와서 주절주절 적어본다) 이번 섹션 6은 강의가 짧아서 빨리 끝날지도 모른다는 기대감이 있다. 우리집 에어컨 고장나서 안나오지만,,,🥲 더위 이겨내고! 모두들 화이팅!!!

 

 

 

🧸 

---

 

🧸 구조파악 레츠꼬우- 🧸

• main
  ㄴ class : AutoAppConfig
  
• test - scan
  ㄴ class : AutoAppConfigTest
  
  
• test - scan - filter
  ㄴ class : BeanA, BeanB, ComponentFilterAppConfigTest
  ㄴ Annotation : MyExcludeComponent, MyIncludeComponent

 

 

---

 

Q.  컴포넌트 스캔이란?

A. 설정정보가 없어도 자동으로 스프링 빈을 등록한다.

 

 

 

✔️  AutoAppConfig

컴포넌트 스캔 설정

 

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

 

 

@ComponentScan

: @Component어노테이션 및 streotype(@Service, @Repository, @Controller.)어노테이션이 부여된 클래스들을 자동으로 Scan하여 Bean으로 등록해주는 역할을 하는 어노테이션이다.

 

 

basePackages

:  String으로 입력된 패캐지의 경로를 스캔하는 방법으로 직접 스캔할 위치를 지정한다.

 

 

basePackageClasses

:  적힌 클래스가(패키지 안) 위치한 곳부터 모든 어노테이션을 부여된 클래스를 bean으로 등록해준다. 

 

 

excludeFilters 

:  객체를 제외한다. (AppConfig에 수동으로 등록한 것들은 빼준다)

 

 

includeFilters

: @Component 어노테이션이 사용된 객체를 불러오고 싶으면,  includeFilters 설정을 사용한다. 특정 조건을 만족하는 클래스만을 스캔하도록 지정한다. 

 

 

 

- @ComponentScan 출처

Spring - @ComponentScan 어노테이션이란?

 

 

- @ComponentScan 출처

[Spring] @ComponentScan - basePackages, basePackageClasses

 

 

 

Q. basePackages보다 basePackagesClasses를 쓰는걸 권장한다. 왜 그런 것일까?

A. 컴포넌트 스캔이 어떻게 동작하는지 이해해야한다. 컨포넌트 스캔을 하려면 @SpringBootApplication을 살펴봐야한다. @SpringBootApplication에는 @ComponentScan을 가지고 있고 @ComponentScan을 가지고 있는 어노테이션이 시작지점이다. @ComponentScan을 붙이고 있는 그 클래스부터 컴포넌트 스캔을 시작한다. 설정해 놓은 패키지들 중에서, 해당 패키지와 하위 패키지에 대해서 @Component 같은 스테레오 타입 어노테이션이 붙은 클래스를 모두 찾아서 빈으로 등록한다. 그러니까 이런식으로 가는게 spring에서 제공하는 기본적인 경로인 것 같다. 그런데 basePackages는 내가 직접 경로를 적는 것으로 springboot에서 제공되는 최상위 패키지부터 시작하지 않게된다는 것이다. springboot에서 제공하는 기본값을 사용하는 것이 더 효율적이고 향후 프로젝트가 커짐에 따라 복잡성을 줄여준다.

 

 

- basePackage를 권장하지 않는 이유 출처

spring[5] ComponentScan과 Component

 

- ComponentScan 동작 출처

스프링 핵심 기술-03.@Component와 컴포넌트 스캔

 

 

 

••• 이어서 다른 코드 부분 •••

 

 

 

public class AutoAppConfig {

}

 

현재 AutoAppConfig 클래스의 역할은 컴포넌트 스캔을 설정하는 것이기 때문에 메서드나 다른 코드는 적지 않는다.

 

 

 

 

---

 

 

 

 

✔️  OrderServiceImpl

의존관계자동주입

 

@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

:  @Component 어노테이션을 이용하면 Bean Configuration 파일에 Bean을 따로 등록하지 않아도 사용할 수 있다. 

 

 

@Autowired

:  생성자에서 여러 의존관계도 한번에 주입받을 수 있다.

 

 

• @Component
: Bean 객체를 가져올 수 있으며(컴포넌트 스캔에 사용), IoC컨테이너 객체를 생성할 때 자동으로 객체 생성되면 Sigleton이다. 

• @Controller
: 스프링 MVC 컨트롤러에 사용하며, Dispatcher(HTTP프로토콜로 들어온 요청을 받아 적합한 컨트롤러에게 위임)은 @Controller가 있는 클래스들을 확인해서 @RequestMapping이 있는 메서드들을 확인합하여 요청을 처리한다.

• @Service
: 비지니스 로직에 있으며 저장소 계층을 사용한다.

• @Repository
: 데이터 엑세스 계층에서 사용한다. 주로 컴포너는 스캔 대상이 되기 위해 사용하지만, 스프링부트와 JPA를 사용할 경우 예외 변환기를 자동으로 등록해서 @Repository를 적용한 빈을 프록시로 변환한다.

• @Configuration
:  설정파일을 만들기 위한, Bean을 등록하기 위한 애노테이션이다. 싱글톤을 유지하도록 추가적으로 처리한다.

 

- @Controller, @Service 출처

@Controller, @Service, @Repository 차이

 

 

- @Repository 출처

@Repository 기능

 

 

- @Configuration 출처

[Spring] @Configuration 개념과 장점

 

 

 

 

---

 

 

 

 

✔️  AutoAppConfigTest

컴포넌트 스캔이 잘 작동되는지 확인

 

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

 

 

AnnotationConfigApplicationContext는 AutoAppConfig의 인자를 받아 스프링 설정 클래스로 인식한다. AutoAppConfig에 @Configuration을 적어놓았으니 인식이 되는 것이다. AutoAppConfig에는 아까 @Componentscan에 대한 정보들을 적어놓았다. 그럼 그걸 기반으로 컴포넌트를 스캔해 빈으로 등록하고 의존성을 주입한다. 모든 준비가 완료되면AnnotationConfigApplicationContext는 완전히 초기화되며 기능을 수행하게 된다.

 

 

 

••• 이어서 다른 코드 부분 •••

 

 

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

 

스프링 컨테이너에서 MemberService 타입의 빈을 조회한다. 조회된 빈이 MemberService타입인지 검증하여 설정이 올바르게 작동하는지 확인한다.

 

 

assertThat(A).isInstanceOf(B);

: isInstanceOf() 는 해당 타입의 인스턴스인지를 비교하는 메서드다. 

 

 

 

 

---

 

 

 

✔️  MyExcludeComponent

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

 

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

}

 

 

@interface 

: 자바에서 제공하는 어노테이션 외에, 사용자가 커스텀할 수 있는 어노테이션이다. @interface는 클래스나 변수를 특정 값으로 지정하여 관리할 수 있다.

 

 

@Target

:  사용자가 만든 annotation이 부착될 수 있는 타입을 지정한다. 

@Target({ElementType.TYPE})은 클래스, 인터페이서, Enum 또는 Record에 붙일 수 있다는 의미이다.

 

 

@Retention

: 해당 어노테이션을 언제까지 유지할건지 지정한다.

@Retention(RetentionPolicy.RUNTIME)은 Java로 작성한 코드가 돌아가는 동안 유지한다는 의미이다.

 

 

@Documented

:  어노테이션에 대한 정보가 javadoc으로 작성한 문서에 포함되도록 하는 어노테이션이다.

 

Q. Docummented를 써서 문서에 포함되도로 하는 이유가 무엇인가?

A. 다른 개발자가 개발된 코드를 보았을 때 어떤 코드인지 쉽게 파악할 수 있도록 해준다. 어노테이션을 왜 썼는지 등 설명을 포함시킬 수 있기 때문에 @Documented를 함께 적어 다른 개발자의 이해를 돕는다. 특히 라이브러리나 프레임워크 개발할 때 유용하다.

 

 

 

- @Target @Retention 출처

[Spring] 커스텀 Annotation 만들기

 

 

- @Docummented 출처

[Java] 자바 메타 어노테이션 정리 및 활용

 

 

 

 

---

 

 

 

 

✔️  BeanB

컴포넌트 스캔에서 제외할 클래스

 

@MyExcludeComponent
public class BeanB {

}

 

아직까진 제외를 할 수 있는 어떤 기능이 실행된 것은 아니다. @MyExcludeComponent를 적어주어 아까 만들었던 애노테이션과 연결했다.

 

 

Q. 왜 애노테이션을 만드는가?

A. 애노테이션을 만드는 이유는 사용자가 원하는대로 설정 정보를 커스텀할 수 있기 때문이다. 꼭 컴포너트 스캔에 어떤 클래스를 포함하고 제외시키기 위함은 아니다. (제외는 다른 클래스에서 부여함) 아까 런타임 시간을 지정하는 것과 같이 개발자가 필요한 설정정보를 만들어 다른 클래스에 편리하게 부여할 수 있다.

 

 

 

 

---

 

 

 

 

✔️ ComponentFilterAppConfigTest

 

BeanA beanA = ac.getBean("beanA", BeanA.class);
Assertions.assertThat(beanA).isNotNull();

 

getBean

: ac(스프링 애플리케이션 컨텍스트)에서 beanA 이름으로 BeanA라는 타입으로 가져오는 것을 뜻한다.

 

 

Assertions.assertThat(A).isNotNull( )

: A가 Null인지 확인한다.

 

 

- Assertions.assertThat().isNotNull() 출처

[Spring] Junit5 Assertions, assertThat()

 

 

 

 

assertThrows(
        NoSuchBeanDefinitionException.class,
        () -> ac.getBean("beanB", BeanB.class));
}

 

 

NoSuchBeanDefinitionException

: BeanFactory정의를 찾을 수 없는 빈 인스턴스를 요청했을 때 예외가 발생한다.

 

NoSuchBeanDefinitionException.class, () -> ac.getBean("beanB", BeanB.class)은 BeanB를 beanB라는 이름으로 가지고 왔는데 그게 정의를 찾을 수 없는 빈 인스턴스여야 테스트가 성공하는 것이다.

 

 

- NoSuchBeanDefinitionException  출처

NoSuchBeanDefinitionException (Spring Framework 6.1.11 API)

 

 

 

••• 이어서 다른 코드 부분 •••

 

 

@ComponentScan(
            includeFilters = @Filter(classes = MyIncludeComponent.class),
            excludeFilters = @Filter(classes = MyExcludeComponent.class)
    )

 

 

@Filter

: 필터는 주로 요청에 대한 인증, 권한 체크 등에  쓴다. 구체적으로 들어온 요청이 DispatcherServlet에 전달되기 전, 헤더를 검사해 인증 토큰이 있는지 없는지, 올바른지, 옳지 않은지 등을 검사한다.

 

 

- Filter 출처

spring - 스프링에서의 필터 개념 및 예제

 

 

 

excludeFilters

:  속성을 사용하여 특정 대상을 스캔에서 제외시킨다.

 

 

Q. 그럼 다시 포함시키고 싶으면 어떻게 해야하나?

A. includeFilters = @Filter(classes = MyExcludeComponent.class)로 바꿔주면 된다.

 

- excludeFilters 출처

component scan

 

 

@ComponentScan을 통해 속성을 살펴본다. 속성엔 MyExcludeComponent를 excludeFilters하라고 적혀있다. 그러면 MyExcludeComponent를 제외시키도록 되어있으니 @MyExcludeComponent가 붙어있으면 제외시키도록 한다. 그런데 BeanB에는 @MyExcludeComponent가 붙어있으니 제외가 되었다.

 

 

 

 

---

 

🌷

 

컴포넌트 스캔이 필요한 경우 @ComponentScan을 쓰고 { } 안에 원하는 특성을 넣을 수 있음을 알아봤다.

그리고 컴포넌트 스캔에 대한 요구를 설정하고 싶은 겨우 @interface와 클래스를 연결시킬 수 있다.