빈 생명주기 콜백
데이터베이스 커넥션 풀이나, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고, 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화와 종료 작업이 필요합니다.
간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정해보겠습니다.
실제로 네트워크에 연결하는 것은 아니고, 간단하게 문자만 출력하도록 진행했습니다.
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);
}
}public class BeanLifeCycleTest {
@Test
public void lifeCycleTest() {
ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
NetworkClient client = ac.getBean(NetworkClient.class);
ac.close();
}
@Configuration
static class LifeCycleConfig {
@Bean
public NetworkClient networkClient() {
NetworkClient networkClient = new NetworkClient();
networkClient.setUrl("http://hello-spring.dev");
return networkClient;
}
}하지만 실행하면 아래와 같이 결과가 나옵니다.
생성자 부분을 보면 url 정보가 없이 connect가 호출됩니다.
즉, 객체를 생성하는 단계에는 url이 없고, 객체를 생성한 다음에야 외부에서 수정자 주입을 통해 setUrl()이 호출되어야 url이 존재하게 되는 것 입니다.
스프링 빈은 객체 생성 → 의존관계 주입 과 같은 라이프사이클을 가집니다.
스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료됩니다. 즉, 초기화 작업은 의존관계 주입이 모두 끝나고 난 다음에 호출해야 합니다.
그러면 개발자가 의존관계 주입이 완료된 시점은 어떻게 알 수 있을까요?
스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해 초기화 시점을 알려주는 다양한 기능을 제공한다고 합니다. 또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다고 합니다. 즉, 안전하게 종료 작업을 진행할 수 있는 것 입니다.
스프링 빈의 이벤트 라이프사이클
스프링 컨테이너 생성 → 스프링 빈 생성 → 의존관계 주입 → 초기화 콜백 → 소멸전 콜백 → 스프링 종료
초기화 콜백: 빈이 생성되고, 빈의 의존관계 주입이 완료된 후 호출
소멸전 콜백: 빈이 소멸되기 직전에 호출
스프링은 다양한 방식으로 생명주기 콜백을 지원합니다.
참고로 객체의 생성과 초기화를 분리하는 것이 좋습니다.
생성자는 필수 정보를 받고, 메모리를 할당해서 객체를 생성하는 책임을 가집니다. 반면에 초기화는 생성된 값들을 활용하여 외부 커넥션을 연결하는 등 다른 동작을 수행합니다.
즉, 역할이 다르기 때문에 명확하게 나누는 것이 유지보수 관점에서 좋습니다.
만약 초기화 작업이 단순한 경우에는 생성자에서 한번에 처리하는게 더 좋을 수도 있습니다.
추가로 싱글톤 빈들은 스프링 컨테이너가 종료될 때 싱글톤 빈들도 함께 종료되기 때문에 스프링 컨테이너가 종료되기 직전에 소멸전 콜백이 일어납니다.
스프링은 크게 3가지 방법으로 빈 생명주기 콜백을 지원합니다.
인터페이스(InitializingBean, DisposableBean)
설정 정보에 초기화 메서드, 종료 메서드 지정
@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 {
System.out.println("NetworkClient.afterPropertiesSet");
connect();
call("초기화 연결 메시지");
}
@Override
public void destroy() throws Exception {
System.out.println("NetworkClient.destroy");
disconnect();
}
}InitializingBean: afterPropertiesSet() 메서드로 초기화를 지원합니다.
DisposableBean: destroy() 메서드로 소멸을 지원합니다.
출력 결과를 보면 초기화 메서드가 주입 완료 후에 적절하게 호출된 것을 확인할 수 있습니다.
스프링 컨테이너의 종료가 호출되니 소멸 메서드가 호출되는 것도 확인할 수 있습니다.
초기화, 소멸 인터페이스 단점
해당 인터페이스는 스프링 전용 인터페이스입니다. 즉, 해당 코드가 스프링 전용 인터페이스에 의존합니다.
초기화, 소멸 메서드의 이름을 변경할 수 없습니다.
내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없습니다.
참고로 인터페이스를 사용하는 초기화, 소멸 방법은 스프링 초창기에 나온 방법입니다.
빈 등록 초기화, 소멸 메서드 지정
설정 정보에 @Bean(initMethod = "init", destroyMethod = "close") 같이 초기화, 소멸 메서드를 바로 지정할 수 있습니다.
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();
}
}public class BeanLifeCycleTest {
@Test
public void lifeCycleTest() {
ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
NetworkClient client = ac.getBean(NetworkClient.class);
ac.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;
}
}
}설정 정보 사용 특징
메서드 이름을 자유롭게 작성할 수 있습니다.
스프링 빈이 스프링 코드에 의존하지 않습니다.
코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에서도 초기화, 소멸 메서드를 적용할 수 있습니다.
소멸 메서드 추론
@Bean의 destroyMethod 속성에는 특별한 기능이 있는데, 라이브러리는 대부분 close, shutdown 이라는 이름의 소멸 메서드를 사용합니다.
@Bean의 destroyMethod는 기본값이 (inferred)(추론)으로 등록되어 있습니다. 이 추론 기능은 close, shutdown 이라는 이름의 메서드를 자동으로 호출합니다. 즉, 이름 그대로 소멸 메서드를 추론해서 호출해주는 것 입니다.
따라서 직접 스프링 빈으로 등록하면 소멸 메서드는 따로 적어주지 않아도 잘 동작합니다.
추론 기능을 사용하기 싫으면 destoryMethod=”” 처럼 빈 공백을 지정하면 됩니다.
어노테이션 @PostConstruct, @PreDestory
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();
}
}public class BeanLifeCycleTest {
@Test
public void lifeCycleTest() {
ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
NetworkClient client = ac.getBean(NetworkClient.class);
ac.close();
}
@Configuration
static class LifeCycleConfig {
@Bean
public NetworkClient networkClient() {
NetworkClient networkClient = new NetworkClient();
networkClient.setUrl("http://hello-spring.dev");
return networkClient;
}
}
}간단하게 @PostConstruct, @PreDestroy 만 적용하면 편리하게 초기화와 소멸을 실행할 수 있습니다.
@PostConstruct, @PreDestroy 애노테이션 특징
최신 스프링에서 권장하는 방법입니다.
어노테이션 하나만 붙이면 되므로 매우 편리합니다.
패키지에
javax.annotation.PostConstruct이 있는데, 스프링에 종속적인 기술이 아니라 JSR-250이라는 자바 표준이라는 의미입니다. 따라서 스프링이 아닌 다른 컨테이너에서도 잘 동작합니다.컴포넌트 스캔과 잘 어울립니다.
유일한 단점은 라이브러리에는 적용하지 못합니다. 따라서 외부 라이브러리를 초기화, 소멸 시에는 앞에서 활용한
@Bean의 기능을 사용하면 됩니다.
정리하자면, @PostConstruct, @PreDestroy 어노테이션을 사용하고, 코드를 고칠 수 없는 외부 라이브러리를 초기화, 소멸해야할 경우에는 @Bean의 initMethod, destroyMethod를 사용하면 됩니다.
참고 자료
Last updated