스프링 핵심원리 기본편 - Ch08. 빈 생명주기 콜백

목록

1. 포스팅 개요
2. 본론
     2-1. 빈 생명주기 콜백 시작
     2-2. 인터페이스 InitializingBean, DisposableBean
     2-3. 빈 등록 초기화, 소멸 메서드
     2-4. 애너테이션 @PostConstruct, @PreDestroy
3. 요약

1. 포스팅 개요

인프런에서 영한님의 스프링 핵심 원리 기본편 Section08 빈 생명주기 콜백을 학습하며 정리한 포스팅이다.

| 참고 이전 포스팅

2. 본론

2-1. 빈 생명주기 콜백 시작

실무에서 데이터베이스 커넥션 풀이나, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고, 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화와 종료 작업이 필요하다.
스프링을 통해 이러한 초기화 작업과 종료 작업을 어떻게 진행하는지 알아본다.

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

package hello.core.lifecycle;

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() {
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        NetworkClient client = ac.getBean(NetworkClient.class);
        ac.close(); // ApplicationContext 닫아줘야 함.

    }

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

결과는 다음과 같다.
참고로 이전과는 다르게 ApplicationContext을 닫아주었다.
참고로 close() 메서드를 호출하려면, ConfigurableApplicationContext 혹은 AnnotationConfigApplicationContext 타입을 선언해줘야 한다.

생성자 호출, url = null
connect: null
call : null message = 초기화 연결 메세지

빈으로 등록할 때, 생성자를 호출하면서, 다음과 같은 로직이 진행되기 때문에, url에 null이 들어갔다.

System.out.println("생성자 호출, url = " + url);
connect();
call("초기화 연결 메세지");

현재 생성만 해주고, 아무것도 해주지 않았다.

• 생성자 부분을 보면 url 정보 없이 connect가 호출되는 것을 확인할 수 있다.
• 객체를 생성하는 단계에는 url이 없고, 객체를 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl()이 호출되어야 url이 존재하게 된다.

이전부터 중복되는 얘기지만 스프링 빈은 간단하게 다음과 같은 라이프사이클을 가진다.

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

스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료된다.
따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다.

그런데 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까?

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

스프링 빈의 이벤트 라이프사이클

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

참고로 위는 싱글톤에 대한 얘기다.

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

스프링은 다양한 방식으로 생명주기 콜백을 지원한다

참고

생성자는 필수 정보(파라미터)를 받고, 메모리를 할당해서 객체를 생성하는 책임을 가진다.
반면에 초기화는 생성된 값들을 활용해서 외부 커넥션을 연결하는등 무거운 동작을 수행한다.
따라서 생성자 안에서 무거운 초기화 작업을 함께 하기보다는 객체를 생성하는 부분과 초기화 하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋다.
물론 초기화 작업이 (내부 값들만 약간 변경하는 정도로) 단순한 경우에는 생성자에서 한번에 다 처리하는게 더 나을 수 있다.

또한 객체를 생성을 해놓고, 최초의 액션이 주어질 때 초기화가 이루어지도록 지연시킬 수도 있다.(그런 상황이 많지는 않다.)

객체의 생성과 초기화를 분리하자.

참고

• 싱글톤 빈들은 스프링 컨테이너가 종료될 때 싱글톤 빈들도 함께 종료되기 때문에 스프링 컨테이너가 종료되기 직전에 소멸전 콜백이 일어난다.
• 싱글톤 처럼 컨테이너의 시작과 종료까지 생존하는 빈도 있지만, 생명주기가 짧은 빈들도 있는데 이 빈들은 컨테이너와 무관하게 해당 빈이 종료되기 직전에 소멸전 콜백이 일어난다. 자세한 내용은 뒤에서 스코프에서 알아본다.

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

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

2-2. 인터페이스 InitializingBean, DisposableBean

코드를 확인하자

InitializingBean

public interface InitializingBean {

  ...

    void afterPropertiesSet() throws Exception;
}

afterPropertiesSet() 메서드는 의존 관계주입이 끝나면 호출하는 것이다.

DisposableBean

public interface DisposableBean {

    void destroy() throws Exception;

}

destroy() 메서드는 종료시 호출하는 것이다.

기존의 NetworkClient 코드를 살짝 수정해보면,

public class NetworkClient implements InitializingBean, DisposableBean {

    ...
    public NetworkClient() {
      System.out.println("생성자 호출, url = " + url);
      connect(); // 삭제
      call("초기화 연결 메세지"); // 삭제
    }

    ...

    @Override
    public void afterPropertiesSet() throws Exception {
      soutm // System.out.println("NetworkClient.afterPropertiesSet");
      connect();
      call("초기화 연결 메세지");
    }

    @Override
    public void destroy() throws Exception {
      soutm // System.out.println("NetworkClient.destroy");
      disconnect();
    }
}

싱글톤 빈이기 때문에, 의존관계가 주입되면 afterPropertiesSet()이 호출되고,
종료되면, destroy()가 호출될 것이다.

따라서 테스트를 돌려보면, 결과는 다음과 같다.

생성자 호출, url = null
NetworkClient.afterPropertiesSet
connect: http://hello-spring.dev
call : http://hello-spring.dev message = 초기화 연결 메세지
11:11:17.863 [Test worker] DEBUG o.s.c.a.AnnotationConfigApplicationContext -- Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@31e4bb20, started on Tue Dec 19 11:11:17 KST 2023 // 클로징 ~
NetworkClient.destroy
close: http://hello-spring.dev

생성자가 호출되고, 의존 관계 주입이 끝나서 afterPropertiesSet()를 통해서 connect()가 호출되었다.
그리고 종료시점에 destroy()를 통햇 disconnect()가 호출되었다.

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

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

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

2-3. 빈 등록 초기화, 소멸 메서드

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

다음과 코드를 같이 변경해준다.

public class NetworkClient {

  ...

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

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

  ...
}


public class BeanLifeCycleTest {

    ...

    @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 = 초기화 연결 메세지
11:16:40.286 [Test worker] DEBUG o.s.c.a.AnnotationConfigApplicationContext -- Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@31e4bb20, started on Tue Dec 19 11:16:40 KST 2023
NetworkClient.close
close: http://hello-spring.dev
11:16:40.290 [Test worker] DEBUG o.s.b.f.s.DisposableBeanAdapter -- Custom destroy method 'close' on bean with name 'networkClient' completed

설정 정보 사용 특징

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

종료 메서드 추론

@Bean의 destroyMethod 속성에는 특별한 기능이 있다.

inferred의 뜻은 추론하다, 추적하다는 의미를 가지고 있다.

• 라이브러리는 대부분 close , shutdown 이라는 이름의 종료 메서드를 사용한다.

• @Bean의 destroyMethod 는 기본값이 (inferred) (추론)으로 등록되어 있다.

  • 이 추론 기능은 close , shutdown 라는 이름의 메서드를 자동으로 호출해준다. 이름 그대로 종료 메서드를 추론해서 호출해준다.

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

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

  • 왜냐하면 기본값이다.

    

2-4. 애너테이션 @PostConstruct, @PreDestroy

결론부터 말하면 그냥 이걸 쓰면 된다.

우선 코드를 보자.
(참고로 PostConstruct 는 생성이 된 이후를, PreDestroy는 소멸하기 전을 가리킨다.)

public class NetworkClient {
  ...

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

public class BeanLifeCycleTest {
  ...

      @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 = 초기화 연결 메세지
11:26:40.723 [Test worker] DEBUG o.s.c.a.AnnotationConfigApplicationContext -- Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@31e4bb20, started on Tue Dec 19 11:26:40 KST 2023
NetworkClient.close
close: http://hello-spring.dev

간단하다.

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

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

간단히 정리하면,

@PostConstruct, @PreDestroy 애노테이션을 사용하자

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

3. 요약

빈 생명주기를 알려주는 콜백에 대해서 어떠한 방식을 사용할 수 있는지 알아보았다.

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