[spring] 빈 생명주기 콜백

본 포스팅은 김영한 님의 스프링 핵심원리 기본편 강의 섹션 8을 듣고 요약한 내용입니다.

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

따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 합니다. 이때, 개발자에게 의존관계 주입이 완료되었다는 것을 알려주기 위해서 스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공합니다. 또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 줍니다.

Q. 객체를 생성하면서 의존관계를 주입하면 안 되나요?
생성자는 필수 정보(파라미터)를 받고, 메모리를 할당해서 객체를 생성하는 책임을 가집니다. 반면에 초기화는 이렇게 생성된 값들을 활용해서 외부 커넥션을 연결하는 등 무거운 동작을 수행합니다. 따라서 객체를 생성하는 부분과 초기화 하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋다고 볼 수 있습니다. 물론, 지금까지 진행한 필드같은 것을 초기화 하는 정도는 괜찮지만, 데이터베이스의 커넥션 풀을 미리 셋팅하거나 소켓통신을 위해 미리 열어두는 것과 같은 무거운 동작일 경우에는 객체생성과 초기화를 분리하는 것이 좋습니다.

스프링 빈은 다음과 같은 라이프 사이클을 가집니다.

1. 스프링 컨테이너가 생성된다.

2. 스프링 빈이 등록된다.

@Configuration, @Bean을 이용한 수동 등록
@ComponentScan을 이용한 자동 등록

3. 스프링 빈 등록이 끝나면, 의존 관계를 주입한다.

4. 의존관계 주입이 끝나면, 스프링은 초기화 콜백을 주고, 스프링 빈들을 초기화한다.

5. 셋팅된 빈을 가지고 애플리케이션을 돌린다.

6. 스프링은 스프링 컨테이너가 종료되기 전 소멸 콜백을 준다.

7. 스프링 컨테이너가 종료된다.

이때 초기화 콜백과 소멸 콜백이 사용됩니다.

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

스프링은 크게 3가지 방법으로 빈 생명주기 콜백을 지원합니다. 먼저 간단한 예제로 알아보도록 하겠습니다.

package hello.core.lifecycle;


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

}

package hello.core.lifecycle;

import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

public class BeanLifeCycleTest {
    @Test
    public void lifeCycleTest() {
        //ConfigurableApplicationContext : ApplicationContext를 코드에 의해서 재구성할 수 있도록 기능을 집어넣은 ApplicationContext.
        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이 뜨게 됩니다.

이제 이 예제를 빈 생명주기 콜백을 지원하도록 변경해보겠습니다.

1. 인터페이스 InitializingBean, DisposableBean

package hello.core.lifecycle;


import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;

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 {  //초기화 지원
        connect();
        call("초기화 연결 메시지");
    }
    @Override
    public void destroy() throws Exception {  //소멸 지원
        disConnect();
    }


}

InitalizingBean과 DisposableBean 인터페이스를 참조하고 afterPropertiesSet()와 destroy()를 오버라이드 해서 사용합니다.

InitalizingBean은 afterPropertiesSet()메서드로 초기화를 지원합니다.

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

결과를 보면, 우리가 원하는 대로 초기화 메서드가 주입 완료 후에 적절하게 호출된 것을 확인할 수 있습니다.

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

스프링 전용 인터페이스이기 때문에, 스프링 전용 인터페이스에 의존합니다.
초기화, 소멸 메서드의 이름을 변경할 수 없습니다.
코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없습니다.

인터페이스를 사용하는 방법은 스프링 초창기에 나온 방법이라 지금은 잘 사용하지 않습니다.

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

package hello.core.lifecycle;


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

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

    public void close() {
        disconnect();
    }

}

@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(initMethod="init", destroyMethod="close")처럼 초기화, 소멸 메서드를 지정할 수 있습니다.

결과를 확인해보니, 우리가 원하는 대로 잘 나오는 것을 알 수 있습니다.

설정 정보 사용 특징

메서드 이름을 자유롭게 줄 수 있습니다.
스프링 빈이 스프링 코드에 의존하지 않습니다.
코드가 아니라 설정정보(config)를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있습니다.

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

이제 애노테이션만을 붙여서 가장 편리하게 초기화와 종료를 실행하는 방법에 대해 알아보겠습니다.

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

}

package hello.core.lifecycle;

import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

public class BeanLifeCycleTest {
    @Test
    public void lifeCycleTest() {
        //ConfigurableApplicationContext : ApplicationContext를 코드에 의해서 재구성할 수 있도록 기능을 집어넣은 ApplicationContext.
        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;
        }
    }
}

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

최신 스프링에서 권장하는 방법입니다.
애노테이션 하나만 붙이면 되므로 매우 편리합니다.
스프링이 아닌 다른 컨테이너에서도 동작합니다.
컴포넌트 스캔과 잘 어울립니다.
외부 라이브러리에는 적용하지 못합니다. 외부 라이브러리를 초기화, 종료해야할 경우, 앞의 @Bean의 기능을 사용합니다.

결론

@PostConstruct, @PreDestroy 애노테이션을 사용하되, 외부 라이브러리를 초기화, 종료해야 할 경우에는, @Bean의 기능을 사용합니다.

저작자표시