섹션8. 빈 생명주기 콜백

wnajsldkf·2023년 1월 12일
0
post-thumbnail

빈 생명주기 콜백 시작

스프링 빈은 객체 생성 후 의존관계 주입이 끝나면 필요한 데이터를 사용하는 흐름을 갖는다.

NetworkClient.java

public class NetworkClient {
    private String url;

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

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

    // 서비스 시작 시 호출
    public void connect() {
        // 2. url에 값이 없으므로 null이 된다.
        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);
    }
}

BeanLifeCycleTest.java

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는 스프링의 빈을 다 가지고 있는 메인 컨테이너이다. 
        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이 존재하게 된다.
이처럼 스프링 빈은 다음과 같이 객체 생성 -> 의존관계 주입이라는 라이프 사이클을 갖는다.

스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝나야 필요한 데이터를 사용할 수 있는 준비가 완료된다. 따라서 초기화 작업(외부에서 연결하고, 특정 작업을 시작하는 것)은 의존관계 주입이 모두 완료되고 난 후에 호출해야 한다.

개발자는 의존 관계 주입이 완료된 시점을 어떻게 알 수 있을까?
스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공한다. 또한 스프링은 컨테이너가 종료되기 직전에 소멸 콜백을 주기 때문에, 안전하게 종료할 수 있다.

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

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

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

객체의 생성과 초기화를 분리하자.
단일 책임 원칙에 따라 객체를 생성하는 것은 필수값을 가지고 "객체 인스턴스를 생성하는 것(필요한 데이터 셋팅)"까지만, "실제 객체가 동작하는 것은 별도의 초기화 메서드"로 분류한다. 객체 생성과 초기화를 명확하게 나누는 것이 유지보수 관점에서 좋다. 물론 초기화 작업이 내부 값들만 변경하는 간단한 것이라면 생성자에서 한번에 처리하는 것이 좋을 수 있다.

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

  • 인터페이스(InitializeBean, Disposable Bean)
  • 설정 정보에 초기화 메서드, 종료 메서드 지정
  • @PostConstruct, @PreDestroy 애노테이션 지정

인터페이스 InitializingBean, DisposableBean

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

// InitalizingBean -> 초기화, 프로퍼티들이 세팅이 끝나면(의존관계 주입이 끝나면) 호출해주겠다.
// DisposableBean -> 종료한다.
public class NetworkClient implements InitializingBean, DisposableBean {
    private String url;

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

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

    // 서비스 시작 시 호출
    public void connect() {
        // 2. url에 값이 없으므로 null이 된다.
        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.init
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
20:07:27.957 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@1e1a0406, started on Thu Jan 12 20:07:27 KST 2023
NetworkClient.close
close: http://hello-spring.dev

출력 결과를 확인하면 초기화 메서드가 주입 완료 후에 적절하게 호출되었다. 또한 스프링 컨테이너의 종류가 호출되자 소멸 메서드가 호출되었다.

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

  • 스프링 전용 인터페이스로, 스프링 전용 인터페이스에 의존한다.
  • 초기화, 소멸 메서드의 이름을 변경할 수 없다.
  • 코드를 수정할 수 있는 외부 라이브러리에 적용할 수 있다.

=> 인터페이스를 사용한 초기화, 종료 방법은 스프링 초창기에 나온 방법으로 지금은 다른 방법들이 있어 거의 사용하지 않는다.

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

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

설정 정보를 사용하도록 변경
NetworkClient.java

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

BeanLifeCycleTest.java

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

설정 정보 사용 특징

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

종료 메서드 추론

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

애노테이션 @PostConstruct, @PreDestroy

@PostConstruct, @PreDestroy 애노테이션을 사용하면 간편하게 초기화 및 종료를 할 수 있다.

  • 최신 스프링에서 권장하는 방법이다.
  • 애노테이션 하나만 붙이면 되므로 간단하다.
  • 스프링에 종속된 기술이 아닌 JSR-250라는 자바 표준이므로, 스프링이 아닌 다른 컨테이너에서도 동작한다.
  • 컴포넌트 스캔과 어울린다.
  • 하지만 외부 라이브러리에는 적용할 수 없으므로, 외부 라이브러리 초기화 시 종료할 경우 @Bean의 기능을 사용한다.

정리

  • @PostConstruct, @PreDestroy 애노테이션을 사용하자.
  • 코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료해야 하면 @BeaninitMethod, destroyMethod를 사용하자.
profile
https://mywnajsldkf.tistory.com -> 이사 중

0개의 댓글