(Spring) 빈 생명주기 콜백

빈 생명주기 콜백

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

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

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

NetworkClient 클래스

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("connent: " + url);
    }

    public void call(String message) {
        System.out.println("call: " + url + ", message = " + message);
    }

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

BeanLifeCycleTest 클래스(스프링 환경설정과 실행)

package hello.core.lifecycle;

class BeanLifeCycleTest {

    @Test
    public void lifeCycleTest() {
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        NetworkClient client = ac.getBean(NetworkClient.class);
        ac.close(); //스프링 컨테이너를 종료, ConfigurableApplicationContext 필요
    }

    @Configuration
    static class LifeCycleConfig {
        @Bean
        public NetworkClient networkClient() {
            NetworkClient networkClient = new NetworkClient();
            networkClient.setUrl("http://hello-spring.dec");
            return networkClient;
        }
    }
}

실행해보자.
생성사 부분을 보면, url 정보없이 connect가 호출되는 것을 확인할 수 있다.
너무 당연한 이야기지만 객체를 생성하는 단계에는 url이 없고, 객체를 생성한 다음에 외부에서 수성자 주입을 통해서 setUrl()이 호출되어야 url이 존제하게 된다.

스프링 빈은 간단하게 다음과 같은 라이프 사이클을 가진다
객체 생성 -> 의존관계 주입

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

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

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

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

객체의 생성과 초기화를 분리하자
: 생성자는 필수 정보를 받아 메모리 할당 후 객체를 생성하는 책임을 가진다.
그리고 초기화는 이렇게 생성된 값들을 활용해 기타 무거운 작업들을 수행한다.
그렇기 떄문에 생성과 초기화를 묶는 것은 SRP(단일 책임 원칙) 적으로도 과한 책임을 가지게 되기에 명확하게 두 부분을 나누는 것이 유지보수 관점 및 객체 지향 프로그램적으로 좋다.

싱글톤 빈들은 스프링 컨테이너가 종료될 떄 싱글톤 빈들도 함께 종료되기 때문에, 스프링 컨테이너가 종료되기 직전에 소멸전 콜백이 일어난다.
싱글톤처럼 컨테이너의 시작과 종료까지 생존하는 빈도 있지만, 생명 주기가 짧은 빈들도 있는데, 이 빈들은 컨테이너와 무관하게 해당 빈이 종료되기 직전에 소멸전 콜백이 일어난다.

스프링은 크게 3가지 방법으로 빈 생명주기 콜백을 지원한다

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

인터페이스 InitializingBean, DisposableBean

InitializingBean, DisposableBean 두 인터페이스를 가져와 사용해보자.

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("connent: " + url);
    }

    public void call(String message) {
        System.out.println("call: " + url + ", message = " + message);
    }

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

    @Override
    public void afterPropertiesSet() throws Exception {
        connect();
        call("초기화 연결 메세지");

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

[테스트 실행 결과]

• InitializingBean은 afterPropertiesSet()메서드로 초기화를 지원한다.
• DisposableBean은 destory()메서드로 소멸을 지원한다.
• 초기화가 메서드 의존관계 주입 완료 이후에 호출되었기 때문에, Null이 아닌 제대로 된 url이 출력된다.
• 스프링 컨테이너가 종료되는 시점에서 disconnect도 호출되는 것을 확인할 수 있다.

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

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

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

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

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

설정 정보를 사용하도록 변경

public class NetworkClient {
	///

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

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

설정 정보에 초기화 소멸 메서드 지정

실행 결과

설정 정보 사용 특징

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

종료 메서드 추론

• @Bean의 destoryMethod 속성에는 아주 특별한 기능이 있다.
• 라이브러리는 대부분 close, shutdown 이라는 이름의 종료 메서드를 사용한다.
• @Bean의 destoryMethod는 기본값이 (inferred)추론으로 등록되어 있다.
• 이 추론 기능은 close, shutdown 이라는 이름의 메서드를 자동으로 호출해준다. 이름 그대로 종료 메서드를 추론해서 호출해준다.
• 따라서 만약 빈 클래스에 close 또는 shutdown이라는 이름의 메서드가 있으면, 스프링은 이를 빈의 소멸 메서드로 간주하고 자동으로 호출해준다.

이 기능을 이용하면 @Bean 어노테이션에서 destroyMethod를 별도로 명시하지 않아도 된다.

애노테이션 @PostConstruct, @PreDestroy

* 가장 편하고, 최신 스프링에서 가장 권장하는 방법

• 초기화 메서드에 @PostConstruct를 지정하면 스프링 빈 등록시 초기화 메서드로 수행한다
• 소멸 메서드에 @PreDestroy 애노테이션을 지정하면 소멸 메소드로 지정된다.

public class NetworkClient {

    //...

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

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

• 애노테이션 하나만 붙이면 되기 때문에 상당히 편하다
• 해당 애노테이션의 import 패키지를 보게 되면,
  javax.annotation.PostConstruct이다. 즉 스프링에 종속적인 기술이 아닌 JSR-250 자바 표준이다.
• 컴포넌트 스캔과 잘어울린다.
• 하지만, 외부 라이브러리에는 적용하지 못하기 때문에(변경 불가) 이런 경우에는 이전에 배웠던 @Bean의 기능(속성을 부여)을 이용하면 된다.

정리

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