[Spring] 빈 생명주기 콜백

출처 :  김영한님의 스프링 핵심 원리 - 기본편 인프런 강의

스프링 핵심 원리 - 기본편 - 인프런 | 강의

 

빈 생명주기 콜백

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

• 데이터베이스 커넥션 풀 : 애플리케이션은 보통 관계형 DB를 사용하는데 TCP/IP 핸드쉐이킹 작업이 오래 걸리기 때문에 애플리케이션 서버가 올라올 때 DB랑 미리 연결을 맺어놓는다. 이렇게 하면 고객의 요청이 올 때 미리 연결해둔 것을 재활용할 수 있다.
• 네트워크 소켓 : 서버가 뜰 때 미리 네트워크 소켓을 열어둬야 고객의 요청이 왔을 때 빠르게 응답을 줄 수 있다.

 

스프링 빈이 생성되거나 죽기 일보 직전에 스프링이 빈 안의 메서드를 호출해줄 수 있는 기능으로 생성되고 나서 초기화할 때 호출해주고 빈이 소멸하기 직전에 안전하게 종료될 수 있도록 호출해준다. 

 

시작 시점에 connect()로 연결을 맺어두고 종료되면 disConnect()로 연결을 끊는 예제

public class NetworkClient {

    // 접속해야할 서버의 url
    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("connect: " + url);
    }

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

    //서비스 종료시 호출
    public void disconnect() {
        System.out.println("close: " + 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();
            
            // url 설정
            networkClient.setUrl("http://hello-spring.dev");

            return networkClient;
        }
    }
}

실행해보면 url이 모두 null로 나온다. 생성자 부분을 보면 url 정보 없이 connect가 호출되고 있다.

 

객체를 생성하는 단계에서 url이 없고 생성한 다음에야 외부에서 수정자 주입을 통해 setUrl()이 호출되야 url이 주입되기 때문이다. 당연히 수정자 주입은 스프링 빈 라이프 사이클 2단계인 의존관계 주입 시에 일어남으로 1단계인 스프링 빈 등록 시에는 url이 없는 것이다.

 

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

스프링 빈은 객체를 생성하고 의존관계 주입이 완료되어야 필요한 데이터를 사용할 수 있기 때문에 초기화 작업은 의존관계 주입이 모두 완료되고 이뤄져야 한다.

 

이 의존관계 주입이 끝났음을 알리기 위해 초기화 콜백 메서드를 스프링 빈에게 날려서 초기화 시점을 알려주고 사용이 다 끝나고 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 줘서 안전하게 종료할 수 있도록 해준다.

 

 

그렇다면 그냥 초기화를 생성자를 통해 해버리는 게 간편하지 않을까?

 

가능은 하겠지만 SRP(단일 책임 원칙)을 지키기 위해 생성자는 객체를 생성하는 데에 집중하도록 해야한다. 

생성자는 필수 정보만을 받아서 객체를 생성하는 책임만 수행하고 초기화를 통해 생성된 값들을 활용해 다른 작업들을 수행해야 유지보수 관점에서 좋다.

그러므로 객체의 생성과 초기화를 분리해주자

 

이렇게 객체의 생성과 초기화를 분리해두면 객체를 생성해놓고 실제 외부 커넥션 맺는 것은 최초의 어떤 행위가 올 때까지 미룰 수 있는 장점(지연 효과)도 생긴다. 생성만 해두고 기다리다가 최초의 액션이 주어지면 그 때 초기화하면 된다.

 

스프링의 빈 생명주기 콜백 기능

1. 인터페이스 (InitializingBean, DisposableBean)

public class NetworkClient implements InitializingBean, DisposableBean{

    ...

    // 의존관계 주입이 끝나면
	@Override
	public void afterPropertiesSet() throws Exception {
		connect();
		call("초기화 연결 메시지");
	}
    
	@Override
	public void destroy() throws Exception {
		disConnect();
	}
}

• InitializingBean : afterPropertiesSet() 메서드로 초기화 지원
• DisposableBean : destroy() 메서드로 소멸 지원

생성자 호출 시에는 null 값이고 의존관계 주입 완료 후에 초기화 메서드가 적절하게 호출되는 것을 볼 수 있다.

스프링 컨테이너의 종료 직전에 소멸 메서드도 잘 호출된다.

 

하지만 이 인터페이스는 스프링 전용 인터페이스이기 때문에 스프링에 매우 의존적이라서 초기화, 소멸 메서드의 이름을 변경할 수 없을 뿐만 아니라 코드를 고칠 수 없는 외부 라이브러리에는 오버라이딩을 할 수가 없어서 적용할 수가 없다. 

 

그래서 이 방법은 거의 사용하지 않는다.

 

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

설정 정보 @Bean의 속성으로 초기화, 소멸 메서드를 지정하는 방법

 

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

설정 정보 @Bean에 초기화 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;
    }
}

마찬가지로 잘 동작한다.

 

메서드 이름을 init, close 외에도 자유롭게 설정할 수 있고 인터페이스를 사용한 것이 아니라서 스프링에 의존하지 않아도 된다. 또, 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 적용을 할 수 있다. 

 

실무에서 은근 외부 라이브러리 중 초기화, 종료 메서드를 호출해줘야 할 때가 많은데 지금처럼 스프링 빈으로 등록하면서 초기화, 소멸 메서드를 지정해주면 된다!

 

종료 메서드 추론

@Bean의 destroyMetho는 기본 값이 inferred(추론)이라서 추론 기능이 있다. 이 추론 기능은 close, shutdown 종료 메서드를 자동으로 추론해서 호출해주기 때문에 생략해도 잘 동작한다.

 

3. 애노테이션 @PostConstruct, @PreDestroy

이름 그대로 생성 직후에, 소멸 직전에 라는 뜻의 애노테이션을 이용한 방법이다. 

public class NetworkClient {

    ...

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

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

애노테이션만 붙였을 뿐인데 잘 동작한다. 간편해서 최신 스프링에서 가장 권장하는 방법이다.  또한 자바 표준 기술이기 때문에 스프링에 의존하지 않아도 되고, 다른 컨테이너에서도 동작할 수 있다. 컴포넌트 스캔과도 잘 어울린다. @Bean 등록이 아닌 컴포넌트 스캔을 해도 잘 동작한다.

 

유일한 단점은 코드에 애노테이션을 붙이는 거라서 코드를 변경하지 못하는 외부 라이브러리에는 적용하지 못한다. 외부 라이브러리를 초기화, 종료해야 한다면 아까 사용한 @Bean으로 초기화, 종료 메서드를 지정하자