[Spring] 빈 생명주기 콜백

데이터베이스 Connection pool이나 Network socket처럼 Application의 시작 시점에 필요한 연결을 미리 해두고, 애플리 케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화와 종료 작업이 필요합니다.

이번 시간에는 스프링을 통해 이러한 초기화 작업과 종료 작업을 어떻게 진행하는지 예제로 알아보겠습니다.

빈 생명주기 콜백 시작

간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정해보겠습니다.

(실제로는 네트워크에 연결하는 것이 아니라 단순 문자만 출력하도록 가정)

이 Class는 애플리케이션 시작 시점에 connect()를 호출해서 연결을 맺어두어야 하고, 애플리케이션이 종료되면 disConnect()를 호출해서 연결을 끊어야 합니다.

 

예제 코드를 Test 파일 내에 작성해봤습니다.

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

이제 이 Class를 Test 폴더 내에서 실행시켜보겠습니다.

package hello.core.lifecycle;

import org.junit.jupiter.api.Test;
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 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
connect: null
call: null message = 초기화 연결 메시지

생성자 부분을 보면 url 정보 없이 connect가 호출되는 것을 확인할 수 있습니다.

그 이유는, 객체를 생성하는 단계에는 url이 없고, 객체를 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl()이 호출되어야 url이 존재하게 됩니다.

 

스프링 빈은 간단하게 다음과 같은 LifeCycle을 가집니다.

객체 생성 -> 의존관계 주입

 

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

따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 합니다.

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

 

스프링 빈의 Event Lifecycle

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

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

스프링은 다양한 방식으로 생명주기 콜백을 지원합니다.

참고: 객체의 생성과 초기화를 분리하자.
생성자는 필수 정보(파라미터)를 받고, 메모리를 할당해서 객체를 생성하는 책임을 가진다. 반면에 초기화는 이렇게 생성된 값들을 활용해서 외부 커넥션을 연결하는등 무거운 동작을 수행한다.
따라서 생성자 안에서 무거운 초기화 작업을 함께 하는 것 보다는 객체를 생성하는 부분과 초기화 하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋다. 물론 초기화 작업이 내부 값들만 약간 변경하는 정도로 단순한 경우에는 생성자에서 한번에 다 처리하는게 더 나을 수 있다.

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

 

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

인터페이스 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();
    }
}

• InitializingBean은 afterPropertiesSet() 메서드로 초기화를 지원한다.
• DisposableBean은 destroy() 메서드로 소멸을 지원한다.

생성자 호출, url = null
NetworkClient.afterPropertiesSet
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
13:24:49.043 [main] DEBUG
org.springframework.context.annotation.AnnotationConfigApplicationContext -
Closing NetworkClient.destroy
close + http://hello-spring.dev

출력 결과를 보면, 초기화 메서드가 주입 완료 후에 적절하게 호출된 것을 확인할 수 있습니다. 그리고 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출된 것도 확인할 수 있습니다.

 

그러나 이 방법의 큰 단점은 스프링 전용 인터페이스이므로, 해당 코드가 스프링 전용 인터페이스에 의존합니다. 또한 초기화 소멸 메서드의 이름을 변경할 수 없습니다.

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

 

따라서 현재는 잘 사용하지 않고, 아래의 방법을 주로 사용합니다.

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

설정 정보를 사용하도록 변경

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() {
    	System.out.println("NetworkClient.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;
    }
}

실행 결과

생성자 호출, url = null
NetworkClient.init
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
13:33:10.029 [main] DEBUG
org.springframework.context.annotation.AnnotationConfigApplicationContext -
Closing NetworkClient.close
close + http://hello-spring.dev

실행 결과는 동일합니다.

 

설정 정보 사용 특징

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

종료 메서드 추론

• @Bean의 destroyMethod 속성에는 기본값으로 (inferred)(추론)으로 등록되어 있습니다.
• 이 추론 기능은 close, shutdown 이라는 이름의 메서드를 자동으로 호출해줍니다. (대부분의 외부 라이브러리가 close, shutdown이라는 이름의 종료 메서드를 사용하는 것을 특징)
• 따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작합니다.
• 추론 기능을 사용하지 싫으면 destroyMethod=""처럼 빈 공백을 지정하면 됩니다.

애너테이션 @PostConstruct, @PreDestroy

package hello.core.lifecycle;

import jakarta.annotation.PostConstruct;
import jakarta.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
    public NetworkClient networkClient() {
        NetworkClient networkClient = new NetworkClient();
        networkClient.setUrl("http://hello-spring.dev");
        return networkClient;
    }
}

실행 결과

생성자 호출, url = null
NetworkClient.init
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
13:33:10.029 [main] DEBUG
org.springframework.context.annotation.AnnotationConfigApplicationContext -
Closing NetworkClient.close
close + http://hello-spring.dev

 

가장 간편한 방법이면서, 최신 방법 중 하나입니다.

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

• 최신 스프링에서 권장하는 방법이며, 애너테이션만 붙이면 되므로 편리합니다.
• 패키지를 잘 보면 스프링 종속된 기술이 아닌 자바 표준입니다. 따라서 스프링이 아닌 다른 컨테이너에서도 잘 활용할 수 있습니다.
• 컴포넌트 스캔과 잘 어울립니다.
• 유일한 단점은 외부 라이브러리에 사용하지 못하므로, 외부 라이브러리는 @Bean을 사용해야 합니다.

참고

스프링 핵심 원리 - 기본편 강의 - 인프런