빈 생명주기 콜백
데이터베이스 커넥션 풀이나, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고,
애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화와 종료 작업이 필요하다.
그밖에 테스트 케이스 작성 시 테스트 픽스처 준비를 하는 경우에도 초기화 및 종료 작업을 해야 한다.
이번 포스팅에서는 NetworkClient 예제 클래스를 만들어보며 알아보자.
NetworkClient
public class NetworkClient {
private String url;
public NetworkClient() {
System.out.println("생성자 호출 , url=" + url);
connect();
call("초기화 연결 메세지");
}
public void call(String msg) {
System.out.println("call= " + url + " message= " + msg);
}
public void connect() {
System.out.println("connect= " + url);
}
public void disconnect() {
System.out.println("close= " + url);
}
public void setUrl(String url) {
this.url = url;
}
}BeanLifeCycleTest
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 = null
connect: null
call: null message = 초기화 연결 메시지실행 결과를 보면 url이 모두 null이다.
당연히 객체 생성 시점에서는 url이 입력되지 않았고 생성 완료 후 setter를 통해 url을 넣었기 때문이다.
스프링 빈은 객체를 생성 후 의존관계를 주입한 뒤 사용할 준비가 완료된다.
내가 해당 빈에서 초기화 작업들을 해주고 싶다면 이런 의존관계가 모두 주입된 다음 호출해야 한다. 개발자 입장에서 의존관계가 모두 주입이 완료되는 시점을 알기 위해서 스프링에서는 스프링 빈이 의존관계 주입이 완료되면 콜백 메서드를 통해 초기화 시점을 알려주는 기능을 제공한다. 더하여 스프링 컨테이너의 소멸 직전 소멸 콜백을 주어서 스프링 컨테이너가 종료되기 전 로직을 수행할 수 있다. (ex: DB와의 연결 종료)
스프링 빈의 이벤트 라이프사이클
스프링 컨테이너 생성 👉 스프링 빈 생성 👉 의존관계 주입 👉 초기화 콜백 👉 사용
👉 소멸전 콜백 👉 스프링 종료
초기화 콜백: 빈이 생성되고, 빈의 의존관계 주입이 완료된 후 호출소멸전 콜백: 빈이 소멸되기 직전 호출
❗ 객체의 생성과 초기화를 분리하자.
- 생성자는 필수 정보를 받아 메모리 할당 후 객체를 생성하는 책임을 가진다.
그리고 초기화는 이렇게 생성된 값들을 활용해 기타 무거운 작업들을 수행한다. 그렇기에 생성과 초기화를 묶는 것은 SRP(단일 책임 원칙) 적으로도 과한 책임을 가지게 되기에 두 부분을 나누는 것이 유지 보수 관점 및 객체지향 프로그램 적으로도 좋다.
❗ 싱글톤 빈들은 스프링 컨테이너가 종료될 때 같이 종료되기에 소멸전 콜백이 스프링 컨테이너 종료 직전 호출되지만, 생명주기가 더 짧은 빈들도 있는데 이 빈들은 컨테이너와 무관하게 소멸전 콜백이 일어난다.
❓ 그럼 스프링은 빈 생명주기 콜백을 어떻게 관리하는가?
- 인터페이스(
InitializingBean,DisposableBean) - 설정 정보에 초기화 메서드, 종료 메서드 지정(어노테이션 속성 설정)
@PostConstructor,@PreDestroy어노테이션 사용
인터페이스 InitializingBean, DisposableBean
InitializingBean, DisposableBean 인터페이스를 가져와 사용해 보자.
public class NetworkClient implements InitializingBean, DisposableBean {
private String url;
public NetworkClient() {
System.out.println("생성자 호출 , url=" + url);
connect();
call("초기화 연결 메세지");
}
public void call(String msg) {
System.out.println("call= " + url + " message= " + msg);
}
public void connect() {
System.out.println("connect= " + url);
}
public void disconnect() {
System.out.println("close= " + url);
}
public void setUrl(String url) {
this.url = url;
}
@Override
public void afterPropertiesSet() throws Exception {
connect();
call("초기화 연결 메세지");
}
@Override
public void destroy() throws Exception {
disconnect();
}
}실행 결과
생성자 호출, url = null
connect: null
call= null message = 초기화 연결 메세지
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
23:24:49.043 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext -
close= http://hello-spring.devInitializingBean은 afterPropertiesSet() 메서드로 초기화를 지원한다.DisposableBean은 destroy() 메서드로 소멸을 지원한다.
- 초기화가 메서드 의존관계 주입 완료 이후 호출되었기에 Null이 아닌 제대로 된 url이 출력된다.
- 스프링 컨테이너가 종료되는 시점에서 disconnect도 호출되는 것을 확인할 수 있다.
해당 인터페이스 두 개를 구현하면서 두 메서드만 오버라이딩해서 구현하면 되니 편하지만,
이 인터페이스는 스프링 전용 인터페이스이기 때문에 해당 인터페이스에 의존하게 된다.
✅ 그리고 두 인터페이스에서 제공하는 메서드 오버라이딩이기 때문에 이름을 변경할 수 없고
외부 라이브러리에는 적용할 수도 없다.
빈 등록 초기화, 소멸 메서드
- 스프링 빈 등록 어노테이션
@Bean에 속성으로 초기화, 소멸 메서드를 지정할 수 있다.
✅ @Bean(initMethod = "초기화 메서드명", destroyMethod="소멸 메서드명")public class NetworkClient{
...
public void init() {
System.out.println("NetworkClient.init");
connect();
call("초기화 연결 메세지");
}
public void close() {
System.out.println("NetworkClient.close");
disconnect();
}
}👉 초기화 메서드 init과 소멸 메서드 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으로 등록되는 부분에 속성으로 initMethod속성에 init 소멸 메서드명으로 close를 설정
실행 결과
생성자 호출, url = null
connect: null
call= null message = 초기화 연결 메세지
NetworkClient.init
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
23:26:40.013 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext -
close= http://hello-spring.dev인터페이스를 사용하는 것과는 다르게 이름도 init, close로 개발자가 임의로 지정할 수 있고, 스프링 빈이 스프링 코드(인터페이스)에 의존하지 않는다. 그리고 코드가 아닌 설정 정보를 이용하기 때문에 외부 라이브러리를 사용할지라도 적용이 가능하다.
종료 메서드 추론
@Bean 어노테이션의 소멸 메서드를 지정하는 속성인 destroyMethod에는 추론 기능이 있다.
관례적으로 대부분 라이브러리에서는 close, shutdown 이라는 이름으로 소멸 메서드를 사용하기 때문에, @Bean의 destroyMethod는 default 값으로 (inferred)(추론)으로 등록되어 있는데, 이 기능은 close, shutdown이라는 이름의 메서드를 자동으로 호출해 준다.
즉, 내가 스프링 빈을 등록할 때 종료 메서드를 해당 관례를 따르는 close나 shutdown으로 지정한다면 따로 속성에 destroyMethod에 지정해 주지 않아도, 자동으로 찾아서 동작한다.
만약, 추론 기능을 사용하기 싫을 경우 공백("")을 지정하면 된다.
💡 어노테이션 @PostConstruct, @PreDestroy
✅ 가장 편하고 최신 스프링에서 권장하는 방법.
✅ @PostConstruct, @PreDestroy 이 두 어노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다.
public class NetworkClient{
...
@PostConstruct
public void init() {
System.out.println("NetworkClient.init");
connect();
call("초기화 연결 메세지");
}
@PreDestroy
public void close() {
System.out.println("NetworkClient.close");
disconnect();
}
}-
어노테이션 하나만 붙이면 되기에 상당히 편하다.
-
해당 어노테이션의 import 패키지를 보면
javax.annotation.PostConstruct이다.
즉, 스프링에 종속적인 기술이 아닌 JSR-250 자바 표준이다. -
컴포넌트 스캔과 잘 어울린다.
- 코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료해야 하면
@Bean의initMethod,destroyMethod를 사용하자.
