9월 7일 목요일 TIL 회고록

카테고리 없음

9월 7일 목요일 TIL 회고록

tft4rollz 2023. 9. 7. 20:57

빈 생명주기(Bean LifeCycle) 콜백 알아보기

빈 생명주기 콜백의 필요성

먼저 콜백에 대해 설명하면, 주로 콜백함수를 부를 때 사용되는 용어이며, 콜백함수를 등록하면 특정 이벤트가 발생했을 때 해당 메소드가 호출된다. 즉, 조건에 따라 실행될 수도 실행되지 않을 수도 있는 개념이라고 보면 된다.

보통 프로젝트를 하다보면 DB 연결, 네트워크 소켓 연결 등과 같이 시작 지점에 미리 연결한 뒤 어플리케이션 종료 시점에 연결을 종료해야 하는 경우 객체의 초기화 및 종료 작업이 필요할 것이다. (예 : 커넥션 풀의 connect & disconnect)

네트워크에 연결하는 동작을 표현하는 NetworkClient 예제 클래스를 만들어보았다.

package hello.core.lifecycle;

public class NetworkClient {
    private String url;

    public NetworkClient() {
        System.out.println("생성자 호출 , url=" + url);
        connect();
        call("초기화 연결 메세지");
    }

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

    public void connect() {
        System.out.println("connect= " + url);
    }

    public void disconnect() {
        System.out.println("close= " + url);
    }

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

BeanLifeCycleTest 테스트 클래스를 만들어 테스트를 진행했다.

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이다.

객체 생성 시점에는 url이 입력되지 않았고 생성 완료 후 setter를 통해 url을 넣었기 때문에 url이 모두 null로 출력되었다.

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

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

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

또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다. 따라서 안전하게 종료 작업을 진행할 수 있다.

스프링 빈의 이벤트 라이프 사이클

스프링 빈의 이벤트 라이프 사이클은

스프링 컨테이너 생성 -> 스프링 빈 생성 -> 의존관계 주입 -> 초기화 콜백 -> 사용 -> 소멸전 콜백 -> 스프링 종료 순으로 이루어진다.

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

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

생성자는 필수 정보(파라미터)를 받고 메모리를 할당후 객체를 생성하는 책임을 가진다.

반면에 초기화는 이렇게 생성된 값들을 활용해서 외부 커넥션을 연결하는 등 무거운 동작을 수행한다.

그렇기에 생성과 초기화를 묶는 것은 SRP(단일 책임 원칙)적으로도 과한 책임을 가지게 되기에 명확하게 두 부분을 나누는 것이 유지 보수 관점 및 객체지향 프로그램 적으로도 좋다.

참고: 싱글톤 빈들은 스프링 컨테이너가 종료될 때 같이 종료되기에 소멸전 콜백이 스프링 컨테이너 종료 직전 호출되지만, 생명주기가 더 짧은 빈들도 있는데 이 빈들은 컨테이너와 무관하게 소멸전 콜백이 일어난다.

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

인터페이스 (InitialzingBean, DisposableBean)
설정 정보에 초기화 메서드, 종료 메서드 지정
@PostConstruct, @PreDestory 애노테이션 사용

하나씩 알아보자.

인터페이스 InitializingBean, DisposableBean

InitializingBean, DisposableBean 두 인터페이스를 가져와 사용해보자.

NetworkClient.class

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

테스트 실행 결과

InitialzingBean은 afterPropertiesSet() 메서드로 초기화를 지원한다.
DisposableBean은 destory() 메서드로 소멸을 지원한다.
초기화가 메서드 의존관계 주입 완료 이후 호출되었기에 Null이 아닌 제대로 된 url이 출력된다.
스프링 컨테이너가 종료되는 시점에서 disconnect도 호출되는 것을 확인할 수 있다.

InitializingBean, DisposableBean 두 인터페이스를 사용하면 생기는 단점은

해당 인터페이스 두개를 구현하면서 두 메소드만 오버라이딩해서 구현하면 되니 편하지만, 이 인터페이스는 스프링 전용 인터페이스이기 때문에 해당 인터페이스에 의존하게 된다.
두 인터페이스에서 제공하는 메서드 오버라이딩이기 때문에 이름을 변경할 수 없고 외부 라이브러리에는 적용할 수도 없다.

인터페이스를 사용하는 초기화, 종료 방법은 스프링 초창기에 나온 방법들이고, 지금은 더 나은 방법들이 있어서 거의 사용하지 않는다.

DisposableBean 인터페이스에 들어가보면 시작 기간이 2003년이다. 너무 오래되었다..

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

스프링 빈 등록 애노테이션 @Bean 에 속성으로 초기화, 소멸 메서드를 지정할 수 있다.

@Bean(initMethod = "초기화 메서드명", destoryMethod = "소멸 메소드명)

NetwordClient.class

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


public void close() {
    	System.out.println("NetworkClient.close");
    	disconnect();
  	}
}

초기화 메서드 init, 소멸 메서드 close를 구현해줬다. 메서드 호출 시 콘솔창에 해당 메서드명을 출력하도록 하였다.

LifeCycleConfig.class

@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를 설정해줬다.

실행 결과

설정 정보 사용 특징

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

종료 메서드 추론

@Bean에 destoryMethod 속성에는 아주 특별한 기능이 있다.
라이브러리는 대부분 close,shutdown 이라는 종료 메서드를 사용한다.
@Bean에 destoryMethod는 기본값이 (inferred) (추론)으로 등록되어 있다.
- @Bean(initMethod = "init", destoryMethod = "inferred")
이 추론 기능은 close,shutdown 이라는 이름의 메서드를 자동으로 호출해준다. 이름 그대로 종료메서드를 추론해서 호출해준다.
따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다.
추론 기능을 사용하기 싫으면 destoryMethod = "" 처럼 빈 공백을 지정하면 된다.
- @Bean(initMethod = "init", destoryMethod = "")

애노테이션 @PostConstruct, @PreDestory

가장 편하고 최신 스프링에서 권장하는 방법이다.
초기화 메서드에 @PostConstruct 어노테이션을 지정하면 스프링 빈 등록 시 초기화 메서드로 수행된다.
소멸 메서드에 @PreDestory 어노테이션을 지정하면 소멸 메서드로 지정된다.

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


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

어노테이션 하나만 붙히면 되기에 상당히 편하다.
해당 애노테이션의 import 패키지를 보면 jakarta.annotation.PostConstruct 이다. 즉, 스프링에 종속적인 기술이 아닌 JSR-250 자바 표준이다.
컴포넌트 스캔과 잘 어울린다.
하지만, 외부 라이브러리에는 적용하지 못하기에 (변경 불가로 인해) 이런 경우에는 @Bean의 기능(속성을 부여)을 이용하면 된다.

출처 : 김영한님 스프링 핵심 원리 - 기본편