[Spring] Spring 핵심 원리 : 빈 생명주기 콜백
빈 생명주기 콜백이란?
스프링 컨테이너는 애플리케이션 실행에 필요한 객체를 빈으로 등록하고 의존관계 주입을 한다. 이때, 빈이 생성, 의존관계 주입, 사용, 소멸되는 일련의 과정을 빈의 '생명주기'라고 한다. 그리고 콜백 또는 콜백함수란 다른 함수의 인자로 전달된 후, 조건에 따라 실행되는 함수이다. 여기서는 그냥 조건에 따라 실행되는 함수라고 이해하면 된다. 그래서 빈 생명주기 콜백이란 빈의 생성-소멸 과정에서 호출되는 메서드다.
데이터베이스의 커넥션 풀이나 네트워크 소켓은 애플리케이션 시작 시점에 미리 연결을 해두고, 애플리케이션 종료 시점에 연결을 종료한다. 이를 위해 객체의 초기화와 종료 작업이 필요하다. 초기화 콜백은 빈의 의존관계 주입이 끝난 후 초기화 작업을 수행하기 위해 호출되는 메서드이고, 소멸 콜백은 빈이 소멸되기 전에 종료 작업을 위해 호출되는 메서드이다. 여기서 초기화란 객체 생성과 의존관계 주입 이후 데이터를 사용할 준비가 되도록 만드는 것이다. 객체의 생성과는 구분되는 말이다.
정리하면 스프링 빈의 생명주기는 다음과 같다.
스프링 컨테이너 생성 → 스프링 빈 생성 → 의존관계 주입 → 초기화 콜백 → 사용 → 소멸 콜백 → 스프링 종료
예시를 위해 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정한다. 이 NetworkClient 객체는 애플리케이션 시작 지점에 connect()를 호출해서 연결을 맺어두어야 하고, 애플리케이션이 종료되면 disConnect()를 호출해서 연결을 끊어야 한다. 즉, connect()와 call() 메서드를 호출하는 것이 초기화 작업이고, 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
void lifeCycleTest() {
ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
NetworkClient networkClient = ac.getBean(NetworkClient.class);
ac.close(); // 스프링 컨테이너 종료
}
@Configuration
static class LifeCycleConfig {
@Bean
public NetworkClient networkClient() {
NetworkClient networkClient = new NetworkClient();
networkClient.setUrl("https://github.com/yjk490");
return networkClient;
}
}
}
/* 실행 결과
생성자 호출, url = null
connect: null
call : null, message : 초기화 연결 메세지
*/실행 결과의 생성자 호출 부분을 보면 url 정보 없이 connect()가 호출되는 것을 볼 수 있다. url 정보는 객체가 생성된 다음 setUrl()을 통해 주입받아야 하기 때문이다.
스프링 빈의 생명주기 콜백을 지원하는 방법은 다음 세 가지가 있다.
- 인터페이스 (InitializingBean, DisposableBean)
- @Bean 애노테이션의 속성 (initMethod, destroyMethod)
- 애노테이션 (@PostConstruct, @PreDestroy)
인터페이스 (InitializingBean, DisposableBean)
InitializingBean와 DisposableBean 인터페이스를 구현하고 각각의 메서드를 오버라이딩하면 콜백을 지원할 수 있다. afterPropertiesSet() 메서드로 초기화를, destroy() 메서드로 소멸을 지원한다.
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();
}
}
/* 실행 결과
생성자 호출, url = null
connect: https://github.com/yjk490
call : https://github.com/yjk490, message : 초기화 연결 메세지
22:43:31.396 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@c88a337, started on Sun Jul 23 22:43:31 KST 2023
close : https://github.com/yjk490
*/실행 결과를 보면 생성자가 호출되어 객체가 생성된 뒤, afterPropertiesSet() 메서드가 호출되고 컨테이너가 종료되기 전에 destroy() 메서드가 호출되는 것을 볼 수 있다.
이 방법은 코드가 스프링에 종속된다는 단점이 있다. InitializingBean, DisposableBean 인터페이스가 스프링 전용 인터페이스이기 때문이다. 그래서 외부 라이브러리와 같이 내가 코드를 수정할 수 없는 경우에 적용할 수 없다. 또한, 오버라이딩 해야 하기 때문에 메서드 이름을 변경할 수 없다.
@Bean 애노테이션의 속성 (initMethod, destroyMethod)
설정 정보에 수동 빈 등록할 때 @Bean 애노테이션의 옵션을 지정하면 콜백을 지원할 수 있다. 초기화와 소멸 메서드의 이름을 각각 initMethod, destroyMethod 속성에 지정하면 된다.
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() throws Exception {
connect();
call("초기화 연결 메세지");
}
// 빈 소멸 전 호출
public void close() throws Exception {
disconnect();
}
}
@Configuration
static class LifeCycleConfig {
@Bean(initMethod = "init", destroyMethod = "close")
public NetworkClient networkClient() {
NetworkClient networkClient = new NetworkClient();
networkClient.setUrl("https://github.com/yjk490");
return networkClient;
}
}이 방법은 스프링 빈으로 등록될 클래스가 스프링에 종속되지 않는다는 장점이 있다. 스프링 애노테이션이 적용되는 것은 설정 정보 클래스이기 때문이다. 설정 정보에 초기화, 소멸 메서드를 등록하기 때문에 코드를 수정할 수 없는 외부 라이브러리에도 적용할 수 있다.
destroyMethod 속성은 기본값으로 메서드명 추론 옵션이 지정되어 있다. 그래서 이 속성을 별도로 지정하지 않아도 스프링은 close나 shutdown 같은 이름의 메서드를 찾아 종료 메서드로 사용한다.
애노테이션 (@PostConstruct, @PreDestroy)
초기화와 소멸 작업을 수행하는 메서드에 각각 @PostConstruct, @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() {
connect();
call("초기화 연결 메세지");
}
// 빈 소멸 전 호출
@PreDestroy
public void close() {
disconnect();
}
}이 방법 또한 코드가 스프링에 종속되지 않는다는 장점이 있다. 두 애노테이션의 패키지 경로는 javax.annotation.PostConstruct이다. 즉, 애노테이션이 자바 표준에서 제공하는 애노테이션이기 때문에 스프링이 아닌 다른 컨테이너에서도 작동한다. 또한, 애노테이션 하나만 붙이면 되므로 매우 편리하다. 다만, 외부 라이브러리에는 적용할 수 없다는 단점이 있다. 그래서 기본적으로 이 애노테이션을 사용하고 외부 라이브러리에 생명주기 콜백을 사용하려면 @Bean의 속성을 사용한다.