[Spring] 빈 생명주기 콜백

 

 

목차

• 빈 생명주기 콜백 - 빈 생명주기 콜백 시작
• 빈 생명주기 콜백 - 인터페이스 InitializingBean, DisposableBean
• 빈 생명주기 콜백 - 빈 등록 초기화, 소멸 메서드 지정
• 빈 생명주기 콜백 - 애노테이션 @PostConstruct, @PreDestroy

 

빈이 생성될때 와 사라질때 호출되는 메소드 

 

빈 생명 주기 콜백

 

시작하기

초기화 작업과 종료 작업이 필요하다. 

예 ) 애플리케이션 서버 올라갈 때 데베를 미리 연결해둠(TCP handshaking이 오래걸림) 

네트워크 소켓을 미리 열어놔야 이미 열려잇는 소켓으로 클라이언트가 통신을 빠르게 가능

또한, 애플리케이션 종료 시점에연결을 모두 종료하는 작업을 진행하려면 객체의 초기화와 종료작업이 필요

 

외부 네트워크에 미리 연결하는 객체 (NetworkClient)의 예시를 살펴보자

(실제 연결 x , 단순히 가정하고 출력만) 

• 애플리케이션 시작점에 connect() 연결생성 
• 애플리케이션 종료되면 disConnect()로 연결 해제

 

test하위에 lifecycle이라는 패키지를 생성한다. 

 

NetworkClient

package hello.core.lifecycle;

public class NetworkClient {


    private String url;

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


    // url field setter
    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);
    }

}

생성자를 살펴보자.

생성자에서 url을 초기화 해주지 않는다. 

객체를 생성 → 의존관계 주입

과 같은 라이프사이클을 가진 예시가 많아 들어간 예시인듯

 

BeanLifeCycleTest 

public class BeanLifeCycleTest {

    @Test
    public void lifeCycleTest(){
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        NetworkClient client = ac.getBean(NetworkClient.class);

        ac.close(); //ApplicationContext에는 close() method가 없음 -> Configurable Application Context사용

    }

    @Configuration
    static class LifeCycleConfig{

        @Bean
        public NetworkClient networkClient(){
            NetworkClient networkClient = new NetworkClient(); //생성자에서 url을 주입해주지 않음 -> 출력 시 null
            networkClient.setUrl("http://hello-spring.dev");// 나중에 setting해주어야 하는 상황이 많이 발생
            return networkClient;
        }

    }
}

 

결과는 다음과 같이 null인데, 

이는 생성자 내부에서 url을 출력하는 코드를 작성했기 때문이다.

생성자 코드가 실행되고 난 후(객체를 생성), url을 setter로 주입해주기 때문에(의존관계 주입), 출력시에는 null이 출력된다.

 

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

 

 

스프링 빈 라이프사이클

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

객체 생성 → 의존관계 주입

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

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

 

 

스프링 빈의 이벤트 라이프사이클(싱글톤의 예)

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

 

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

 

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

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

 또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다. 따라서 안전하게 종료 작업을 진행할 수 있다.

 

생성자에서 초기화를 하지 않는 이유

객체의 생성과 초기화는 분리해야한다. (단일 책임 원칙)

• 객체 생성은 객체가 생성되는 것에만 집중해야함 → 메모리에 할당됨에 집중, 필수 정보 (파라미터) setting
• 객체의 실제 동작은 별도의 메소드로 분리하는 것이 좋다 (무거운 책임) →  외부와 connection을 맺음, 무거운 작업 등
• 따라서, 무거운 작업을 생성자에서 하는 것 보다는 명확하게 나누는 것이 좋다.

초기화 작업이 내부 값들만 약간 변경하는 정도로 단순한 경우에는 생성자에서 처리하는 것이 좋다.

 

+ 추가적 장점) 

생성을 해두고, 최초의 작업이 수행될 때 까지 미룰 수 있다.

예) 미리 클라이언트가 오기전 생성을 마쳐두고(생성자 호출), 클라이언트에서 연결 요청이 올때까지 미루다가 , 요청이 들어오면 연결(초기화호출)할 수 있다. 

 

 

 

 

 

스프링 콜백 지원 방법

 

3가지 방법을 지원한다.

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

 

 

 

인터페이스(InitializingBean, DisposableBean)

두가지 인터페이스를 implements하여

InitializingBean : 의존관계 주입이 끝나는 경우 호출되는 함수를 오버라이딩하여 구현

DisposableBean : 빈이 종료시 호출되는 함수를 오버라이딩하여 구현

 

NetworkClient

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 disconnect(){
        System.out.println("close: "+url);
    }


    @Override
    public void afterPropertiesSet() throws Exception { //property setting(의존관계주입)이 끝나면 호출
        System.out.println("NetworkClient.afterPropertiesSet");
        connect();
        call("초기화 연결 메세지");
    }

    @Override
    public void destroy() throws Exception { // 빈 종료시 호출
        System.out.println("NetworkClient.destroy");
        disconnect();
    }
}

다음과 같이 생성자에서 실행하던 connect()를 의존관계 주입 후 호출 함수에 옮기고,

서비스 종료시 호출하는 함수인 disconnect를 destory 에 옮기면,

다음과 같은 결과를 얻을 수 있다. 

이제 connect()시 이미 의존관계가 있으므로 정상적으로 출력된다. (생성시에는 null이 맞음)

 

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

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

 

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

 

 

 

 

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

설정 정보에 아래 처럼 초기화, 소멸 메서드를 지정할 수 있다. (이름도 마음대로 지정 가능)

@Bean(initMethod = "init", destroyMethod = "close")

 

 

NetworkClient

package hello.core.lifecycle;

import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;

public class NetworkClient{

	//생략

    public void init() { //property setting(의존관계주입)이 끝나면 호출
        System.out.println("NetworkClient.afterPropertiesSet");
        connect();
        call("초기화 연결 메세지");
    }

    public void close(){ // 빈 종료시 호출
        System.out.println("NetworkClient.destroy");
        disconnect();
    }
}

다음과 같이 자신이 마음대로 메소드명을 하여 작성가능하다.

 

BeanLifeCycleTest 

    @Configuration
    static class LifeCycleConfig{

        @Bean(initMethod = "init", destroyMethod = "close")
        public NetworkClient networkClient(){
            NetworkClient networkClient = new NetworkClient(); //생성자에서 url을 주입해주지 않음 -> 출력 시 null
            networkClient.setUrl("http://hello-spring.dev");// 나중에 setting해주어야 하는 상황이 많이 발생
            return networkClient;
        }

    }

@Bean으로 등록시 initMethod 와 destoryMethod를 지정해준다.

 

설정 정보 사용 특징

• 메서드 이름을 자유롭게 줄 수 있다.
• 스프링 빈이 스프링 코드에 의존하지 않는다.
• 코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다.
  • 외부 라이브러리에서 초기화, 종료를 호출해야 하는 경우가 굉장히 많음
  • 또한 라이브러리 제작자들이 초기화로 종료로 무엇을 써야하는지 적어두었으므로, 그 이름을 사용해서 작성하면됨

 

 

@Bean의 destroyMethod 속성에는 아주 특별한 기능이 있다.

종료 메서드 추론

라이브러리는 보통 close, shutdown이라는 이름으로 종료 메서드를 사용한다. 

그래서, @Bean의 destroyMethod 는 기본값(default)이 (inferred) (추론)으로 등록되어 있다.

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

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

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

 

 

 

애노테이션 @PostConstruct, @PreDestory

가장 많이되는 사용되는 방법이다. 스프링에서도 권장하는 방법이므로 이를 사용하자.

• @PostConstruct : 의존관계 주입 후에 호출될 메서드에 annotation으로 부착해준다.
• @PreDestory : 빈 종료시 호출되는 메서드에 annotation으로 부착해준다.

 

 

NetworkClient

import javax.annotation.PostConstruct; //javax 자바에서 공식적으로 지원(스프링 아닌 다른 자바기반 프레임워크에서도 사용가능)
import javax.annotation.PreDestroy;

public class NetworkClient{


	//생략

    @PostConstruct
    public void init() { //property setting(의존관계주입)이 끝나면 호출
        System.out.println("NetworkClient.afterPropertiesSet");
        connect();
        call("초기화 연결 메세지");
    }

    @PreDestroy
    public void close(){ // 빈 종료시 호출
        System.out.println("NetworkClient.destroy");
        disconnect();
    }
}

 

BeanLifeCycleTest 

    @Configuration
    static class LifeCycleConfig{

        @Bean
        public NetworkClient networkClient(){
            NetworkClient networkClient = new NetworkClient(); //생성자에서 url을 주입해주지 않음 -> 출력 시 null
            networkClient.setUrl("http://hello-spring.dev");// 나중에 setting해주어야 하는 상황이 많이 발생
            return networkClient;
        }

    }

@Bean 으로 등록해주어야 한다.

 

 

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

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

 

<정리>

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