스프링 @Bean 애노테이션 정리

@Bean 애노테이션

설명

• 스프링 컨테이너에 의해 관리되는 빈을 생성하는 메서드임을 나타낸다.
• 스프링 XML 에서 <bean> 태그를 통해 등록하는 방식을 자바 코드 방식으로 변형한 것으로 둘의 역할은 같다.

@Bean
public MyBean myBean() {
    // instantiate and configure MyBean obj
    return obj;
}

적용 범위

@Target(value={METHOD,ANNOTATION_TYPE})
@Retention(value=RUNTIME)
@Documented
public @interface Bean {

}

• 메서드나 다른 애너테이션 타입에 붙일 수 있다.

빈 이름

기본 전략으로는 메서드의 이름을 그대로 따르게 된다. 그러나 name() 애트리뷰트를 통해 변경할 수도 있다. 또한 name() 애트리뷰트는 String[] 타입으로 받을 수 있어, 하나의 빈이 여러 개의 이름을 가질 수도 있다.

@Bean({"alias1", "yourBean"})
public MyBean myBean() {
    return obj;
}

위의 경우의 빈 이름은 기본 전략에 해당하는 이름인 myBean 은 무시되고, alias1, yourBean 으로 이름이 설정된다.

빈에 사용되는 다양한 애노테이션 속성들

@Bean
@Profile("production")
@Scope("prototype")
public MyBean myBean() {
    return obj;
}

위 코드처럼 부가 애노테이션을 @Bean 애노테이션 밑에 더해서 이용자가 원하는 속성들을 추가할 수 있다.

• @Profile: JVM 실행 시 인자로 받는 아규먼트인 Profile 정보에 따라 빈을 생성할지 안할지 결정할 수 있다.
• @Scope: 빈의 라이프사이클에 관여하는 스코프를 변경한다.
• @Lazy: 빈이 실제로 이용될 때 빈을 생성한다.
• @DependsOn: 이 빈이 의존하는 다른 빈을 명시한다 그리고 이 빈 생성 전 명시된 빈부터 생성한다.
• @Primary: 특정 타입에 대해 여러 빈이 동시에 매칭되었을 때, 이 빈을 쓰겠다고 선언한다.

기타 빈 메서드에 선언 가능한 것

한정자 애노테이션과 @Order 값을 선언할 수 있다. 주입 시점 동안 한정자는 첫 타입 매치 이후로 후보 집합의 수를 줄여준다.

주의: @Order 애노테이션은 주입시점에서의 우선순위는 조정해주지만, 싱글톤 스타트업 순서에는 영향을 미치지 않는다. 이는 주입 의존관계에 의해서 설정되거나 @DependsOn 에 의해 설정된다.

@Configuration 클래스에서의 @Bean 메서드

• @Bean 메서드가 가장 자주 쓰이는 곳은 @Configuration 애너테이션 안이다.
• 같은 @Configuration 내부 빈끼리는 서로를 메서드 호출하듯 직접 부를 수 있다. 이는 빈들의 관계가 강한 타입이 있고, 서로 이동 가능하다는 것을 보장한다.
  • 이를 '빈 간 참조(inter-bean reference)' 라고 한다.
  • 이는 AOP 시멘틱을 존중하도록 보장한다. getBean() 룩업이 하는 것처럼 말이다.
• 각각의 Configuration 클래스의 CGLIB 서브 클래싱을 요하는 'Spring JavaConfig' 프로젝트에서 나온 것으로 알려진 시멘틱이다. 결과적으로 @Configuration 클래스와 팩터리 메서드는 final 과 private 으로 작성되면 절대 안 된다.

@Configuration
public class AppConfig {

    @Bean
    public FooService fooService() {
        return new FooService(fooRepository());
    }

    @Bean
    public FooRepository fooRepository() {
        return new JdbcFooRepository(dataSource());
    }

    // ...
}

@Bean Lite Mode

만일 @Bean 애노테이션이 @Configuration 애노테이션 내부에 있지 않고, @Component 나 혹은 다른 순수 자바 클래스 내부에 들어있다면, @Bean 은 lite mode 라는 것으로 처리된다.

@Bean 메서드가 라이트모드일 때는 컨테이너에 의한 순수한 팩터리 메서드로 취급된다. (XML 에서 팩터리 메서드 선언을 한 것과 비슷하다.) 스코핑과 라이프사이클 콜백은 올바르게 적용된다. 이 메서드를 포함하는 클래스는 이 경우엔 수정되지 않은 채로 남아있는다. 팩터리 메서드나 포함 클래스에는 어떠한 제약도 없다.

반대로 라이트모드에서는 빈 간 참조(inter-bean reference) 는 지원되지 않는다. 대신, 라이트 모드에서는 빈 메서드가 다른 빈 메서드를 호출하면, 표준 자바 메서드 호출과 같다. 스프링은 CGLIB proxy 를 통한 인터프리팅을 하지 않는다.

@Component
public class Calculator {
    public int sum(int a, int b) {
        return a+b;
    }

    @Bean
    public MyBean myBean() {
        return new MyBean();
    }
}

부트스트래핑

기본적으로 @Configuration, AnnotationConfigApplicationContext 를 이용해서 가능하다.

@Bean 메서드를 반환하는 BeanFactoryPostProcessor

이 방식도 부트스트래핑이 가능한데, BeanFactoryPostProcessor 타입을 반환하는 @Bean 은 신중하게 생각해야 한다. 이 타입의 객체는 컨테이너 라이프사이클에서 매우 빨리 인스턴스화 되어야 한다. @Autowired, @Value, @PostConstruct 와 같은 애노테이션의 진행을 방해할 수 있다. 이러한 이슈를 피하기 위해서는 BeanFactoryPostProcessor 를 아래와 같이 static 으로 반환해야 한다. static 을 명시해줌으로써 위에 설명한 라이프사이클 충돌이 일어나지 않음을 보장할 수 있다. 다만, 다른 일반적인 케이스의 @Bean 메서드처럼 참조될 수도 없다. 알림용으로, 어떤 non-static @Bean 메서드가 BeanFactoryPostProcessor 에 담을 수 있는 @Bean 메서드를 가지고 있다고, INFO 레벨의 로그가 나간다.

@Bean
public static PropertySourcesPlaceholderConfigurer pspc() {
    // instantiate, configure and return pspc ...
}

레퍼런스

스프링 공식문서 Annotation Type Bean
망나니 개발자 블로그