@Bean, @Component, @Configuration, Component Scan

✅ @Bean

• 스프링 빈이란, 스프링 컨테이너에 등록되어 스프링에서 관리하는 대상이 되는 객체이다.
• @Bean 어노테이션을 추가하면 해당 객체는 컴포넌트 스캔의 대상이되어 스프링 빈 객체가 된다.
• @Bean은 메소드 단위에 적용 가능하며, 메소드에 적용하면 해당 메소드의 리턴 타입의 객체가 빈이 된다.
• 개발자가 직접 제어할 수 없는 외부 라이브러리의 경우 @Bean을 사용하여 수동으로 빈을 등록한다.
• @Bean을 사용하여 수동으로 스프링 컨테이너에 등록할 때는, 주로 @Configuration과 같이 사용하는데 그 이유는 빈 객체를 싱글톤으로 유지하기 위함이며, 상세 내용은 아래에서 설명한다.
• 인스턴스 화 하는 코드가 수동으로 작성된다. (@Bean 메소드 안에서 new로 객체를 생성하는 것처럼)

✅ @Component

• @Component 어노테이션을 적용하면, 해당 클래스는 컴포넌트 스캔의 대상이 되며 스프링 빈에 등록해준다.
• 빈을 자동으로 스프링 컨테이너에 등록해주는 방법이다.
• @Component는 클래스 단위에 적용되며, 주로 개발자가 직접 작성한 클래스에 @Compnent를 붙여 사용한다.
• @Conponent를 포함하고 있는 스테레오 타입으로는 @Controller, @Service, @Repository, @Configuration이 있고, @Component와 동일하게 컴포넌트 스캔 대상이 되어 객체를 스프링 빈으로 등록한다.

✅ @Configuration

• @Configuration도 내부에 @Component를 포함하고 있어 @Component의 종류이고, 각종 스프링 빈 설정을 가지고 있다.
• @Component가 포함되어 있으므로 당연히 컴포넌트 스캔의 대상이 된다.
• @Congiguration이 설정된 클래스 내에 @Bean 메소드들을 스캔하여 스프링 컨테이너에 등록한다.
• 각종 스프링 부트의 기능들을 설정 용도로도 사용한다.

✅ @Bean in @Component vs @Bean in @Configuration

• @Configuration이 설정된 클래스를 생성하면, CGLib 라이브러리가 프록시 패턴을 적용하여 프록시 빈을 생성한다. 이 프록시 빈은 싱글톤을 보장하므로 @Bean 메소드를 여러번 호출해도 항상 동일한 객체를 반환한다.
• 반면에, @Bean을 @Component가 설정된 클래스 내에서 사용하면, @Bean 메소드의 객체를 스프링 빈으로 생성할 때 프록시 빈이 아닌 순수한 인스턴스를 빈으로 등록한다. 따라서 @Bean 메소드를 여러번 호출할 때마다 새로운 빈이 계속 생성되므로 싱글톤이 보장되지 않는다.
• 또한, 프록시 빈이 가지고 있는 AOP와 같은 기능들을 사용할 수 없다.
• @Component와 @Bean을 같이 사용할 때, 이를 Lite 모드라고 하며, 프록시 빈을 생성하는 과정보다 상대적으로 빠르다.

✅ 결론

• 실제로 @Compnent가 적합한 클래스에 @Configuration을 적용하든, @Configuration이 적합한 상황에 @Component를 적용하든 실제 동작을 하긴한다. (물론 의도치 않은 결과가 나올 수 있다.)
• 그렇지만, 의도에 맞게 상황에 따라 해당 어노테이션들을 적절히 사용해야 추후에 문제가 생길 여지를 방지할 수 있다.

⬇️컴포넌트 스캔 내용 추가

✅ Component Scan

• @Component를 가진 모든 대상을 가져와서 빈에 등록하기 위해 찾는 과정
• @ComponentScan은 @Component가 붙은 모든 클래스를 스프링 빈으로 등록한다.
• 이 때 스프링 빈의 기본 이름은 클래스명을 사용하되 맨 앞글자만 소문자를 사용한다.
  • 빈 이름 기본 전략: MemberServiceImpl 클래스 memberServiceImpl
  • 빈 이름 직접 지정: 만약 스프링 빈의 이름을 직접 지정하고 싶으면
    @Component("memberService2") 이런식으로 이름을 부여하면 된다.

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

탐색 위치와 스캔 대상

• 컴포넌트 스캔 시에 컴포넌트 스캔을 시작할 위치를 지정해줄 수 있다.
• basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함한 하위 패키지를 모두 탐색한다.
• 만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.
• 권장 방법은 되도록이면 패키지 위치를 지정하지 않고, 설정 정보 클래스의 위치를 최상단에 두는 것이다.
• 스프링 부트의 시작 정보인 @SpringBootApplication를 프로젝트 시작 루트 위치에 두는 것이 관례이고, @SpringBootApplication 안에 @ComponentScan이 들어있다.

@ComponentScan(
	//basePackages = "hello.core",
    basePackages = {"hello.core", "hello.service"} //여러 개의 시작 위치 지정 가능
}

컴포넌트 스캔 기본 대상

• 컴포넌트 스캔은 @Component 및 아래의 내용도 대상에 포함한다.
  • @Controller : 스프링 MVC 컨트롤러에서 사용되며, 스프링 MVC 컨트롤러로 인식해줌
  • @Service : 스프링 비지니스 로직에서 사용되며, 특별한 부가기능은 없고 해당 어노테이션이 있는 부분에는 비지니스 로직이 들어가는 비지니스 계층을 인식하는데 도움이 된다.
  • @Repository : 스프링 데이터 접근 계층에서 사용되며, 스프링 데이터 접근 계층으로 인식하고, 데이터 계층의 예외를 스프링 예외로 변환해준다.
  • @Configuration : 스프링 설정 정보에서 사용되며, 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가 처리를 해준다.

필터

• includeFilters : 컴포넌트 스캔 대상을 추가로 지정한다.
• excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정한다.

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

FilterType 옵션

• ANNOTATION: 기본값, 어노테이션을 인식해서 동작
• ASSIGNABLE_TYPE: 지정한 타입과 자식 타입을 인식해서 동작한다.
  • ex) org.example.SomeClass
• ASPECTJ: AspectJ 패턴 사용
  • ex) org.example..*Service+
• REGEX: 정규 표현식
  • ex) org\.example\.Default.*
• CUSTOM: TypeFilter 이라는 인터페이스를 구현해서 처리
  • ex) org.example.MyTypeFilter

중복 등록과 충돌

• Case1. 자동 빈 등록 vs 자동 빈 등록

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

• Case2. 수동 빈 등록 vs 자동 빈 등록

  • 이전에는 수동 빈 등록과 자동 빈 등록이 충돌하면, 수동 빈 등록이 우선권을 가져 수동 빈이 자동 빈을 오버라이딩 해버린다.

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

참고 Reference

• 스프링 핵심 원리 - 기본편(인프런)
• https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-java-basic-concepts
• https://mangkyu.tistory.com/75
• https://jaeano.tistory.com/76