[Spring] 빈(Bean) 생명주기 콜백 시작

[ Spring ]/Spring

[Spring] 빈(Bean) 생명주기 콜백 시작

쿠릉쿠릉 쾅쾅 2022. 1. 29. 00:05

728x90

1. 빈(Bean) 생명주기 콜백 시작

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

package hello.core.lifecycle;

public class NetworkClient {

    private String url;

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

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

    // 서비스 시작시 호출
    public void connet() {
        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);
    }

}

간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정해보았다. 실제로 네트워크에 연결하는 것은 아니고, 단순히 문자만 출력하도록 했다.
NetworkClient 객체가 애플리케이션 시작 시점에 connect()를 호출해서 연결을 맺어두어야 하고, 애플리케이션이 종료되면 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();  // 스프링 컨테이너 종료, ConfigurableApplicationContext 또는 AnnotationConfigApplicationContext 객체 필요
    }

    @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 nullmessage = 초기화 연결 메시지

생성자 부분을 보면 url 정보 없이 connect()가 호출된다.
NetworkClient 객체를 생성하는 단계에서는 url이 없고, 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl()이 호출되어야 url이 존재할 수 있다.

2. 스프링 빈(Bean) 라이프사이클

객체 생성 → 의존관계 주입
(단, 생성자 주입은 객체 생성과 의존관계 주입이 동시에 일어난다.)

스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝나고 나서야 필요한 데이터를 사용할 수 있다.
초기화 작업은 의존관계 주입이 모두 완료되고 호출해야 한다.
- 초기화 작업이란, 객체를 생성하는 단계가 아니라 객체 안에 필요한 값들이 이미 연결이 되어 있고, 외부 객체와 작업을 해야하는 시점이다.
스프링은 의존관계 주입이 완료되면 스프링 빈(Bean)에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공한다.
스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다. 따라서 안전하게 종료 작업을 진행 할 수 있다.

🔍 2-1. 스프링 빈(Bean)의 이벤트 라이프 사이클

스프링 컨테이너 생성 → 스프링 빈 생성 → 의존관계 주입 → 초기화 콜백 → 사용 → 소멸전 콜백 → 스프링 종료
(싱글톤만 해당)

초기화 콜백 : 빈이 생성되고, 빈의 의존관계 주입이 완료된 후 호출
소멸전 콜백 : 빈이 소멸되기 직전에 호출
스프링은 다양한 방식으로 생명주기 콜백을 지원한다.

💡 객체의 생성과 초기화는 분리하는게 좋다.

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

3. 빈(Bean) 생명주기 콜백 지원

인터페이스(InitializingBean, DiposableBean)
설정 정보에 초기화 메서드, 종료 메서드 지정
@PostConstruct, @PreDestory 애노테이션 지원

🔍 3-1. 인터페이스(InitializingBean, DiposableBean)

💡 InitializingBean 인터페이스

public interface InitializingBean {

	/**
	 * Invoked by the containing {@code BeanFactory} after it has set all bean properties
	 * and satisfied {@link BeanFactoryAware}, {@code ApplicationContextAware} etc.
	 * <p>This method allows the bean instance to perform validation of its overall
	 * configuration and final initialization when all bean properties have been set.
	 * @throws Exception in the event of misconfiguration (such as failure to set an
	 * essential property) or if initialization fails for any other reason
	 */
	void afterPropertiesSet() throws Exception;

}

afterPropertiesSet() 메서드로 초기화를 지원한다.
의존 관계 주입이 끝나면 호출이 된다.

💡 DiposableBean 인터페이스

public interface DisposableBean {

	/**
	 * Invoked by the containing {@code BeanFactory} on destruction of a bean.
	 * @throws Exception in case of shutdown errors. Exceptions will get logged
	 * but not rethrown to allow other beans to release their resources as well.
	 */
	void destroy() throws Exception;

}

destroy() 메서드로 소멸을 지원한다.
빈(Bean)이 종료될 때 호출된다.

✔ 코드

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 connet() {
        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");
        connet();
        call("초기화 연결 메시지");

    }

    @Override
    public void destroy() throws Exception {
        System.out.println("NetworkClient.destroy");
        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();  // 스프링 컨테이너 종료, ConfigurableApplicationContext 또는 AnnotationConfigApplicationContext 객체 필요
    }

    @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.devmessage = 초기화 연결 메시지
01:15:03.421 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@15bbf42f, started on Sat Jan 29 01:15:02 KST 2022
NetworkClient.destroy
close http://hello-spring.dev

출력 결과를 보면 초기화 메서드가 주입 완료 후에 적절하게 호출 된 것을 알 수 있다.
스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출 된 것을 알 수 있다.

🧷 초기화(InitializingBean), 소멸(DiposableBean) 인터페이스 단점

이 인터페이스들은 스프링 전용 인터페이스다. 해당 코드가 스프링 전용 인터페이스에 의존한다.
- 스프링 애노테이션에 의존하는 것은 괜찮지만 인터페이스까지 의존하는 것은 약간 부담스럽다.
초기화, 소멸 메서드의 이름을 변경할 수 없다.
내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.
인터페이스를 사용하는 초기화, 종료 방법은 스프링 초창기에 나온 방법들이고, 지금은 더 나은 방법들이 있어서 거의 사용하지 않는다.

🔍 3-2. 빈 등록 초기화, 소멸 메서드

✔ 코드

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 connet() {
        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");
        connet();
        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();  // 스프링 컨테이너 종료, ConfigurableApplicationContext 또는 AnnotationConfigApplicationContext 객체 필요
    }

    @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.devmessage = 초기화 연결 메시지
01:29:04.082 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@15bbf42f, started on Sat Jan 29 01:29:03 KST 2022
NetworkClient.close
close http://hello-spring.dev

설정 정보에 @Bean(initMethod = "init", destoryMethod = "close") 처럼 초기화, 소멸 메서드를 지정할 수 있다.
메서드 이름을 자유롭게 줄 수 있다.
스프링 빈이 스프링 코드에 의존하지 않는다.
코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적요할 수 있다.

✔ 종료 메서드 추론

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

🔍 3-3. 애노테이션 @PostConstruct, @PreDestory

✔ 코드

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 connet() {
        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");
        connet();
        call("초기화 연결 메시지");
    }

    @PreDestroy
    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();  // 스프링 컨테이너 종료, ConfigurableApplicationContext 또는 AnnotationConfigApplicationContext 객체 필요
    }

    @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.devmessage = 초기화 연결 메시지
01:43:50.259 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@15bbf42f, started on Sat Jan 29 01:43:49 KST 2022
NetworkClient.close
close http://hello-spring.dev

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

💡 @PostConstruct, @PreDestory 애노테이션의 특징

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

🔍 3-4. 정리

되도록 @PostConstruct, @PreDestory 애노테이션을 사용한다.
코드를 고칠 수 없는 외부라이브러리를 초기화, 종료를 해야 한다면 @Bean의 initMethod, destoryMethod를 사용한다.

728x90