[스프링 기본] 빈 생명주기 콜백

공부 내용을 정리하고 앞으로의 학습에 이해를 돕기 위해 작성합니다.

 

빈 생명주기 콜백 시작

스프링에서 객체의 초기화와 종료 작업을 관리하는 방법을 알아보자. 애플리케이션 시작 시 필요한 연결을 미리 설정하고 종료 시에 연결을 해제하는 작업을 수행하려면 객체의 초기화와 종료 작업이 필요하다. 예를 들어, NetworkClient라는 객체가 애플리케이션 시작 시점에 connect() 메서드를 호출하여 연결을 설정을 해야 하고, 종료 시점에 disConnect() 메서드를 호출하여 연결을 끊어야 한다.

 

예제 코드, 테스트 하위에 생성

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.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 정보 없이 connect가 호출된다. 이는 객체 생성 단계에서는 URL 정보가 없기 때문이다.

- 객체를 생성한 후 외부에서 수정자 주입을 통해 setUrl()이 호출되어야 URL이 존재하게 된다.

 

스프링 빈은 객체 생성과 의존관계 주입 과정을 거친다.

스프링 빈은 객체를 생성하고 의존관계 주입이 완료된 후에야 초기화 작업을 수행할 준비가 된다. 개발자가 의존관계 주입이 완료된 시점을 알기 위해 스프링은 콜백 메서드를 통해 초기화 시점을 알려주는 기능을 제공하며, 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 제공하여 안전하게 종료 작업을 수행할 수 있게 한다.

 

스프링 빈의 이벤트 라이프사이클은 다음과 같다

 

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

 

객체의 생성과 초기화를 분리하는 것이 중요하다. 생성자는 필수 정보를 받아 메모리를 할당해 객체를 생성하고, 초기화는 생성된 값을 활용해 외부 연결을 설정하는 등의 무거운 작업을 수행한다. 생성자에서 무거운 초기화 작업을 함께 하는 것보다는 생성과 초기화를 분리하는 것이 유지보수에 좋다. 예를 들어, 초기화 작업이 단순한 경우에는 생성자에서 처리할 수도 있지만, 복잡한 경우에는 분리하는 것이 바람직하다.

싱글톤 빈은 스프링 컨테이너가 종료될 때 함께 종료되며, 소멸 전 콜백이 발생한다. 생명주기가 짧은 빈은 해당 빈이 종료되기 직전에 소멸 전 콜백이 발생한다.

 

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

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

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

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

 

하나씩 알아보자.

 

인터페이스 InitializingBean, DisposableBean

public class BeanLifeCycleTest {

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

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() 메서드로 소멸을 지원한다.

 

코드의 흐름

 

1. 생성자 호출: NetworkClient가 생성될 때 URL은 아직 설정되지 않았다.

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

2. 의존관계 주입: LifeCycleConfig에서 NetworkClient 빈을 설정하면서 setUrl 메서드가 호출된다.

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

3. 초기화 콜백: afterPropertiesSet 메서드가 호출되어 연결이 설정된다.

@Override
public void afterPropertiesSet() throws Exception {
    connect();
    call("초기화 연결 메시지");
}

4. 사용: 빈이 사용된다.

 

5. 소멸 전 콜백: 스프링 컨테이너가 종료되기 전에 destroy 메서드가 호출되어 연결이 종료된다.

@Override
public void destroy() throws Exception {
    disconnect();
}

 

초기화, 소멸 인터페이스 단점
- 이 인터페이스는 스프링 전용 인터페이스이므로, 해당 코드가 스프링 프레임워크에 의존하게 된다.

- 초기화 및 소멸 메서드의 이름을 변경할 수 없다.
- 외부 라이브러리 코드에 적용할 수 없다.

참고: 이 방법은 스프링 초창기에 사용된 방식으로, 현재는 더 나은 방법들이 존재하여 거의 사용되지 않는다.

 

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

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

 

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

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

 

 

설정 정보 사용의 특징
- 메서드 이름을 자유롭게 줄 수 있다
- 스프링 코드에 의존하지 않는다.
- 외부 라이브러리에도 적용 가능하다.

종료 메서드 추론
- @Bean의 destroyMethod 속성은 기본값이 (inferred)로 설정되어 있으며, 이는 종료 메서드 이름을 자동으로 추론하여 호출해 주는 기능이다.
- 대부분의 라이브러리가 close 또는 shutdown이라는 이름의 종료 메서드를 사용하기 때문에, destroyMethod 속성을 명시하지 않아도 이러한 메서드가 자동으로 호출된다.
- 추론 기능을 사용하지 않으려면 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;
        }
    }

 

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

- 최신 스프링에서 가장 권장하는 방법이다.
- 애노테이션 하나만 붙이면 되므로 매우 편리하다.
- javax.annotation.PostConstruct 패키지에 속해 있으며, 이는 스프링에 종속적인 기술이 아니라 JSR-250 자바 표준이다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작한다.
- 컴포넌트 스캔과 잘 어울린다.
- 유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다. 외부 라이브러리를 초기화, 종료해야 하면 @Bean의 기능을 사용하자.

 

정리

- @PostConstruct, @PreDestroy 애노테이션을 사용하자.
- 코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료해야 하면 @Bean의 initMethod, destroyMethod를 사용하자.