빈 생명주기 콜백

빈 생명주기 콜백 시작

 

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

 

간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정한다면, 실제로 네트워크에 연결하는 것이 아니고 단순히 문자만 출력하도록 했다.

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

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

 

 

 

생성자 부분을 보면 url 정보 없이 connect 가 호출되는 것을 알 수 있다.

객체를 생성하는 단계에서 url이 없었으며 객체를 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl() 이 호출되어야 url이 존재하게 된다.

 

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

 

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

 

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

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

 

개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있는가?

 

스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양항 기능을 제공한다.

또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다. 

따라서 안전하게 종료 작업을 진행할 수 있다.

 

스프링 빈의 이벤트 라이프 사이클은 다음과 같다.

 

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

 

※ 객체의 생성과 초기화를 분리

생성자는 필수 정보(파라미터)를 받고 메모리를 할당해서 객체를 생성하는 책임을 갖는다.

반면에 초기화는 이렇게 생성된 값들을 활용해서 외부 커넥션을 연결하는 등 무거운 동작을 수행한다.

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

물론 초기화 작업이 내부 값들만 약간 변경하는 정도로 단순한 경우에는 생성자에서 한번엥 다 처리하는 것이 더 나을 수 있다.

 

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

 

1. 인터페이스(InitializeBean, DisposableBean)
2. 설정 정보에 초기화 메서드, 종료 메서드 지정
3. @PostConstruct, @PreDestory 애너테이션 지원

 

인터페이스 InitializingBean, DisposableBean

 

public class NetworkClient implements InitializingBean, DisposableBean {

	...

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

    @Override
    public void destroy() throws Exception {
        disconnect();
    }
}

 

 

출력 결과를 보면 초기화 메서드가 주입 완료 후에 적절하게 호출된 것을 볼 수 있다.

그리고 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출된 것을 볼 수 있다.

 

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

 

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

 

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

 

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

 

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

    public void close() {
        System.out.println("NetworkClient.close");
        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(initMethod = "init", destroyMethod = "close")
        public NetworkClient networkClient(){
            NetworkClient networkClient = new NetworkClient();
            networkClient.setUrl("http://hello-spring.dev");
            return networkClient;
        }
    }
}

 

 

※ 설정 정보 사용 특징

 

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

 

※ 종료 메서드 추론

 

@Bean 의 destroyMethod 속성에 특별한 기능이 있으며 다음과 같다.

 

• 라이브러리 대부분이 close, shutdown 이라는 이름의 종료 메서드를 사용한다.
• @Bean의 destroyMethod 는 기본값이 (inferred) 으로 등록되어 있다.
• 이러한 추론기능은 close, shutdown 라는 이름의 메서드를 자동으로 호출해준다. 이름 그대로 종료 메서드를 추론해서 호출해준다.

 

따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다.

추론 기능을 사용하기 싫다면 destroyMethod = "" 처럼 빈 공백을 지정하면 된다.

 

애너테이션 @PostConstruct, @preDestroy

 

public class NetworkClient {

	...

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

    @PreDestroy
    public void close() {
        System.out.println("NetworkClient.close");
        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;
        }
    }
}

 

 

@PostConstruct, @PreDestroy 두 애너테이션을 사용하면 편리하게 초기화, 종료 실행이 가능하다.

 

 

※ @PostConstruct, @PreDestroy 애너테이션 특징

 

최신 스프링에서 가장 권장하는 방법이며, 애너테이션 하나만 붙이면 되므로 굉장히 편리하다.

패키지를 잘 보면 "javax.annotation.PostConstruct" 이다.

스프링에 종속적 기술이 아니라 JSR-250 라는 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 동작한다.

컴포넌트 스캔과 잘 어울리며 유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다.

외부 라이브러리를 초기화하고 종료해야 하면 @Bean의 기능을 사용해야 한다.

 

결론으로 @PostConstruct, @PreDestroy 애너테이션을 사용한다.

그리고 코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료하려고 하면 @Bean 의 initMethod, destroyMethod 를 사용한다.