[Spring Boot][2] 8. 빈 생명주기 콜백

🏷 빈 생명주기 콜백 시작

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

이번 시간에는 스프링을 통해 이러한 초기화 작업과 종료 작업을 어떻게 진행하는지 예제로 알아보자😉

+간단하게 서버가 시작되면 외부 네트워크에 미리 연결하고 서버가 종료되면 연결이 끊기는 객체를 하나 생성한다고 가정해보자.
(실제로 네트워크에 연결하는 것은 아니고, 단순히 문자만 출력하도록 할 것임)
이 NetworkClient 는 애플리케이션 시작 시점에 connect() 를 호출해서 연결을 맺어두어야 하고, 애플리케이션이 종료되면 disConnect() 를 호출해서 연결을 끊어야 한다.

✔️ test/../lifecycle/NetworkClient.java 생성 후 코드 작성

package hello.core.lifecycle;
public class NetworkClient {

    private String url;

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

    // 외부에서 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);
    }
}

✔️ test/../lifecycle/BeanLifeCycleTest.java테스트 코드 작성

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);
        //스프링 컨테이너를 종료, 사용하기 위해서는 ConfigurableApplicationContext 필요
        ac.close();
    }

    @Configuration
    static class LifeCycleConfig {
        // 스프링 빈 생성을 하고, 호출이 된 결과물이 스프링 빈에 등록됨
        @Bean
        public NetworkClient networkClient() {
            NetworkClient networkClient = new NetworkClient();
            networkClient.setUrl("http://hello-spring.dev");
            return networkClient;
        }
    }
}

⬆️ 실행 결과, 약간 요상한 결과가 나온다🤷🏻‍♀️
생성자 부분을 보면 url 정보 없이 connect가 호출되는 것을 확인할 수 있다!
객체를 생성하는 단계에는 당연히 url이 없고, 객체를 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl() 이 호출되어야 url이 존재하게 된다.

💡 스프링 빈은 간단하게 이와 같은 라이프사이클을 가진다.
객체 생성 ➡️ 의존관계 주입

스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료된다. 그래서 초기화 작업은 의존관계 주입이 모두 완료되고 셋팅이 다 끝난 후에 호출해야 한다!!
그런데 개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까🤔❓
스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공한다❗️
또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다.
따라서 안전하게 종료 작업을 진행할 수 있다🙂

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

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

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

📌 참고 : 객체의 생성과 초기화를 분리하자.
생성자 안에서 무거운 초기화 작업을 함께 하는 것보다는 객체를 생성하는 부분과 초기화 하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋다!

스프링은 크게 3가지 방법으로 빈 생명주기 콜백을 지원한다.
1️⃣ 인터페이스(InitializingBean, DisposableBean)
2️⃣ 설정 정보에 초기화 메서드, 종료 메서드 지정
3️⃣ @PostConstruct, @PreDestroy 애노테이션 지원

이제 하나씩 알아보자❗️

🏷 인터페이스 InitializingBean, DisposableBean

✔️ test/../lifecycle/NetworkClient.java 코드 수정

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

    // 외부에서 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();
    }
}

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

⬆️ 실행 결과

• 초기화 메서드가 주입 완료 후에 적절하게 호출 된 것을 확인!
• 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출 된 것도 확인!

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

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

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

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

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

✔️ test/../lifecycle/NetworkClient.java 코드 수정

package hello.core.lifecycle;

public class NetworkClient {

    private String url;

    public NetworkClient () {
        System.out.println("생성자 호출, url = " + 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() throws Exception {
        System.out.println("NetworkClient.init");
        connect();
        call("초기화 연결 메시지");
    }

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

✔️ test/../lifecycle/BeanLifeCycleTest.java 수정

.
.
 @Configuration
    static class LifeCycleConfig {
        // 수정
        @Bean(initMethod = "init", destroyMethod = "close")
.
.

⬆️ 실행 결과 👍🏻

✔️ 설정 정보 사용 특징

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

✔️ 종료 메서드 추론
@Bean으로 등록했을 때만 발생

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

🏷 애노테이션 @PostConstruct, @PreDestroy

결론부터 말하자면, 그냥 이걸 쓰자^_^! 스프링에서도 권장하는 방법!

✔️ test/../lifecycle/NetworkClient.java 코드 수정
(이 전에 수정했던 테스트 코드도 다시 원래대로 바꿔줘야 함!)

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

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

⬆️ 실행 결과 👍🏻

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

@PostConstruct, @PreDestroy 애노테이션 특징

• 최신 스프링에서 가장 권장하는 방법으로 애노테이션 하나만 붙이면 되므로 매우~ 편리하다!
• 패키지를 보면 javax.annotation.PostConstruct 이다.
  스프링에 종속적인 기술이 아니기 때문에 스프링이 아닌 다른 컨테이너에서도 동작한다.
• 유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다🙁
  외부 라이브러리를 초기화, 종료 해야 하면 @Bean의 기능을 사용하자.

❗️ 정리

• @PostConstruct, @PreDestroy 애노테이션을 사용하자
• 만약 코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료해야 한다면 @Bean 의 initMethod , destroyMethod 를 사용하자!

스프링 덕분에 난 행복해..아니 행복하지 않..아니 행복해....!