[Spring] 빈 생명주기 콜백(Bean Lifecycle Callback)

스프링의 라이프 사이클과 빈 생명주기 콜백 방법에 대해 알아보겠습니다.

 

데이터베이스 커넥션 풀이나, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고

사용을 한 후 어플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면,

객체의 초기화와 종료 작업이 필요합니다.

스프링 빈도 마찬가지로 초기화와 종료 작업이 필요합니다.

스프링에서는 IOC(제어의 역전) 로 인해 스프링 컨테이너가

객체의 생성과 소멸까지의 생명주기를 개발자 대신 관리해줍니다.

 

̱ 스프링 라이플 사이클

 

스프링 컨테이너 생성 -> 스프링 빈 생성 -> 의존관계 주입 -> 

초기화 콜백 ->  사용 -> 소멸전 콜백 ->  스프링 종료

 

이렇게 스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야

필요한 데이터를 사용할 수 있는 준비가 완료됩니다.

콜백은 다른 코드의 인수로서 넘겨주는 실행 가능한 코드를 말합니다.

콜백을 필요에 따라 즉시 실행할 수도 있고, 나중에 실행할 수도 있습니다.

사이클에서 초기화 콜백은 빈이 생성되고, 빈의 의존관계 주입이 완료된 직후 호출되는 메서드이고

소멸전 콜백은 스프링이 종료되기 직전 정확히는 빈이 소멸되기 직전에  호출되는 메서드입니다.

따라서 초기화 콜백을 통해 초기화 시점을 알 수 있고

소멸전 콜백을 통해 종료 시점을 알 수 있습니다.

 

참고. 

스프링 라이프 사이클에서 빈 생성과 초기화를 분리한 이유가 있습니다.

생성자는 필수 정보인 파라미터를 받고, 메모리를 할당해 객체를 생성하는 책임을 가집니다.

반면에 초기화는 생성된 값을 활용해 외부 커넥션을 연결하는 등 무거운 동작을 수행합니다.

따라서 생성자 안에서 무거운 초기화 작업을 함께 하는 것 보다는 객체를 생성하는 부분과

초기화 하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋습니다.

 

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

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

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

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

 

코드로 살펴보겠습니다.

 

public class  NetworkClient {
    private String url;

    public NetworkClient() {
        System.out.println("생성자 호출, url = " + url);
        connect();
        call("초기화 연결 메시지");
    }

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

}

 

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_dey");
            return networkClient;
        }
    }
}

 

 

스프링 컨테이너를 종료시키는걸 확인하기 위해 close() 메서드가 있는

ConfigurableApplicationContext 클래스를 사용해 스프링 컨테이너를 생성하도록 했습니다.

setUrl() 메서드로 URL을 받기 전에 NetworkClient 객체를 생성해 

URL 을 출력하는 메서드에서 null 이 나온걸 확인 할 수 있습니다

현재는 초기화 콜백과 소멸전 콜백 메서드를 정의해주지 않아 결과가 이렇게 나왔습니다.

 

 인터페이스(InitializingBean, DisposableBean)

 

public class  NetworkClient implements InitializingBean, DisposableBean{

    private String url;

    public NetworkClient() {
        System.out.println("생성자 호출, url = " + url);
        connect();
        call("초기화 연결 메시지");
    }

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

}

 

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_dey");
            return networkClient;
        }
    }
}

 

 

NetworkClient  에  InitializingBean, DisposableBean 인터페이스를 구현해서 

초기화 콜백 메서드인 afterPropertiesSet() 와  소멸전 메서드인 destroy() 를 오버라이딩해 사용했습니다.

앞서 설명한 사이클처럼 스프링 컨테이너 생성 -> 스프링 빈 생성 -> 의존관계 주입 이후

초기화 콜백 메서드가 실행되고 스프링이 종료되기 전 소멸전 콜백이 실행된 것을 확인할 수 있습니다.

 

초기화, 소멸 인터페이스 단점

이 인터페이스는 스프링 전용 인터페이스입니다. 해당 코드가 스프링 전용 인터페이스에 의존하게 됩니다.

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

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

 

 참고.

인터페이스를 사용하는 초기화, 종료 방법은 스프링 초창기에 나온 방법들이고,

지금은 다음의 더 나은 방법들이 있어서 거의 사용하지 않습니다.

 

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

 

public class  NetworkClient {
    private String url;

    public NetworkClient() {
        System.out.println("생성자 호출, url = " + url);
        connect();
        call("초기화 연결 메시지");
    }

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

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

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

}

 

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(initMethod = "init", destroyMethod = "close")
        public NetworkClient networkClient() {
            NetworkClient networkClient = new NetworkClient();
            networkClient.setUrl("http://hello-spring_dey");
            return networkClient;
        }
    }
}

 

 

이번에는 따로 메서드를 직접 생성하고 @Bean 어노테이션에

 NetworkClient 클래스의 초기화 콜백 메서드 이름과 소멸전 콜백 메서드 이름을 지정해줍니다. 

이 방법을 사용하면 메서드 이름을 자유롭게 줄 수 있고 스프링 빈이 스프링 코드에 의존하지 않습니다.

코드가 아니라 설정 정보를 사용하기 때문에

코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있습니다.

 

̱ @PostConstruct, @PreDestroy

 

public class  NetworkClient {
    private String url;

    public NetworkClient() {
        System.out.println("생성자 호출, url = " + url);
        connect();
        call("초기화 연결 메시지");
    }

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

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

    public void call(String message) {
        //어떤 url에 call했고 메시지는 무엇인지
        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.destroy");
        disconnect();
    }

}

 

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(initMethod = "init", destroyMethod = "close")
        public NetworkClient networkClient() {
            NetworkClient networkClient = new NetworkClient();
            networkClient.setUrl("http://hello-spring_dey");
            return networkClient;
        }
    }
}

 

 

이번엔 @PostConstruct, @PreDestroy 어노테이션을 이용해 설정해봤습니다.

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

초기화 콜백 메서드와 소멸전 메서드를 생성할 수 있습니다..

 

유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것입니다.

외부 라이브러리를 초기화, 종료 해야 하면 @Bean 의 initMethod , destroyMethod 를 사용하면 되겠습니다.