[스프링 핵심원리 기본편] 6.1 컴포넌트 스캔과 의존관계 자동 주입 시작하기

코린이서현이·2023년 11월 12일
0

👋들어가면서👋

오늘 빅데이터 수업을 진짜 듣고 자야한다... 
화요일까지는 완강도 하고 싶으니까 오늘 7강까지 듣고 내일 8강들으면 될 것 같은데
슬기로운 의사생활🥼이 너무 재밌다... ❤️
...^^ 이따 운동이나 다녀와야지...

🎯 목표

📌 컴포넌트 스캔으로 빈 등록
📌 탐색 위치와 기본 스캔 대상
📌 필터

😣 만약에...

등록할 빈이 수십,수백개가 된다면...?
따라서 설정 정보가 없어도 자동으로 스프링 빈을 등록하는 컴포넌트 스캔이라는 기능을 제공한다.
의존관계를 자동으로 주입하는 @Autowired라는 기능도 제공한다.

📌 컴포넌트 스캔으로 빈 등록

어노테이션 사용하기

🐸 AutoAppConfig

@Configuration
@ComponentScan( //컴포넌트를 사용하기 위해서~!! 대신 @Configuration가 붙은 클래스는 사용하지 않도록! @_@
        excludeFilters =  @ComponentScan.Filter(type =  FilterType.ANNOTATION,
        classes =  Configuration.class)
)
public class AutoAppConfig {
  //개굴 🐸 개기엽다 진짜;;

}

스프링 빈으로 등록할 대상

  • MemoryMemberRepository → @Component
  • RateDiscountPolicy → @Component
  • MemberServiceImpl → @Component, @Autowired
  • MemberServiceImpl → @Component, @Autowired
@Component
public class MemberServiceImpl implements MemberService{
  private final MemberRepository memberRepository;

@Autowired //타입에 맞는 애를 찾아서 자동으로 연결해서 주입해준다. -> 자동의존주입 
//근데 만약에 여러개 있으면 어쩌지?
  public MemberServiceImpl(MemberRepository memberRepository) {
    this.memberRepository = memberRepository;
  }

🤔 의존관계는 어떻게 설정할까?

기존에는 자바 코드로 직접 생성자 주입을 지정해주었지만 자동 컴포넌트 스캔에서는 그럴 수 없다.
👉 따라서 @Autowired을 사용해서 자동 의존관계 주입을 할 수 있도록 해준다.

컴포넌트 스캔으로 빈을 등록

1. 스프링 빈으로 등록

✔️ @Component가 붙은 모든 클래스를 빈으로 등록한다.

스프링의 이름 설정

  1. 빈 이름 기본 전략 : 클래스명의 첫글자를 소문자로 변경한다.
    MemberServiceImpl ➡️ memberServiceImpl

  2. 빈 이름 직접 지정 : 만약 스프링 빈의 이름을 직접 지정하고 싶으면 @Component("memberService2")을 사용한다.

2. 의존관계 자동 주입

의존관계도 당연히 주입을 해야겠죠??
✔️ 생성자에 @Autowired를 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입한다.

의존관계 조회 전략 ) 타입이 같은 빈을 찾아서 주입한다.

⚠️ 오류 발생

org.springframework.beans.factory.NoSuchBeanDefinitionException: 
No qualifying bean of type 'hello.core.member.MemberService' available
public class AutoAppConfigTest {

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

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

  }
}
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

📌 탐색 위치와 기본 스캔 대상

탐색 위치 지정

  • basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색한다.
  • basePackages = {"hello.core", "hello.service"} 이렇게 여러 시작 위치를 지정할 수도 있다.
@Configuration
@ComponentScan( //컴포넌트를 사용하기 위해서~!! 대신 @Configuration가 붙은 클래스는 사용하지 않도록! @_@
        basePackages = "hello.core.member", // 스캔 시작 위치 지정
        excludeFilters =  @ComponentScan.Filter(type =  FilterType.ANNOTATION, 
        										classes =  Configuration.class)
)
public class AutoAppConfig {
  //개굴 🐸 개기엽다 진짜;;

}

👉 해당 구조에서 시작한 것을 확인할 수 있다.

✔️ 권장하는 방법

관계를 사용하자!!
설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것이다. 최근 스프링 부트도 이 방법을 기본으로 제공한다.

불필요한건 제외 : exclude

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

@SpringBootApplication
public class CoreApplication {
	public static void main(String[] args) {
		SpringApplication.run(CoreApplication.class, args);
	}

}

📒 컴포넌트 스캔 기본 대상

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

애노테이션..?

📌 참고: 사실 애노테이션에는 상속관계라는 것이 없다. 그래서 이렇게 애노테이션이 특정 애노테이션을 들고 있는 것을 인식할 수 있는 것은 자바 언어가 지원하는 기능은 아니고, 스프링이 지원하는 기능이다.

🔍 각 애노테이션의 부가 기능

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

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

📌 필터

직접 필터 만들기

🗒️ MyIncludeComponent

@Target(ElementType.TYPE)  //클래스 래벨
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyIncludeComponent {
}

🗒️ MyExcludeComponent

@Target(ElementType.TYPE)  //클래스 래벨
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyExcludeComponent {
}

🥫 아무것도 없는 빈

근데 나 지금 슬기러운 의사 생활 정원 ❤️ 겨울 보는 데, 히힣 넘 좋타 히히힠ㅋㅋㅋ

🗒️ BeanA

@MyIncludeComponent
public class BeanA {
}

🗒️ BeanB

@MyExcludeComponent
public class BeanB {
}

테스트하기

🗒️ ComponentFilterAppConfigTest

public class ComponentFilterAppConfigTest {

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

    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{
  }

}

💻 실행화면

Good

➕ 필터 옵션

  • 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.MyTypeFilte

😣마무리하면서😣

이거 끝나면 얼른 달리기 갔다와야지... 내년 여름에는 마라톤을 할 수 있도록 해보자...
이거랑 다음 강의만 듣고 일어나야겠다. 
profile
24년도까지 프로젝트 두개를 마치고 25년에는 개발 팀장을 할 수 있는 실력이 되자!

0개의 댓글