[작성일: 2023. 08. 15]
빈 생명주기 콜백 시작
데이터베이스 커넥션 풀이나 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고, 애플리케이션 종료 시점에 연결을 모두 종료하는 직업을 진행하려면 객체의 초기화와 종료 작업이 필요하다.
간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정해보자. 이 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이 존재하게 된다.
스프링 빈은 다음과 같은 라이프 사이클을 가진다.
객체 생성 ➡️ 의존관계 주입
스프링 빈은 객체를 생성하고 의존관계 주입이 끝나야 필요한 데이터를 사용할 수 있는 준비가 완료된다. 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다.
스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해 초기화 시점을 알려주는 다양한 기능을 제공한다. 또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 주기 때문에 안전하게 종료 작업을 진행할 수 있다.
스프링 빈의 이벤트 라이프 사이클은 다음과 같다.
스프링 컨테이너 생성 ➡️ 스프링 빈 생성 ➡️ 의존관계 주입 ➡️ 초기화 콜백 ➡️ 사용 ➡️ 소멸 전 콜백 ➡️ 스프링 종료
초기화 콜백은 빈이 생성되고 빈의 의존관계 주입이 완료된 후 호출되고 소멸전 콜백은 빈이 소멸되기 직전에 호출된다.
인터페이스(InitializingBean, DisposableBean)
public class NetworkClient implements InitializingBean, DisposableBean {
private String url;
// ... 생략
@Override
public void afterPropertiesSet() throws Exception {
connect();
call("초기화 연결 메시지");
}
@Override
public void destroy() throws Exception {
disConnect();
}
}
초기화, 소멸 인터페이스에는 단점이 있다. 이 인터페이스는 스프링 전용 인터페이스로 해당 코드가 스프링 전용 인터페이스에 의존한다. 초기화, 소멸 메서드의 이름을 변경할 수도 없다. 또한 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수도 없다.
인터페이스를 사용하는 초기화, 종료 방법은 스프링 초창기에 나온 방법들이고 지금은 다른 방법들이 있어서 거의 사용하지 않는다.
빈 등록 초기화, 소멸 메서드 지정
설정 정보에 @Bean(initMethod = "init", destroyMethod = "close")처럼 초기화, 소멸 메서드를 지정할 수 있다.
@Configuration
static class LifeCycleConfig {
@Bean(initMethod = "init", destroyMethod = "close")
public NetworkClient networkClient() {
// ... 생략
}
}
메서드의 이름을 자유롭게 줄 수 있으며 스프링 빈이 스프링 코드에 의존하지 않는다. 코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다.
@Bean의 destroyMethod은 기본값이 (inferred): 추론으로 등록되어 있다. 이 추론 기능은 close, shutdown이라는 이름의 메서드를 자동으로 호출해준다. 이름 그대로 종료 메서드를 추론해서 호출해준다.
따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 작동한다. 추론 기능을 사용하기 싫을 경우에는 destroyMethod=""처럼 빈 공백을 지정하면 된다.
애노테이션(@PostConstruct, @PreDestroy)
public class NetworkClient {
private String url;
// ... 생략
@PostConstruct
public void init() {
System.out.println("NetworkClient.init");
connect();
call("초기화 연결 메시지");
}
@PreDestroy
public void close() {
System.out.println("NetworkClient.close");
disConnect();
}
}
애노테이션 사용 방식은 매우 편리하고 스프링에서 가장 권장하는 방법이다. 유일한 단점은 외부 라이브러리에 적용하지 못한다는 것이다. 외부 라이브러리를 초기화, 종료해야 한다면 @Bean의 initMethod, destroyMethod를 사용하면 된다.
🐣 출처: 인프런 김영한님 강의
이 글은 인프런의 김영한님 스프링 강의를 보고 작성한 글입니다.
강의를 들으면서 정리한 글이므로 틀린 내용이나 오타가 있을 수 있습니다.