[Spring] 빈 생명주기 콜백

 

빈 생명주기 콜백 시작

애플리케이션 시작 시점에 필요한 연결을 미리 해두고 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면 객체의 초기화와 종료 작업이 필요하다. 스프링을 통해서 이러한 초기화와 종료 작업이 어떻게 진행되는지를 알아보자

 

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

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

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

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

 

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 정보 없이 connect가 호출되고 있다. 객체를 생성할 때는 url이 없고 객체를 생성한 다음에 외부에서 수정자 주입을 통해 setUrl()이 호출되어야 url이 존재하게 된다.

 

여기서 우리는 스프링 빈의 라이프 사이클을 알 수가 있다.

객체 생성 -> 의존관계 주입

 

스프링 빈은 객체를 생성하고 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 된다. 따라서 초기화 작업은 의존관계 주입이 모두 끝나고 다음에 호출해야 된다. 하지만 개발자는 의존관계 주입이 끝난 시점을 알 수가 없지만 스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 기능과 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 제공한다.

 

이처럼 스프링 빈의 이벤트 사이클은

스프링 컨테이너 생성 -> 스프링 빈 생성 -> 의존관계 주입 -> 초기화 콜백 -> 사용 -> 소멸 전 콜백 -> 스프링 종료라는 것을 알 수가 있다.

 

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

 

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

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

 

인터페이스 InitializingBean, DisposableBean

public class NetworkClient implements InitializingBean, DisposableBean {

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

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

결과

• InitializingBean은 afterPropertiesSet() 메서드로 초기화를 지원한다.
• DisposableBean은 destroy() 메서드로 소멸을 지원한다.
• 결과를 통해 초기화 메서드가 주입 완료 후에 호출된 것을 알 수가 있다.
• 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출된 것을 알 수가 있다.

 

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

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

 

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

public class NetworkClient {

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

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

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

@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의 destroyMethod는 기본값이 inferred(추론)으로 등록되어 있다.
• 추론 기능은 close, shutdown이라는 이름의 메서드를 자동으로 호출해 준다.(라이브러리는 대부분 close, shutdown이라는 이름의 종료 메서드를 사용한다.)
• 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다.
• 추론 기능 사용을 원하지 않을 경우 destroyMethod="" 이런 식으로 공백을 지정하면 된다.

 

@PostConstruct, @PreDestroy 어노테이션

 

public class NetworkClient {

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

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

    @PreDestroy
    public void close() throws Exception {
        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의 특징

• JSR-250이라는 자바 표준이다. -> 다른 컨테이너에서도 동작한다.
• 외부 라이브러리에 적용하지 못한다. -> 외부 라이브러리 초기화, 종료해야 된다면 @Bean의 기능을 사용한다.

 

이처럼 3가지의 빈 생명주기 콜백을 알아봤다. 각각의 콜백 방법에 장단점이 있으므로 본이 어떤 방식으로 개발하는지에 따라서 해당 3가지 중 가장 적절한 방법을 사용하면 객체의 초기화와 종료에 대해서 알 수 있을 것이다.

 

출처 : 인프런 우아한 형제들 최연소 기술이사 김영한의 스프링 완전 정복(스프링 핵심원리 - 기본 편)