[Spring] 빈 생명주기 콜백

내가 공부한것을 올리며, 중요한 단원은 저 자신도 곱씹어 볼겸 상세히 기록하고 얕은부분들은 가겹게 포스팅 하겠습니다.

 

1. 빈 생명주기 콜백

개발자는 의존관계 주입이 모두 완료된 시점을 어떻게 알고 사용할까?

 

스프링은 의존관계 주입이 완료되면 스프링빈에게 콜백 메서드를 통해 초기화 시점을 알려주는 다양한 기능을 제공한다!

또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 통하여 clean up 과정을 갖도록 해준다.

 

싱글톤 스프링 빈의 라이프 사이클은 다음과 같다.

 

스프링컨테이너생성 => 스프링빈생성 => 의존관계주입 => 초기화콜백 => 사용 => 소멸전 콜백 => 스프링 종료

 

다만 위의 라이프 사이클은 setter 주입이나, 필드 주입방식에 해당된다.

생성자 주입방식을 사용할때는 빈을 생성하면서 의존관계 주입도 진행된다.

 

참고: 객체의 생성과 초기화를 분리하자.

생성자는 필수 정보(파라미터)를 받고, 메모리를 할당해서 객체를 생성하는 책임을 가진다. 반면에 초기화는 이렇게 생성된 값들을 활용해서 외부 커넥션을 연결하는등 무거운 동작을 수행한다.

 

따라서 생성자 안에서 무거운 초기화 작업을 함께 하는 것 보다는 객체를 생성하는 부분과 초기화 하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋다.

 

물론 초기화 작업이 내부 값들만 약간 변경하는 정도로 단순한 경우에는 생성자에서 한번에 다 처리하는게 더 나을 수 있다.

 

스프링은 크게 3가지 방법으로 빈 생명주기 콜백을 지원한다.

1) 인터페이스(InitializingBean, DisposableBean)

2) 설정 정보에 초기화 메서드, 종료 메서드 지정

3) @PostConstruct, @PreDestroy 애노테이션 지원

 

2. 인터페이스 InitializingBean, DisposableBean

인터페이스를 사용하는 초기화, 종료 방법은 스프링 초창기에 나온 방법들이고, 지금은 다음의 더 나은 방법들이 있어서 거의 사용하지 않는다.

 

다음과 같은 네트워크 클라이언트 클래스가 있다고 해보자.

public class NetworkClient implements InitializingBean, DisposableBean {

    private String url;

    public NetworkClient() {
        System.out.println("생성자 호출, url = " + url);
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public void connect() {
        System.out.println("connect: " + url);
    }

    public void call(String message) {
        System.out.println("call: " + url + " message = " + message);
    }

    public void disconnect() {
        System.out.println("close: " + url);
    }

    // 의존관계 주입이 끝난다면
    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println("NetworkClient.afterPropertiesSet");
        connect();
        call("초기화 연결 메시지");
    }

    // 빈 종료시
    @Override
    public void destroy() throws Exception {
        System.out.println("NetworkClient.destroy");
        disconnect();
    }
}

 

● InitializingBean 은 afterPropertiesSet() 메서드로 초기화를 지원한다.

● DisposableBean 은 destroy() 메서드로 소멸을 지원한다.

 

다음과 같은 테스트 코드를 작성해 보았다.

public class BeanLifeCycleTest {

    @Test
    public void lifeCycleTest() {
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        NetworkClient client = ac.getBean(NetworkClient.class);
        ac.close();
    }

    @Configuration
    static class LifeCycleConfig {

        @Bean
        public NetworkClient networkClient() {
            NetworkClient networkClient = new NetworkClient();
            networkClient.setUrl("http://hello-spring.dev");
            return networkClient;
        }
    }
}

 

실행결과는 다음과 같다.

우선 생성자를 호출할때까지만 해도 url 값이 Null로 되어있는것을 알수 있다. 다음 코드를 살펴보자.

@Bean
public NetworkClient networkClient() {
      NetworkClient networkClient = new NetworkClient();
      networkClient.setUrl("http://hello-spring.dev");
      return networkClient;
}

 

위의 코드에서 return nerworkClient 까지 진행하여 반환해야 비로서 bean 이 생성완료 된 것 입니다.

따라서 빈이 생성 완료된 시점에서는 setUrl() 이 적용된것 이죠!

 

이후 의존관계 주입이 끝난 후, afterPropertiesSet() 가 호출되면서 connect(), call() 이 호출됩니다!

스프링 컨테이너가 끝나기 직전에는 destroy()가 호출되어 disconnect() 가 호출되는것 이구요~

 

3. 빈 등록 초기화, 소멸 메서드 지정

설정 정보에 @Bean(initMethod = "init", destroyMethod = "close") 처럼 초기화, 소멸 메서드를 지정할 수 있다.

 

package hello.core.lifecycle;

public class NetworkClient {

    // ... 생략

    // 의존관계 주입이 끝난다면
    public void init() {
        System.out.println("NetworkClient.init");
        connect();
        call("초기화 연결 메시지");
    }

    // 빈 종료시
    public void close() {
        System.out.println("NetworkClient.close");
        disconnect();
    }
}

 

이후 @Bean을 등록할 때 지정할수있다. 다음 코드를 살펴보자.

@Configuration
static class LifeCycleConfig {

    @Bean(initMethod = "init", destroyMethod = "close")
    public NetworkClient networkClient() {
          NetworkClient networkClient = new NetworkClient();
          networkClient.setUrl("http://hello-spring.dev");
          return networkClient;
    } 
}

 

테스트 코드를 그대로 실행하면 정상적으로 동작함을 알수 있다.

 

이러한 방식은 메서드 이름을 자유롭게 할수 있다는 장점이 있다.

또한 스프링 코드에 의존하지 않게된다.

코드가 아닌 설정 정보에서 지정해주기 때문에, 외부 라이브러리를 사용할때도 초기화, 종료 메서드를 호출할 수 있게되었다.

 

● 종료 메서드 추론

@Bean의 destroyMethod 속성에는 아주 특별한 기능이 있다.

라이브러리는 대부분 close , shutdown 이라는 이름의 종료 메서드를 사용한다.

 

@Bean의 destroyMethod 는 기본값이 (inferred) (추론)으로 등록되어 있다.

이 추론 기능은 close , shutdown 라는 이름의 메서드를 자동으로 호출해준다. 이름 그대로 종료 메서드를 추론해서 호출해준다.

 

따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다.

추론 기능을 사용하기 싫으면 destroyMethod="" 처럼 빈 공백을 지정하면 된다.

 

4. 애노테이션 @PostConstruct, @PreDestroy

가장 간단한 방식이며, 영한님 또한 이방식을 권장하셨다.

이 방식은 Spring 뿐만 아니라 다른 컨테이너에서도 이용 가능하다. 자바 표준 기능이기 때문이다.

 

다음 코드를 살펴보자.

public class NetworkClient {
    // ... 생략
 
    @PostConstruct
    public void init() {
        System.out.println("NetworkClient.init");
        connect();
        call("초기화 연결 메시지");
    }

    @PreDestroy
    public void close() {
        System.out.println("NetworkClient.close");
        disconnect();
    }
}

 

@PostConstruct , @PreDestroy 이 두 애노테이션만 붙이면 끝이다. 이 방식은 가장 편리하게 초기화와 종료를 실행할 수 있다.

테스트 코드를 실행해보면 정상 작동한다.

 

@PostConstruct, @PreDestroy 애노테이션 특징

최신 스프링에서 가장 권장하는 방법이며, 애노테이션 하나만 붙이면 되므로 매우 편리하다.

 

패키지를 잘 보면 javax.annotation.PostConstruct 이다. 스프링에 종속적인 기술이 아니라 JSR-250 라는 자바 표준이다.

따라서 스프링이 아닌 다른 컨테이너에서도 동작한다.

 

컴포넌트 스캔과 잘 어울린다.

 

유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다. 외부 라이브러리를 초기화, 종료 해야 하면 @Bean의 기능을 사용하자.