[Spring] Bean 등록

스프링에서 빈을 등록하는 방법과 빈생성 전처리/후처리 하는 방법에 대해서 알아보자.

1. 빈 등록 하는 방법

@Bean을 통해서 빈으로 등록 한다.

note: 빈을 등록하기 위해서는 빈을 등록하는 클래스가 애플리케이션의 @ComponentScan의 대상이 되어야 한다. 이 말인 즉슨, ComponentScan의 대상이 되기 위해서는 클래스 레벨에 @Component @Configuration @Repository @Service 다음과 같은 어노테이션을 붙이면, 스프링이 해당 컴포넌트들을 스캔할 수 있다.

@Component
public class BeanConfiguration {

    @Bean
    public String hello() {
        return "Hello world";
    }
}

@Bean을 통해서 Hello world를 리턴하는 hello라는 빈을 등록 했다. @Bean 프로퍼티로 아무것도 넣지 않으면 빈 네임은 해당 메서드 네임으로 들어간다. 여기에서는 hello라는 빈으로 등록이 된다.

@Component
public class AppRunner implements ApplicationRunner {

    @Autowired
    private String hello;  // String타입의 hello 빈이 주입된다.

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println(hello);
    }
}

빈을 등록했으니, 다음은 @AutoWired를 통해서 등록된 빈을 사용해보자. 예제 에서는 ApplicationRunner를 구현함으로써 스프링 컨테이너가 동작할 때, run() 메서드가 실행되는 예제이다.

Hello world

콘솔창에 다음과 같이 찍힌다.

2. 빈 생성 전처리/후처리 하는 방법

1. JSR-250 어노테이션 (@PostConstruct, @PreDestroy … ) 사용
2. @Bean의 프로퍼티로 (initMethodName, destroyMethodName) 사용

JSR-250 어노테이션 사용

JSR-250 어노테이션을 사용하면 쉽게 빈을 생성, 폐기 시점을 알 수 있다.

@Service
public class BarService {

    @PostConstruct
    public void init() {
        // BarService 빈 생성 전에 동작
        System.out.println("Post Init bean");

    }

    @PreDestroy
    public void destroy() {
        // BarService 빈 폐기 전에 동작
        System.out.println("Pre Destroy bean");

    }
}

BarService를 @Service로 등록해주고, 빈의 생성 후, 폐기 전에 맞는 @PostConstruct 와 @PreDestroy 를 통해서 하고 싶은 작업을 할 수 있다. 애플리케이션을 실행하고, 종료하게 되면 다음과 같이 나온다. 실행할 때 이미 만들어진 빈들을 등록하기 때문에 따른 코드를 넣지 않아도 된다.

Post Init bean
> 애플리케이션 종료하게 되면
Pre Destroy bean

@Bean 프로퍼티 initMethodName / destroyMethodName 를 통한 방법

public class Foo {
    public void init() {
        // init logic
        System.out.println("Init Foo");
    }
}

public class Bar {
    public void cleanup() {
        // destory logic
        System.out.println("cleanup Bar");
    }
}

Foo, Bar 클래스에서 각각 빈의 초기화, 폐기 관련 작업을 할 메소드를 정의한다.

@Configuration
public class AppConfig {

    @Bean(initMethod = "init")
    public Foo foo() {
        return new Foo();
    }

    @Bean(destroyMethod = "cleanup")
    public Bar bar() {
        return new Bar();
    }
}

빈을 등록하면서 해당 빈의 어트리뷰트에 위에서 작성했던 메서드명을 넘긴다. 인텔리J에는 해당 메서드의 리턴 타입에 따라서 메서드명을 자동으로 띄워준다.

JSR-250 과 @Bean 프로퍼티를 동시에 사용하면 우선순위는 어떻게 될까?

PostConstruct Init bean  // JSR-250
Init Foo // @Bean의 프로퍼티
cleanup Bar // @Bean의 프로퍼티
PreDestroy bean // JSR-250

결과를 보면, JSR-250이 먼저 초기화되고, 그 다음에 @Bean의 프로퍼티가 그 다음 동작 한다.