[Spring] 빈(Bean) 생명주기 콜백+ 빈 의존관계 주입 후 콜백

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

스프링을 통해 이러한 초기화 작업과 종료 작업을 어떻게 진행하는지 예제로 알아보았다.

간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정해보자.
이 NetworkClient 는 애플리케이션 시작 시점에 connect() 를 호출해서 연결을 맺어두어야 하고, 애플리케이션이 종료되면 disConnect() 를 호출해서 연결을 끊어야 한다. 현재는 생성자에서 connect()를 호출하여 연결을 맺는다.

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(); //스프링 컨테이너를 종료, 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가 호출됨을 알 수 있다. 당연한 것이, 생성 이후 setUrl메서드로 url을 넣어주기때문에(외부 수정자 주입), 생성자를 호출하는 시점에는 url이 없기 때문이다.
우리한테는 "url이 잘 주입되었으니 사용해도 돼~"를 알려줄 누군가가 필요하다.

먼저, 스프링 빈은 간단하게 다음과 같은 라이프사이클을 가진다.

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

스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료된다. 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다. 그런데 개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까?
스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공한다. 또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다. 따라서 안전하게 종료 작업을 진행할 수 있다.

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

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

참고로,
생성자 주입은 빈 생성과 의존관계 주입이 거의 동시에 일어나며, 나머지 주입(일반 메서드 주입, setter 주입, 필드 주입)은 위의 순서를 따른다.

싱글톤 빈의 생명주기를 말하는 것이다. 프로토타입의 경우 빈의 생명주기를 컨테이너가 관리하지 않는다. 프로타입의 빈은 컨테이너와 무관하게 해당 빈이 종료되는 시점에 소멸 전 콜백이 일어난다.

---

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

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

결론부터 말하면, @PostConstruct, @PreDestroy 애노테이션을 우선 사용하자. 코드 수정이 안되는 외부 라이브러리를 초기화 하고 종료해야 하는 경우에는 설정 정보에 초기화 메서드, 종료 메서드를 지정하자.

---

먼저 인터페이스(InitializingBean, DisposableBean) 부터 알아보자

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

서비스  시작 시 호출해야 하는 connect(), call() 메서드를 afterPropertiesSet()에, 종료 시 호출하는 disconnect() 메서드는 destroy()에서 실행하도록 하였다. 
InitializingBean 은 afterPropertiesSet() 메서드로 초기화를 지원한다.
DisposableBean 은 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

출력 결과를 보면 초기화 메서드가 주입 완료 후에 적절하게 호출 된 것을 확인할 수 있다.
그리고 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출 된 것도 확인할 수 있다.

다만 InitializingBean, DisposableBean은 스프링 전용 인터페이스다. 
즉, 해당 코드들이 스프링 전용 인터페이스에 의존하며
초기화, 소멸 메서드의 이름을 변경할 수 없다(코드 변경이 불가능한 외부 라이브러리에 적용 불가능하다).

따라서 다음으로 소개할 두가지 방법을 사용하자.

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

설정 정보에 @Bean(initMethod = "init", destroyMethod = "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;
 }
}

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

설정한 뒤, init()메서드, close() 메서드를 아름답게 사용하면 된다. 
코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다. 외부 라이브러리의 가이드에 따라 초기화 메서드, 종료 메서드를 확인하고 빈 설정정보에 메서드 이름을 써주면 된다.

애노테이션 @PostConstruct, @PreDestroy

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

@PostConstruct , @PreDestroy 이 두 애노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다.
패키지는 javax.annotation.PostConstruct 이다. 스프링에 종속적인 기술이 아니라 JSR-250 라는 자바 표준이다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작한다.

유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다. 외부 라이브러리를 초기화, 종료 해야 하면 바로 이전의 @Bean의 기능을 사용하자.