08. Spring Basic - 빈 생명주기 콜백

MoonJaeGyeong·2023년 9월 25일
Spring

Spring

목록 보기
8/10
post-thumbnail

1. 빈 생명주기 콜백

스프링에서 객체의 초기화와 종료 작업이 어떻게 진행되는지 예제로 알아보자.

간단하게 외부 네트워크에 미리 연결하는 객체를 생성한다 하자. 이 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);
   }
}

실행 코드


import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import
org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

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

생성자 부분을 보면 url 이 설정되기 전에 connect가 호출되는 것을 확인할 수 있다.
생성자에는 url 을 넣지 않고 setUrl() 이 호출되어야 url 이 존재한다.

스프링 빈은 간단하게 객체 생성 -> 의존관계 주입 같은 라이프사이클을 가진다.

스프링 빈은 객체를 생성한 후 의존관계 주입까지 끝이 난 후 데이터를 사용할 수 있는 준비가 완료된다. 스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해 초기화 시점을 알려주는 기능을 제공한다. 또한 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다.

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

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

스프링의 3가지 빈 생명주기 콜백

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

1.1 인터페이스 ( InitializingBean, DisposableBean )

코드

package hello.core.lifecycle;

import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;

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();
   }
}
  • InitializingBean 은 afterPropertiesSet() 메서드로 초기화
  • DisponsableBean 은 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

단점

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

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

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

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

package hello.core.lifecycle;

  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.closeclose + http://hello-spring.dev

설정 정보 사용 특징

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

종료 메서드 추론

  • @Bean 의 destroyMethod 속성에는 아주 특별한 기능이 있다.
  • 라이브러리는 대부분 close, shutdown 이라는 이름의 종료 메서드를 사용한다.
  • @Bean 의 destroyMethod 기본 값이 (inferred) 으로 등록되어 있다.
  • 이 추론 기능은 close, shutdown 라는 이름메서드를 동으로 호출해준다. 이름 그대로 종료 메서드를 추론해서 호출해준다.
  • 추론 기능을 비활성화 하고 싶다면 destroyMethods = "" 로 비워두면 된다.

1.3 애노테이션 @PostContsruct, @PreDestroy

코드

package hello.core.lifecycle;

import javax.annotation.PostConstruct;
import javax.annotation.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();
   }
}

실행 결과

생성자 호출, 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 애노테이션 특징

  • 최신 스프링 에서 가장 권장하는 방법.
  • 애노테이션 하나만 붙이면 되므로 매우 편리
  • 패키지를 잘 보면 javax.annotation.PostConstruct 이다.
  • 컴포넌트 스캔과 잘 어울린다.
  • 유일한 단점은 외부 라이브러리에는 적용하지 못한다.

2. 정리

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



<출처 : 스프링 핵심 원리 - 기본편 by 김영한>

profile
MoonJaeGyeong
내 맘대로 끄적이는 개발 블로그
이전 포스트

07. Spring Basic - 의존관계 자동 주입 (2)

다음 포스트

여기 의존성 하나요!

0개의 댓글