[Spring] 빈 생명주기 콜백

만약 데이터베이스나, 네트워크 소켓처럼 애플리케이션 시작 시점에 연결을 해두고,

애플레케이션 종료 시점에 연결을 모두 종료해야 하는 작업을 해야한다면

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

 

스프링 빈은 간단하게 보면 "객체 생성 → 의존성 주입" 과 같은 라이프사이클을 가집니다.

 

이때 스프링 빈은 객체 생성, 의존관계 주입이 다 끝난 후에야 필요한 데이터를 사용할 수 있게됩니다.

따라서 초기화 작업은 의존관계 주입이 끝난 다음에 호출해야 합니다.

개발자 입장에서 의존관계 주입이 끝난 시점을 어떻게 알 수 있을까요?

 

스프링에는 의존관계 주입이 완료되면 스프링 빈에게 콜백 메소드를 통해서 초기화 시점을 알려줍니다. 

또한 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 줍니다. 

이러한 콜백들을 통해 안전하게 종료 작업을 진행할 수 있습니다.

 

 

스프링의 빈 생명주기 콜백

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

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

3. @PostContruct, @PreDestroy

 

 

이중 첫번째 방법인 인터페이스(InitializingBean, DispossableBean)를 이용하여 초기화, 종료하는 방법은 

스프링 초기에 나온 방법들이고, 지금은 더 나은 방법들이 나와 사용하지 않기 때문에 넘어가겠습니다.

 

 

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

NetworkClient

package hello.core.lifecycle;

public class NetworkClient{


    private String url;

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

    private void call(String msg) {
        System.out.println("call: " + url + "message = " + msg);
    }


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

    // 서비스 시작시 호출
    public void connect() {
        System.out.println("connect: " + url);
    }

    // 서비스 종료시 호출
    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();
    }

}

 

LifeCycleConfig, test

package hello.core.lifecycle;

class BeanLifeCycleTest {

    @Test
    public void lifeCycleTest() {
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        NetworkClient client = ac.getBean(NetworkClient.class);
        ac.close(); // 스프링 컨테이너를 종료, ConfigurableApplicationContext 필요
    }

    @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, destroyMethod)를 통해 각각 초기화할때, 종료할때 실행할 메서드의 이름을 지정할 수 있습니다. 예제코드에서는 init을 초기화 메서드로, close를 종료메서드로 지정하였지만

다른 이름으로 사용하여도 문제가 없습니다.

 

특징

• 메서드 이름을 자유롭게 지정할 수 있다.
• 스프링 빈이 스프링 코드에 의존하지 않는다.
• 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다.
• 종료 메서드를 추론 할 수 있다.

@Bean의 destroyMethod 속성에는 종료 메서드를 추론할 수 있는 기능이 있습니다.

라이브러리는 대부분 close, shutdown 이라는 이름의 종료 메서드를 사용합니다.

@Bean의 destroyMethod는 기본값이 (inferred)(추론)으로 등록되어 있습니다.

따라서 close, shutdown 이라는 메서드를 자동으로 호출해줍니다.

따라서 직접 스프링 빈으로 등록하면 종료 메서드의 이름을 따로 적어주지 않아도 동작합니다.(다만  close, shutdown 이름의 메서드가 존재해야만 가능합니다.)

만약 추론기능을 사용하고 싶지 않다면 destroyMethod="" 처럼 빈 공백을 지정하면 됩니다.

 

 

@PostContruct, @PreDestroy

애노테이션을 적용한 NetworkClient

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

    private void call(String msg) {
        System.out.println("call: " + url + "message = " + msg);
    }


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

    // 서비스 시작시 호출
    public void connect() {
        System.out.println("connect: " + url);
    }

    // 서비스 종료시 호출
    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();
    }

}

 

LifeCycleConfig, test

package hello.core.lifecycle;

class BeanLifeCycleTest {

    @Test
    public void lifeCycleTest() {
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        NetworkClient client = ac.getBean(NetworkClient.class);
        ac.close(); // 스프링 컨테이너를 종료, ConfigurableApplicationContext 필요
    }

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

 

결과

 

NetworkClient에 init 메서드에는 @PostContruct, close 메서드에는 @PreDestory 애노테이션을 추가하였습니다.

단순히 초기화 메서드와 종료 메서드위에 각각의 애노테이션을 붙이기만 하면 된다는점에서 편리하게 초기화와 종료를 실행할 수 있습니다.

 

특징

• 최신 스프링에서 가장 권장하는 방법이다.
• 애노테이션만 붙이면 되므로 매우 편리하다.
• 스프링에 종속적이지 않은 자바 표준이다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작한다.
• 컴포넌트 스캔과 함께 사용하기 편리하다.
• 외부 라이브러리에 적용하지 못한다.

애노테이션을 사용하는 방법의 유일한 단점은 외부라이브러리에 적용하지 못한다는것입니다.

만약 코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료해야 한다면

2번째 방법인 @Bean(initMethod, destroyMethod)를 사용하고,

그 외에 경우는 애노테이션을 적용하는 방법을 사용하는것을 권장한다고 합니다.

 

 

 

 

참고

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1/dashboard