Spring / 스프링 빈 Life-cycle callback

빈 생명주기 콜백 시작

 

데이터베이스 커넥션 풀이나, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화와 종료 작업이 필요하다.

 

예를들어 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정해보자. 실제 연결은 아니고 단순히 문자만 출력하도록 했다.

 

이 NetworkClient는 애플리케이션 시작 시점에 connect()를 출해서 연결을 맺어두어야 하고, 애플리케이션이 종료되면 disconnect()를 호출해서 연결을 끊어야 한다.

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

    }

}

 

Test Code

package hello.core.lifecycle;

import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
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;

        }
    }
}

 

실행해보면 

이와 같은 결과가 나온다.

 

스프링 빈은 다음과 같은 LifeCycle을 가진다.

 

객체 생성 -> 의존관계 주입

 

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

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

 

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

또한 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 주는 기능이 있어 안전하게 종료 작업을 진행할 수 있음.

 

스프링 빈의 Lifecycle

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

 

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

소멸 전 콜백 : 빈이 소멸되기 직전에 호출

 

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

생성자는 파라미터를 받아 메모리를 할당해서 객체를 생성하는 책임을 가진다.

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

 

따라서 생성자 안에서 무거운 초기화 작업을 병행해서 하는 것보다 동작을 분리하는 것이 유지보수 관점에서 좋다.

물론 초기화 작업이 내부 값들만 약간 변경하는 정도로 단순한 경우는 예외.

 

스프링은 크게 3가지 빈 Life-cycle callback을 지원한다.

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

2. Config 정보에 초기화 메소드, 종료 메소드 지정

3. @PostConstruct, @PreDestroy 어노테이션

---

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

InitializingBean은 afterPropertiesSet()메소드로 초기화를 지원한다.

DisposableBean은 destroy() 메소드로 소멸을 지원한다.

 

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);
    }
    @Override
    public void afterPropertiesSet() throws Exception {
        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);
    }

    @Override
    public void destroy() throws Exception {
        disconnect();
    }

    // 서비스 종료시 호출
    public void disconnect()
    {
        System.out.println("close : " + url);
    }


}

 

출력 결과를 보면 초기화 메소드가 주입 완료 후 적절하게 호출 된 것을 확인 가능.

그리고 스프링 컨테이너의 종료가 호출되자 소멸 메소드가 호출 된 것을 확인 가능.

 

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

스프링 전용 인터페이스라는 측면에서 의존적이다.

초기화, 소멸 메소드의 이름을 변경 불가능하다. (인터페이스)

내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.

 

인터페이스는 초창기에 나온 방법들이고, 지금은 거의 사용하지 않는다.

 

---

2. Config 정보에 초기화 메소드, 종료 메소드 지정

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

 

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.ApplicationContext;
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 속성의 추론(inferred) 기능

- 지정하지 않는 경우 close , shutdown라는 이름의 메소드를 자동으로 호출해준다.

- 추론 기능을 사용하기 싫으면 빈 공백을 지정하면 된다. ""

 

---

3. @PostConstruct, @PreDestroy

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

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

@PostConstruct , @PreDestroy 이 두 애노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다.

 

특징

1. 최신 스프링에서 가장 권장하는 방법

2. 어노테이션 하나만 붙이면 되므로 매우 편리.

3. javax 패키지로 스프링 종속 기술이 아니라 자바 표준 기술이라 스프링이 아닌 다른 컨테이너에서도 작동

4. 컴포넌트 스캔과 잘 어울림

5. 단점으로는 외부 라이브러리에는 적용하지 못함.

 

---

<정리>

@PostConstruct, @PreDestroy 어노테이션을 사용하되, 외부 라이브러리를 초기화, 종료해야하면 @Bean의 initMethod, destroyMethod를 사용하자.

 

<참고자료>

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

 

 

 

스프링 핵심 원리 - 기본편 - 인프런 | 강의