[Spring] Bean 생명주기 콜백

김영한님의 Spring 핵심원리 강의를 듣고 정리하는 글입니다.

1. 개요

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

 

네트워크 연결하는 동작을 표현한 예제 코드를 통해 설명해보겠다.

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

필드인 url은 setter 메서드를 통해 외부에서 대입한다. 다음 테스트 코드를 통해 확인해보자.

 

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

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

실행결과를 보면 url을 setter 메서드를 통해서 값을  대입하고 있는데 url은 null이 출력된다.

스프링 빈의 이벤트 라이프사이클을 보면 이유를 알 수 있다.

 

 

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

* 참고로 싱글톤 빈의 라이플 사이클이며 스프링은 다양한 빈 스코프가 존재한다. 추후 정리하겠다. 

"김영한님의 Spring 핵심원리 강의 참고"

 

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

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

개발자는 빈의 초기화 시점이나 소멸 시점을 어떻게 알 수 있을까?

 

그 전에 생성자와 초기화 작업을 분리하는 이유에 대해서 살펴보자. 위 예제를 살펴보자.

 

 

 

3. 생성자와 초기화 작업을 분리하는 이유

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

url이 null인 이유는 객체 생성 시점에 url에 값을 넣지 않았기 때문인 것을 알고 있다. 그럼 객체 생성 시점에 url에 값을 넣어서 해결할 수 있을 것이다. 객체의 생성과 초기화를 분리하는 이유가 있다.

 

생성자는 필수 정보를 받고, 메모리를 할당해서 객체를 생성하는 책임을 가진다. 반면에 초기화는 생성자를 통해 생성된 값들을 활용하여 외부 커넥션을 연결하는 등 무거운 동작을 수행한다.

따라서 생성자 안에서 무거운 초기화 작업을 함께 하는 것 보다 객체를 생성하는 부분과 초기화 하는 분을 명확하게 나누는 것이 유지보수 관점에서 좋다. 단순한 경우에는 생성 시점에 초기화 하는 경우도 있다.

 

 

4. 스프링에서 빈 생명주기를 지원하는 3가지 방법

a. 인터페이스 InitializingBean, DisposableBean

• afterPropertiesSet()은 의존 관계 주입이 끝나면 호출 되는 초기화 콜백을 지원한다.
• destroy()은 빈 소멸전 콜백을 지원한다.
• 하지만 해당 인터페이스는 스프링 전용 인터페이스로 스프링에 의존적이다. 초기화, 소멸 메서드의 이름을 변경할 수 없고, 외부 라이브러리에 적용할 수 없으므로 좋은 방법은 아니다. 현재는 이 방법을 거의 사용하지 않는다.

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("connect = " + url + " message = " + message);
    }

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

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

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

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

 

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

 

 

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

• @Bean(initMethod = "init", destroyMethod = "close") 빈 등록 시 초기화, 소멸 메서드를 지정할 수 있다. 메서드의 이름을 자유롭게 할 수 있고, 스프링 빈이 스프링 코드에 의존하지 않아도 된다. 코드가 아니라 설정 정보를 사용하기 때문에 외부 라이브러리에도 적용할 수 있어, 인터페이스 방식에 있었던 단점들을 많이 해결해준다.
• destroyMethod 소멸 메서드를 지정하는 속성은 추론 기능을 제공한다.

public class NetworkClient {
    ...

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

    // 종료될 때 호출
    public void close() throws Exception {
        System.out.println("NetworkClient.destroy");
        disconnect();
    }
}

@Bean(initMethod = "init",destroyMethod = "close")
public NetworkClient networkClient() {
	NetworkClient networkClient = new NetworkClient();
    networkClient.setUrl("http://hello-spring.dev");
	return networkClient;
}

 

destroyMethod 내부동작

 

public static final String INFER_METHOD = "(inferred)";

...
public @interface Bean {
		...

		String destroyMethod() default AbstractBeanDefinition.INFER_METHOD;
	
}

destroyMethod 설정의 기본값은 (inferred) 추론으로 등록되어 있다. 라이브러리 대부분 종료 메서드로 close(), shutdown()을 사용하는데 destroyMethod를 따로 지정하지 않았을 경우 close(), shutdown() 같은 메서드를 자동으로 소멸 메서드로 지정해준다.

추론 기능을 사용하기 싫으면 destroyMethod = ""와 같이 빈문자열로 처리해주자.

 

 

 

c. @PostConstruct, @PreDestroy

• @PostConstruct , @PreDestroy   어노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다.
• 최신 스프링에서 가장 권장하는 방법이다. javax.annotation에서 지원하는 기능이기 때문에 스프링이 아닌 다른 컨테이너에서도 동작한다.

public class NetworkClient {
    ...

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

    // 종료될 때 호출
    @PreDestroy
    public void close() throws Exception {
        System.out.println("NetworkClient.destroy");
        disconnect();
    }
}