스프링 핵심 원리 기본편 7 - 빈 생명주기 콜백

February 27th, 2021

이번 챕터는 빈 생명주기 콜백에 관해 배우는 챕터이다.
스프링 빈이 생성되거나 소멸하기 직전에 특정 메소드를 호출하는 내용을 설명한다. 각 방식별로 특징이 있어 이 내용을 풀어서 설명해준다.

빈 생명주기 콜백 시작

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

여기서 잠깐! 데이터 커넥션 풀에 대해 간략하게 알아보고 가자.
DB 커넥션 풀 : 애플리케이션은 보통 다른 데이터베이스를 사용하는데, 애플리케이션 구동 시점에 DB연결을 미리 맺어둔다. 왜냐하면 TCP/IP handshaking등이 오래 걸리기 때문이다. 이렇게 10~100개등의 연결을 미리 맺어두고, 고객이 요청할 때 미리 연결해둔 것을 재활용 할 수 있다.

간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정해본다. 실제로 네트워크에 연결하는 것은 아니고, 단순히 문자만 출력하도록 하였다. 이 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
    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
connect: null
call: null message: 초기화 연결 메시지

이유는 간단하다. 생성자 부분에서 url 셋팅없이 바로 connect가 호출되기 때문이다.
위 로직상으로는 객체 생성 단계에는 Url이 존재하지 않고, 객체 생성 후 외부에서 수정자 주입을 통해 setUrl()이 호출되어야 url이 존재하게 된다.

스프링 빈은 간단하게 아래와 같은 라이프 사이클을 가진다.
객체 생성 -> 의존관계 주입 (물론 생성자 주입은 논외다).

스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 후에야 필요한 데이터를 사용할 수 있는 준비가 완료된다. 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다. 그런데 개발자가 의존관계가 모두 완료된 시점을 일일히 알 수 있을까 ?

스프링은 의존관계 주입이 완료되면, 스프링 빈에게 콜백 메소드를 통해 초기화 시점을 알려주는 다양한 기능을 제공한다. 추가로, 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다. 이를 통해 안전하게 종료 작업을 진행할 수 있다.

참고 : 초기화란 작업은, 객체를 생성하는 작업을 일컫는 것이 아니다. 객체 안에 필요한 값이 셋팅이 완료된 상태를 말한다.

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

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

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

스프링이 지원하는 빈 생명주기 콜백 방법

인터페이스(InitializingBean, DisposableBean)
빈 등록 초기화, 소멸 메서드
애노테이션 @PostConstruct, @PreDestroy

인터페이스 InitializingBean, DisposableBean

인터페이스 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("초기화 연결 메시지");
    }

    //Destroyy bean이 구동될때
    @Override
    public void destroy() throws Exception {
        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
    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;
        }
    }
}

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

이 인터페이스는 스프링 전용 인터페이스다. 해당 코드가 스프링 전용 인터페이스에 의존한다.
초기화, 소멸 메소드의 이름을 변경할 수 없다.
내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.

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

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

설정 정보에 @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("초기화 연결 메시지");
    }

    //Destroyy bean이 구동될때
    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
    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는 기본값이 (inffered) (추론)으로 등록되어있다.
이 기능은 close,shutdown이라는 이름의 메소드를 자동으로 호출해준다. 이름 그대로 종료 메소드를 추론해서 호출해준다.
따라서 직접 스프링 빈으로 등록하면 종료 메서드는 적어주지 않아도 잘 동작한다.
추론 기능을 사용하기 싫으면 destroyMethod=""처럼 빈 공백을 지정하면 된다.

애노테이션 @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("초기화 연결 메시지");
    }

    //Destroyy bean이 구동될때
    @PreDestroy
    public void close() {
        System.out.println("NetworkClient.close");
        disconnect();
    }
}

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

정리

웬만하면 @PostConstructor, @PrDestroy애노테이션을 사용하자.
코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료해야 한다면 두번째 방법인 @Bean의 initMethod와 destroyMethod를 사용하자.

앞선 내용은 김영한 강사님의 스프링 핵심 원리 기본편 강의를 들으며 정리한 내용입니다.

oksusutea's blog

꾸준히 기록하려고 만든 블로그