8. 빈 생명주기 콜백

빈 생명주기 콜백

스프링 빈이 생성되거나 죽기 일보직전에 스프링이 빈 안에 있는 메서드를 호출하는 기능이다.

생성되고 나서 초기화될 때 호출 혹은 빈이 사라지기 직전 안전하게 종료할 수 있는 메서드를 호출한다.

빈 생명주기 콜백 시작

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

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

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

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

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

예제 코드

NetworkClient

public class NetworkClient {
    private String url;

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

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

    //서비스 시작시 호출
    public void connect() {
        System.out.println("connect= " + url);
    }

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

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

 

스프링 환경설정과 실행

public 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.dev>");

            return networkClient;
        }
    }
}

실행해 보면 다음과 같은 이상한 결과가 나온다.

생성자 호출, url = null
connect: null
call: null message = 초기화 연결 메시지

생성자 부분을 보면 url 정보 없이 connect가 호출되는 것을 확인할 수 있다.

너무 당연한 이야기이지만 객체를 생성하는 단계에는 url이 없고, 객체를 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl() 이 호출되어야 url이 존재하게 된다.

 

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

(생성자 주입은 예외다. 생성자는 객체가 만들어질 때 스프링 빈이 파라미터로 같이 들어와야 하기 때문이다.)

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

내가 해당 빈에서 초기화 작업들을 해주고 싶다면 이런 의존관계가 모두 주입된 다음 호출해야 한다.

그런데 개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까?

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

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

따라서 스프링 컨테이너가 종료되기 전 로직을 수행할 수 있어 안전하게 종료 작업을 진행할 수 있다.

(ex: DB와의 연결 종료)

(초기화 작업은 객체를 생성하는 작업을 말하는 게 아니다. 연결이라든지 처음 제대로 일을 시작해야 하는 무언가다.)

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

• 스프링 빈 생성: 생성자 주입 같은 경우는 이때 의존관계 주입이 발생한다.
• 의존관계 주입: setter 주입, 필드 주입
• 초기화 콜백: 빈이 생성되고, 빈의 의존관계 주입이 완료된 후 호출
  • 빈 생성과 빈들의 의존관계 주입
• 소멸 전 콜백: 빈이 소멸되기 직전 호출

(빈을 생성만 하면 안 된다. 빈을 생성을 했으니 해당 빈을 사용해야 하려면 당연히 의존관계도 주입을 해야 사용할 수 있다.)

 

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

❗객체의 생성과 초기화를 분리하자.(객체의 생성 ⇒ new 인스턴스())

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

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

따라서 생성자 안에서 무거운 초기화 작업을 함께 하는 것보다는 객체를 생성하는 부분과 초기화하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋다. 물론 초기화 작업이 내부 값들만 약간 변경하는 정도로 단순한 경우에는 생성자에서 한 번에 다 처리하는 게 더 나을 수 있다. (객체 생성은 메모리 할당하는 것까지 최대한 필요한 데이터 세팅하는 것까지만 하고 실제 뭔가 동작하는 행위는 별도의 초기화 메서드로 분리하는 게 좋다.)

참고: 싱글톤 빈들은 스프링 컨테이너가 종료될 때 싱글톤 빈들도 함께 종료되기 때문에 스프링 컨테이너가 종료되기 직전에 소멸 전 콜백이 일어난다. 뒤에서 설명하겠지만 싱글톤 처럼 컨테이너의 시작과 종료까지 생존하는 빈도 있지만, 생명주기가 짧은 빈들도 있는데 이 빈들은 컨테이너와 무관하게 해당 빈이 종료되기 직전에 소멸전 콜백이 일어난다. 자세한 내용은 스코프에서 알아보겠다.

 

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

• 인터페이스(InitializingBean, DisposableBean)
• 설정 정보에 초기화 메서드, 종료 메서드 지정(애노테이션 속성 설정)
• @PostConstructor, @PreDestroy 애노테이션 사용

인터페이스 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("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() 메서드로 소멸을 지원한다.

[출력 실행 결과]

생성자 호출, url = null
NetworkClient.afterPropertiesSet
connect: http://hello-spring.dev>
call: http://hello-spring.dev> message = 초기화 연결 메시지
13:24:49.043 [main] DEBUG
Closing NetworkClient.destroy
org.springframework.context.annotation.AnnotationConfigApplicationContext -
close + http://hello-spring.dev

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

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

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

해당 인터페이스 두 개를 구현하면서 두 메서드만 오버라이딩해서 구현하면 되니 편하지만, 이 인터페이스는 스프링 전용 인터페이스이기 때문에 해당 인터페이스에 의존하게 된다.

그리고 두 인터페이스에서 제공하는 메서드 오버라이딩이기 때문에 이름을 변경할 수 없고 외부 라이브러리에는 적용할 수도 없다.

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

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

• 빈을 등록하는 시점에 초기화인지 소멸인지 지정해 주는 방법이 있다.
• 스프링 빈 등록 애노테이션 @Bean에 속성으로 초기화, 소멸 메서드를 지정할 수 있다.
• 💡 @Bean(initMethod = "초기화메서드명", destroyMethod="소멸메서드명")

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

public class NetworkClient{

    ...

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

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

초기화 메서드 init과 소멸 메서드 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으로 등록되는 부분에 속성으로 initMethod속성에 init 소멸 메서드명으로 close를 설정해 줬다.

 

실행 결과

생성자 호출, url = null
NetworkClient.init
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
13:33:10.029 [main] DEBUG
org.springframework.context.annotation.AnnotationConfigApplicationContext -
Closing NetworkClient.close
close + http://hello-spring.dev

 

설정 정보 사용 특징

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

인터페이스를 사용하는 것과는 다르게 이름도 init, close로 개발자가 임의로 지정할 수 있고, 스프링 빈이 스프링 코드(인터페이스)에 의존하지 않는다. 그리고 코드가 아닌 설정 정보를 이용하기 때문에 코드를 고칠 수 없는 외부 라이브러리를 사용할지라도 초기화, 종료 메서드를 적용이 가능하다.

종료 메서드 추론

@Bean 애노테이션의 소멸 메서드를 지정하는 속성인 destroyMethod 에는 추론기능이 있다.

관례적으로 대부분 라이브러리에서는 close, shutdown이라는 이름으로 소멸 메서드를 사용하기 때문에, @Bean의 destroyMethod는 default 값으로 (inferred)(추론)으로 등록되어 있다.

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

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

즉, 내가 직접 스프링 빈으로 등록할 때 종료 메서드를 해당 관례를 따르는 close나 shutdown으로 지정한다면 따로 속성에 destroyMethod에 지정해주지 않아도, 자동으로 찾아서 동작한다.

만약, 추론 기능을 사용하기 싫으면 destroyMethod=""처럼 빈 공백을 지정하면 된다.

애노테이션 @PostConstruct, @PreDestroy

• 가장 편하고 최신 스프링에서 권장하는 방법.
• @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();
    }
}

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

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

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

정리

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