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

 

그리고 이를 실행해본다.

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

(ApplicationContext는 close를 제공해주지 않기 때문에 ConfigurableApplicationContext 사용 -> 일반적으로 new를 통해 컨테이너를 직접 생성했다면 close도 직접 해주는 것이 맞다.)

 

실행해보면 다음과 같은 이상한 결과가 나온다.

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

이는 객체 생성시 url의 값이 들어가기 전에 connect가 호출되어 발생하는 현상이다.

당연한 이야기지만 setUrl 메서드를 통해 url에 값을 넣어줘야 url이 존재하게 된다.

 

이처럼 객체가 생성되고 의존관계가 주입되기 전에 초기화 과정을 진행하면 안된다. 그렇다면 개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까? 스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려준다. 또한 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다.

 

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

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

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

유지보수 관점에서도 객체를 생성하는 부분과 초기화 부분은 명확하게 나누는 것이 좋다. 생성자는 정말 객체를 생성하고 값을 넣어주는 정도에만 집중을 해야 한다.

 

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

• 인터페이스
• @Bean에 메서드 지정
• 애노테이션 지원

인터페이스 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();
 }
}

InitializingBean은 afterProperitiesSet 메서드로 초기화를 지원하고, 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

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

 

그러나 이 인터페이스는 스프링 전용 인터페이스이기 때문에 코드가 스프링에 의존하게 된다. 초기화, 소멸 메서드의 이름을 변경할 수도 없고, 외부 라이브러리에 적용할 수도 없다. 이런 단점이 명확하기에 최근에는 거의 사용하지 않는다.

 

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

@Bean(initMethod = "init", destroyMethod = "close")

설정 정보 @Bean을 위 코드로 수정하고 각각의 메서드를 인터페이스때와 비슷하게 추가한다. 결과는 동일하다.

 

설정 정보로부터 메서드를 지정하는 방식은 메서드 이름을 자유롭게 줄 수 있고 스프링 인터페이스에 의존하지 않는다는 장점이 있다. 또한 코드가 아닌 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다.

 

- 종료 메서드 추론

라이브러리는 대부분 close, shutdown이라는 이름의 종료 메서드를 사용한다. @Bean의 destroyMethod는 기본값이 (inderred)(추론)으로 등록되어 있기 때문에 자동으로 close, shutdown 이름의 메서드를 호출해준다. 따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다.

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

 

애노테이션 @PostConstruct, @PreDestroy

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

public class NetworkClient {
 private String url;
 
 public NetworkClient() {
 System.out.println("생성자 호출, url = " + url);
 }
 
...

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

단순히 두 애노테이션을 붙여 가장 편리하게 초기화와 종료를 실행할 수 있다. 최신 스프링에서 가장 권장하는 방법이다.

패키지를 잘 보면 javax.annotation.PostConstruct인데, 이는 스프링에 종속적인 기술이 아니라 자바 표준이라는 것이다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작한다.

메서드를 직접 @Bean에 등록하지 않아도 되기 때문에 컴포넌트 스캔과 잘 어울린다. 유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다. 외부 라이브러리를 초기화, 종료 해야 하면 @Bean의 기능을 사용하자.

 

- 정리

1. 애노테이션을 사용하자.

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