빈 생명주기 콜백 - @PostConstruct, @PreDestroy, @Bean

데이터베이스의 연결 풀이나, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고, 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화 종료 작업이 필요하다.

 

 

스프링 빈은 간단하게 다음과 같은 라이프사이클을 가진다.

객체 생성 → 의존관계 주입

 

 

스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료된다. 

따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다. 그런데 개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까?

 

스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공한다. 또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다. 따라서 안전하게 종료 작업을 진행할 수 있다.

 

 

스프링 빈의 이벤트 라이프사이클

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

 

- 초기화 콜백: 빈이 생성되고, 빈의 의존관계 주입이 완료된 후 호출

- 소멸전 콜백: 빈이 소멸되지 직전에 호출

 

 

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

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

따라서 생성자 안에서 무거운 초기화 작업을 함께 하는 것보다는 객체를 생성하는 부분과 초기화하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋다. 물론 초기화 작업이 내부값들만 약간 변경하는 정도로 단순한 경우에는 생성자에서 한 번에 다 처리하는 게 더 나을 수 있다.

 

참고2) 

싱글톤 빈들은 스프링 컨테이너가 종료될 때 싱글톤 빈들도 함꼐 종료되기 때문에 스프링 컨테이너가 종료되기 직전에 소멸전 콜백이 일어난다. 

싱글톤처럼 컨테이너의 시작과 종료까지 생존하는 빈도 있지만, 생명주기가 짧은 빈들도 있는데 이 빈들은 컨테이너와 무관하게 해당 빈이 종료되기 직전에 소멸전 콜백이 일어난다. 자세한 내용은 스코프에서 알아보자.

 

 

 

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

- 인터페이스(InitializingBean, DisposableBean)

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

- @PostConstruct, @PreDestroy 애노테이션 지원

 

 

인터페이스 InitializingBean, DisposableBean

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

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

- 이 인터페이스는 스프링 전용 인터페이스이다. 해당 코드가 스프링 전용 인터페이스에 의존한다.

- 초기화, 소멸 메서드의 이름을 변경할 수 없다.

- 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.

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

 

 

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

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

- 메서드 이름을 자유롭게 줄 수 있다.

- 스프링 빈이 스프링 코드에 의존하지 않는다.

- 코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다.

- 종료 메서드는 기본값이 (inferred) 로 등록되어 있기 때문에 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다.

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

 

 

@PostConstruct, @PreDestroy 애노테이션

- 최신 스프링에서 가장 권장하는 방법이다.

- 패키지는 javax.annotation.PostConstruct 이므로 스프링에 종속적인 기술이 아니라 JSR-250 라는 자바 표준에 해당한다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작한다.

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

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

 

package hello.core.lifecycle;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

public class NetworkClient {

    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);
    }

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

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

 

@Configuration
static class LifeCycleConfig {

//    @Bean(initMethod = "init", destroyMethod = "close")
    @Bean
    public NetworkClient networkClient() {
        NetworkClient networkClient = new NetworkClient();
        networkClient.setUrl("https://chocomputer.tistory.com");
        return networkClient;
    }
    
}

 

 

실행결과

생성자 호출, url = null
NetworkClient.init
connect: https://chocomputer.tistory.com
call: https://chocomputer.tistory.com message: 초기화 연결 메시지
17:15:36.643 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext- Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@1de5f259, started on Fri Jan 21 17:15:36 KST 2022
NetworkClient.close
close: https://chocomputer.tistory.com

 

 

정리) 

- @PostConstruct, @PreDestroy 애노테이션을 활용하자.

- 외부 라이브러리르 초기화, 종료해야 할 경우에는 @Bean 의 initMethod, destroyMethod 를 활용하자.