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

다음과 같이 정의하고 테스트 코드를 짜보자.

public class BeanLifeCycleTest {
    @Test
    public void lifeCycleTest(){
        System.out.println("**");
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        System.out.println("**");
        NetWorkClient client = ac.getBean(NetWorkClient.class);
        System.out.println("**");
        ac.close();
        System.out.println("**");
    }

    @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 = 초기화 연결 메세지
다음과 같이 나오게 된다.

url 정보 없이 connect 메서드가 호출이 되고, 이후에 setUrl()로 url을 세팅해주기 때문이다.
스프링 빈은 객체 생성 -> 의존관계 주입의 라이프사이클을 가진다.
스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료된다.
따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다.

개발자가 의존관계 주입이 완료된 것을 알기 위해서 스프링 빈의 콜백 메서드를 통해서 알 수가 있다.
또한 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 날려주기도 한다.

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

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

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

설정 정보를 통한 방법과 어노테이션을 통한 방법만 살펴보겠다.

---

설정 정보에 초기화 메서드, 종료 메서드 지정하는 경우

NetWorkClient.java
    //의존관계 주입이 끝나면 실행해주겠다는 뜻
    public void init() throws Exception {
        System.out.println("NetWorkClient.afterPropertiesSet");
        connect();
        call("초기화 연결 메세지");
    }

    public void close() throws Exception {
        System.out.println("NetWorkClient.destroy");
        disconnect();
    }

BeanLifeCycleTest.java
    @Configuration
    static class LifeCycleConfig{
        @Bean(initMethod = "init", destroyMethod = "close")
        public NetWorkClient netWorkClient() {
            NetWorkClient netWorkClient = new NetWorkClient();
            netWorkClient.setUrl("http://hello-spring.dev");
            return netWorkClient;
        }
    }

의존관계 주입이 완료되면 호출되는 메서드를 initMethod="메서드명" 을 통해 나타내었고, 빈 소멸전 콜백은 destroyMethod="메서드명"을 통해 선언하였다.
destroyMethod 내부에 들어가보면 default 값이 "(inferred)"로 나와있는데 이는 추론이라는 뜻을 가진다.
라이브러리 대부분이 소멸 콜백을 close, shutdown과 같은 이름의 메서드를 가지는데, 이 추론기능은 앞의 두 이름의 메서드를 호출해준다.
이 덕분에 close, shutdown의 이름을 가지고 있다면 따로 명시해주지 않아도 default 처리로 돌아가게 된다.
해당 추론기능을 사용하고 싶지 않다면 destroyMethod=""로 표현해주면 된다. 또는 다른 메서드명일 경우에도 그 메서드명을 기입하면 된다.

public class BeanLifeCycleTest {
    @Test
    public void lifeCycleTest(){
        System.out.println("**");
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        System.out.println("**");
        NetWorkClient client = ac.getBean(NetWorkClient.class);
        System.out.println("**");
        ac.close();
        System.out.println("**");
    }

    @Configuration
    static class LifeCycleConfig{
        @Bean(initMethod = "init", destroyMethod = "close")
        public NetWorkClient netWorkClient() {
            NetWorkClient netWorkClient = new NetWorkClient();
            netWorkClient.setUrl("http://hello-spring.dev");
            return netWorkClient;
        }
    }
}

전체 Test 코드인데 결과는 다음과 같이 나온다.

생성자 호출, url = null
NetWorkClient.afterPropertiesSet
connect: http://hello-spring.dev
call: http://hello-spring.dev msg=초기화 연결 메세지
**
**
15:32:19.863 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@4e096385, started on Wed Oct 21 15:32:19 KST 2020
NetWorkClient.destroy
close: http://hello-spring.dev
**

테스트 시작하면서 **이 가장먼저 튀어나오는데 생략해서 올렸다.
NetWorkClient 객체를 생성하고 의존관계 주입을 완료한 후에 init 메서드가 호출이 된 것을 볼 수가 있다.

다음과 같이 설정 정보를 이용하게되면,

• 메서드 이름을 자유롭게 줄 수 있다.
• 스프링 빈이 스프링 코드에 의존하지 않는다.
• 코드가 아니라 설정 정보를 이용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 적용시킬 수 있다.
  같은 장점을 가지게 된다.

---

@PostConstruct, @PreDestroy 어노테이션 사용

가장 최신의 방법이고 굉장히 간단한 방법이다.

    //의존관계 주입이 끝나면 실행해주겠다는 뜻
    @PostConstruct
    public void init() throws Exception {
        System.out.println("NetWorkClient.afterPropertiesSet");
        connect();
        call("초기화 연결 메세지");
    }

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

메서드명은 상관이 없고 위에 다음과 같이 어노테이션을 붙인다.

    @Configuration
    static class LifeCycleConfig{
        @Bean
        public NetWorkClient netWorkClient() {
            NetWorkClient netWorkClient = new NetWorkClient();
            netWorkClient.setUrl("http://hello-spring.dev");
            return netWorkClient;
        }
    }

@Bean 설정에 따로 적어줄 필요도 없다. 이게 끝이다. 결과값도 위의 결과값과 그대로 나오게 된다.

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

다음과 같은 패키지를 가지게 되기 때문에, 스프링에 종속적이지 않으므로 스프링이 아닌 다른 컨테이너에서도 동작할 수가 있다.
간단하기 까지한 이 방법의 유일한 단점은 코드 수정이 불가능한 외부 라이브러리에서 사용하지 못하는 것이다.

따라서, 외부 라이브러리에 적용해야될 경우에는 @Bean의 설정 정보를 수정하는 방법을 택하고 그 외에는 어노테이션을 이용한 방법을 사용하면 된다.

---