[Spring/기본편] 7. 빈 생명주기 콜백

2021. 12. 26. 16:05

빈 생명주기 콜백 시작

데이터베이스 커넥션 풀이나, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면 객체의 초기화와 종료 작업이 필요합니다. (연결을 미리 해두는 이유는 tcp heanshaking을 통해 연결하는데 오래 걸리기 떄문입니다. 스레드 풀과 비슷한 느낌인 것 같습니다.)

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

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

코드

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

테스트 코드

    @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 = 초기화 연결 메시지

당연히 생성자단계에서 출력하는데 setUrl을 하지않았기 때문에, url값은 null로 출력이 됩니다.

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

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

스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료됩니다. 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 합니다. 그런데 개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까요??

스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공합니다. 또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 줍니다. 따라서 안전하게 종료 작업을 진행할 수 있습니다.

스프링 빈의 이벤트 라이프사이클은 아래와 같습니다.

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

참고 : 객체의 생성과 초기화를 분리합시다.

생성자는 필수 정보(파라미터)를 받고, 메모리를 할당해서 객체를 생성하는 책임을 가집니다. 바념ㄴ에 초기화는 이렇게 생성된 값들을 활용해서 외부 커넥션을 연결하는 등 무거운 동작을 수행합니다.

따라서, 생성자 안에서 무거운 초기화 작업을 함께 하는 것 보다는 객체를 생성하는 부분과 초기화 하는 부분을 명확하게 나눈 것이 유지보수 관점에서 좋습니다. 물론 초기화 작업이 내부 값들만 조금 변경하는 정도로 단순한 경우에는 생성자에서 한번에 다 처리하는게 더 좋을 수도 있습니다.

참고 : 싱글톤 빈들은 스프링 컨테이너가 종료될 때 싱글톤 빈들도 함꼐 종료되기 떄문에 스프링 컨테이너가 종료되기 직전에 소멸전 콜백이 일어납니다.

스프링은 크게 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() 메서드로 소멸을 지원합니다.

출력

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

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

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

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

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

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

설정 정보에 @Bean(initMethod = "init", detroyMethod = "close")처럼 초기화, 소멸 메서드를 지정할 수 있습니다. 메소드명을 적으면 됩니다.

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

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

결과

생성자 호출, 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

설정 정보 사용 특징

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

종료 메서드 추론

@Bean의 destroyMethod 속성에는 아주 특별한 기능이 있습니다.
라이브러리는 대부분 close, shutdown 이라는 이름의 종료 메서드를 사용합니다.
@Bean의 destroyMethod는 기본값이 (inferred)(추론)으로 등록되어 있습니다.
이 추론 기능은 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() {
        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;
        }
    }

출력

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

@PostConstruct, @PreDestroy 두 어노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있습니다.

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

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

정리

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

출처

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

스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., - 강의 소개 | 인프런...

www.inflearn.com

'spring > 인프런 강의 정리' 카테고리의 다른 글

[HTTP 웹 기본 지식] 1. 인터넷 네트워크 (0)	2022.01.12
[Spring/기본편] 8. 빈 스코프 (0)	2021.12.26
[Spring/기본편] 6. 의존관계 자동 주입 (0)	2021.12.25
[Spring/기본편] 5. 컴포넌트 스캔 (0)	2021.12.24
[Spring/기본편] 4. 싱글톤 컨테이너 (0)	2021.12.23

선장 일지