8-2. 빈 생명주기 콜백을 지원하는 3가지 방법

Q. 빈 생명주기 콜백은 어떻게 사용하나요?
A. @PostConstruct, @PreDestroy 어노테이션을 붙이면 됩니다.

 

안녕하세요.

아래 게시글에서 빈 생명주기 콜백이 무엇인지와 왜 필요한지를 알아보았습니다. 

https://passionate.tistory.com/24?category=1250204 

8-1. 빈 생명주기 콜백

 

오늘은 스프링에서 빈 생명주기 콜백을 지원하는 3가지 방법을 알아보겠습니다. 

- 인터페이스(Intializing Bean, Disposable Bean)

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

- @PostConstruct, @PreDestroy 어노테이션 

 

하나씩 알아봅시다.

 

인터페이스 InitializingBean, DisposableBean

스프링 전용 인터페이스인 InitializingBean, DisposableBean을 상속받아서 사용합니다.

코드를 바로 살펴봅시다.

NetworkClinet 클래스

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

테스트 코드

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

InitializingBean은 afterPropertiesSets() 메소드로 초기화를 지원하고,

DisposableBean은 destroy() 메소드로 소멸을 지원합니다.

두 함수를 오버라이드 해서 초기화, 소멸을 구현하면 됩니다.

NetworkClinet 객체가 스프링 빈에 등록되고 의존관계가 주입된 다음, afterPropertiesSets()가 불려서 초기화됩니다.

또한, 스프링 컨테이너가 종료되기 전 destroy()가 불려서 소멸됩니다. 

 

이 방식은 스프링 초창기에 나온 방법이고, 현재는 잘 이용되지 않습니다.

세 가지의 단점이 있기 때문입니다. 

1) 이 인터페이스는 스프링 전용 인터페이스이다. 해당 코드가 스프링 전용 인터페이스에 의존합니다. 코드는 순수 자바 코드로 작성되어서 특정한 프레임워크에 의존하지 않는 것이 바람직한데, 이 경우는 스프링 프레임워크에 의존해야 합니다. 

2) 초기화, 소멸 메소드의 이름을 변경할 수 없습니다. 반드시 afterPropertiesSets(), destroy()라는 고정된 이름의 메소드를 오버라이드 해야합니다.

3) 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없습니다. 빈에 등록할 클래스에서 구현해야 하므로, 코드를 고칠 수 없으면 사용할 수 없습니다. 

 

 

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

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

코드를 살펴봅시다. 위의 코드에서 변경된 부분을 위주로 첨부하였습니다. 

NetworkClinet 코드

...
    public void init() throws Exception {
        connect();
        call("초기화 연결 메시지");
    }

    public void close() throws Exception {
        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(initMethod = "초기화 메소드 이름", destroyMethod = "소멸 메소드 이름")을 지정하면 됩니다.

앞에서 살펴본 인터페이스 방식과 다르게, 빈을 등록하는 설정 정보 파일에서 메소드를 지정한다는 특징이 있습니다.

이 방식을 사용하면 앞서 살펴본 인터페이스 방식의 문제점 세 가지를 모두 해결할 수 있습니다. 

1) 코드가 스프링 전용 인터페이스에 의존한다. -> NetworkClinet 코드를 보면, 전혀 spring 프레임워크에 의존하지 않고 순수 자바 코드로 작성되었음을 볼 수 있습니다. 스프링 빈이 스프링 코드에 의존하지 않습니다. 

2) 초기화, 소멸 메소드의 이름을 변경할 수 없다. -> 자유롭게 지정할 수 있습니다. 

3) 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다. -> 코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메소드를 적용할 수 있습니다.

 

종료 메소드 추론

@Bean의 destroyMethod에는 특별한 기능이 있습니다.

기본값으로 inferred로 등록되어 있어서, 종료 메소드를 추론합니다.

close, shutdown 이라는 메소드가 있으면 이를 종료 메소드로 추론하여 자동으로 호출합니다. 

 

그러나 이 방식도 Bean을 등록할 때 초기화, 종료 메소드를 작성해주어야 한다는 번거로움이 있습니다. 

그리고 컴포넌트 스캔으로 등록할 때는 사용할 수 없습니다. 

두 문제점을 해결한 것이 세 번째 방법입니다. 

 

어노테이션 @PostConstruct, @PreDestroy

이 방식은 스프링에서 가장 권장하는 방법으로, 어노테이션 하나만 붙이면 되므로 매우 편리합니다.

스프링 빈으로 등록할 클래스에서 초기화 메소드 위에 @PostConstruct, 종료 메소드 위에 @PreDestroy를 붙이면 됩니다. 

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

    @PreDestroy
    public void close() throws Exception {
        disConnect();
    }
 ...

이 방법을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있습니다.

또한, 패키지를 보면 javax.annotation.PostConstruct입니다. 스프링에 종속적인 기술이 아닙니다.

컴포넌트 스캔과도 잘 어울립니다. @Component를 했을 때도 사용할 수 있습니다.

유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것입니다. 외부 라이브러리를 초기화, 종료해야 하면 두 번째 방법인 @Bean의 기능을 사용합니다.

 

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

 

 

인프런  '스프링 핵심 원리 - 기본편' 강의를 듣고 공부하며 정리한 자료입니다. 

잘못된 부분은 피드백 주시면 감사하겠습니다. 

글 읽어주셔서 감사합니다 :-)

 

참고자료

[1] 스프링 핵심 원리 - 기본편, 섹션 8. 빈 생명주기 콜백 https://www.inflearn.com/course/스프링-핵심-원리-기본편