스프링 핵심 원리 - 기본편을 공부하고 정리하는 포스트입니다.

빈 생명주기 콜백

데이터베이스 커넥션 풀이나, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고, 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화와 종료작업이 필요합니다. 이러한 초기화 작업과 종료 작업을 어떻게 진행하는지 스프링을 통해서 확인해보겠습니다.

간단한게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 하겠습니다. 실제로 네트워크에 연결하는 것이 아니라 단순히 문자만 출력하도록 하겠습니다. 이 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;
    }

  }
}

실행을 해보면 생각했던 것과 다르게 null 값이 나오는 것을 볼 수 있습니다.


왜냐하면 생성만하고 실제 로직을 호출하지 않았기 때문입니다.
스프링 빈으로 등록할 때 로직의 생성자 부분에서 url 정보 없이 connect가 호출되는 것을 볼 수 있습니다. 객체를 생성하는 단계에서는 url이 없고, 객체를 생성한 다음 외부에서 수정자 주입을 통해 setUrl()이 호출되어야 url이 존재할 수 있습니다.

스프링 빈은 간단하게 ‘객체 생성 -> 의존관계 생성’와 같은 라이프 사이클을 가집니다. 왜냐면 객체를 다 생성해놓아야 의존관계 주입을 할 수 있기 때문입니다. 물론 생성자 주입과 같은 예외가 있습니다. 생성자는 객체를 만들 때 이미 파라미터에 스프링 빈이 들어와야 하기 때문입니다.

스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료됩니다. 예를 들어 Setter로 자동 의존관계를 주입했으면 객체를 생성하는 단계에서는 값이 없습니다. 거기서 초기화하거나 연결하면 당연히 비어있습니다.
초기화는 객체를 생성하는게 아니라 객체에 값이 다 연결되어 있고 외부와 연결되어서 일을 시작하는 것을 말합니다. 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출되어야 합니다.

그러면 개발자는 의존관계 주입이 모두 완료되는 시점을 어떻게 알 수 있을까요?
스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공합니다. 또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 줍니다. 따라서 안전하게 종료 작업을 진행할 수 있습니다.

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

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

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

참고: 객체의 생성과 초기화를 분리하자.

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

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

  • 인터페이스 InitializingBean, DisposableBean
  • 설정 정보에 초기화 메서드, 종료 메서드 지정
  • @PostConstruct, @PreDestroy

인터페이스 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 {
    System.out.println("NetworkClient.afterPropertiesSet");
    connect();
    call("초기화 연결 메세지");
  }

  @Override
  public void destroy() throws Exception {
    System.out.println("NetworkClient.destroy");
    disconnect();
  }
}

InitializingBean은 afterPropertiesSet() 메서드로 초기화를 지원합니다. afterPropertiesSet() 메서드는 빈이 주입되고 난 후 동작합니다.
DisposableBean은 destroy() 메서드로 소멸을 지원합니다.


테스트 코드를 돌려서 결과를 보면 초기화 메서드가 주입 완료 후에 호출되고, 스프링 컨테이너의 종료가 호출되면 소멸 메서드가 호출되는 것을 볼 수 있습니다.

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

이 인터페이스는 스프링 전용이기 때문에, 코드가 스프링에 의존적이게 됩니다. 또한 초기화, 소멸 메서드의 이름을 변경할 수 없고, 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없습니다.
이 방법은 스프링 초기에 나온 방법이여서 지금은 더 나은 방법이 있기 때문에 거의 사용하지 않습니다.

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

빈을 등록하는 시점에 각각 지정해주는 방법을 보겠습니다. 설정 정보에 @Bean(initMethod = "init", destroyMethod = "close")와 같이 초기화, 소멸 메서드를 지정하면 됩니다.

package hello.core.lifecycle;

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

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

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

  }
}


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

종료 메서드 추론

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

애노테이션 @PostConstruct, @PreDestroy

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


아주 간단하게 애노테이션만 추가해주면 됩니다.

여기서는 다른게 아니라 패키지가 중요합니다. 애노테이션의 패키지를 보면 javax인데 이 패키지는 자바에서 공식적으로 지원하는 패키지입니다. 따라서 스프링만이 아니라 다른 컨테이너를 사용하더라도 적용할 수 있습니다.

특징

이 방법은 최신 스프링에서 가장 권장하는 방법입니다. 애노테이션 하나만 붙이면 되기 떄문에 매우 편리합니다. 위에서 설명했듯이 javax.annotation이기 때문에 스프링에 종속적인 기술이 아닌 ‘JSR-250’이라는 자바 표준입니다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작합니다. 그리고 빈 등록하는 것이 아니기 때문에 컴포넌트 스캔과도 잘 어울립니다.
유일한 단점이 하나 있는데 외부 라이브러리에는 적용하지 못한다는 것입니다. 외부 라이브러리에 적용해야 한다면 @Bean의 기능을 사용해야 합니다.