본문 바로가기
Backend/Spring

빈 생명주기 콜백

gugu76 2023. 8. 3. 13:13

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

 

간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정해보자.

실제로 네트워크에 연결하는 것은 아니고, 단순히 문자만 출력하도록 했다.

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

// NetworkClient.java
package ghdtjgus76.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);
    }
}
// BeanLifeCycleTest.java
package ghdtjgus76.core.lifecycle;

import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
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() {
        AnnotationConfigApplicationContext 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이 존재하게 된다.

 

스프링 빈은 다음과 같은 라이프 사이클을 가진다.

객체 생성 → 의존관계 주입

 

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

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

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

또, 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다.

그래서 안전하게 종료 작업을 진행할 수 있게 된다.

 

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

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

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

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

 

추가적으로, 객체의 생성과 초기화를 분리하자.

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

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

 

그래서 생성자 내부에서 초기화를 함께 진행하는 것보다 객체 생성과 초기화 부분을 명확하게 나누는 것이 좋다.

하지만 초기화 작업이 무겁지 않다면 한 번에 처리하는 게 더 괜찮은 방법일 수는 있다.

 

그리고 싱글톤 빈들은 스프링 컨테이너 종료 시 같이 종료되기 때문에 스프링 컨테이너가 종료되기 직전에 소멸 전 콜백이 일어난다.

 

스프링이 빈 생명주기 콜백을 지원하는 방법은 다음과 같다.

- 인터페이스(InitializingBean, DisposableBean)

- 설정 정보에 초기화 메서드, 종료 메서드 지정

- @PostConstruct, @PreDestroy 애노테이션 지원

 

인터페이스 InitializingBean, DisposableBean

// NetworkClient.java
package ghdtjgus76.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();
    }
}
// BeanLifeCycleTest.java
package ghdtjgus76.core.lifecycle;

import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
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() {
        AnnotationConfigApplicationContext 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
NetworkClient.afterPropertiesSet
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
NetworkClient.destroy
close: http://hello-spring.dev

InitializingBean은 afterPropertiesSet() 메서드로 초기화를 지원하고, DisposableBean은 destroy() 메서드로 소멸을 지원한다.

 

초기화, 소멸 인터페이스의 단점도 있는데, 일단 해당 인터페이스는 스프링 전용 인터페이스이기 때문에, 스프링 전용 인터페이스에 의존하게 된다.

또, 초기화, 소멸 메서드의 이름을 변경할 수 없고, 코드를 고칠 수 없는 외부 라이브러리에 적용하기 힘들다.

그래서 요즘은 잘 사용하지 않는 방법이다.

 

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

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

// NetworkClient.java
package ghdtjgus76.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("초기화 연결 메시지");
    }

    public void close() {
        System.out.println("NetworkClient.close");
        disconnect();
    }
}
// BeanLifeCycleTest.java
package ghdtjgus76.core.lifecycle;

import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
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() {
        AnnotationConfigApplicationContext 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;
        }
    }
}
// 출력 결과
생성자 호출, url = null
NetworkClient.init
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
NetworkClient.close
close: http://hello-spring.dev

이렇게 하면 메서드 이름을 자유롭게 지정할 수 있고, 스프링 빈이 스프링 코드에 의존하지 않게 된다.

또한, 코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다는 장점이 있다.

 

그리고 @Bean의 destroyMethod 속성에는 특별한 기능이 있는데, 기본 값이 inferred, 즉 추론으로 등록되어 있다.

이 추론 기능은 close, shutdown이라는 이름의 메서드를 자동으로 호출해준다.

이름 그대로 종료 메서드를 추론해서 호출해준다.

직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다.

 

애노테이션 @PostConstruct, @PreDestroy

// NetworkClient.java
package ghdtjgus76.core.lifecycle;

import jakarta.annotation.PostConstruct;
import jakarta.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();
    }
}
// BeanLifeCycleTest.java
package ghdtjgus76.core.lifecycle;

import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
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() {
        AnnotationConfigApplicationContext 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
NetworkClient.init
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
NetworkClient.close
close: http://hello-spring.dev

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

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

이 방법은 스프링에 종속적인 기술이 아니라 자바 표준이라 스프링이 아닌 다른 컨테이너에서도 동작한다.

또한, 컴포넌트 스캔을 사용할 때 같이 사용하면 좋다.

 

하지만, 유일한 단점이 하나 있는데, 외부 라이브러리에는 적용하기 힘들다는 것이다.

외부 라이브러리를 초기화, 종료해야 하는 경우 @Bean의 initMethod, destoryMethod 기능을 사용하자.

'Backend > Spring' 카테고리의 다른 글

영속성 컨텍스트  (0) 2023.08.09
빈 스코프  (1) 2023.08.03
의존 관계 자동 주입  (0) 2023.08.03
컴포넌트 스캔  (0) 2023.08.02
싱글톤 컨테이너  (0) 2023.08.02

'Backend/Spring' Related Articles

티스토리툴바