빈 생명주기 콜백
데이터베이스 커넥션 풀이나 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고, 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면 객체의 초기화와 종료 작업이 필요하다.
간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정한다. 실제로 네트워크에 연결하진 않고 단순히 문자만 출력하도록 한다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
//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);
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
//BeanLifeCycleTest
public class BeanLifeCycleTest {
@Test
public void lifeCycleTest(){
AnnotationConfigApplicationContext 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 정보 없이 (setUrl 호출 전에) connect가 먼저 호출된다. 따라서 객체를 생성하는 단계에서는 url이 없고, 객체를 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl이 호출되어야 url이 존재하게 된다. 따라서 위의 코드는 url = null 을 나타내게 된다.
스프링 빈은 간단히 다음과 같은 라이프사이클을 가지는데 위와 비슷한 면이 있다.
객체생성 -> 의존관계 주입
스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료된다. 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다.
그런데 개발자가 이 의존관계 주입 완료 시점을 어떻게 알까?
스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공한다. 또 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다. 따라서 안전하게 종료 작업을 진행할 수 있다.
스프링 빈의 이벤트 라이프사이클
스프링 컨테이너 생성 -> 스프링 빈 생성 -> 의존관계 주입 -> 초기화 콜백 (의존관계 주입 끝 알림) -> 사용 -> 소멸 전 콜백 -> 스프링 종료
생성자에서 파라미터받고 바로 세팅 가능하지 않느냐?
객체의 생성 (new ~ )과 초기화(set)는 분리하는 것이 좋다.
생성자는 객체를 생성하는 책임을 가진다. 반면 초기화는 이렇게 생성된 값들을 활용해 외부 커넥션을 연결하는 등 무거운 동작을 수행한다.
따라서 생성자 안에서 무거운 초기화 작업을 함께 진행하는 것 보다 따로 분리를 해 주는 것이 유지보수 관점에서 좋다.
초기화 & 소멸 전 콜백 받는 법
인터페이스 InitializingBean, DisposableBean
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
//NetworkClient
public class NetworkClient implements InitializingBean, DisposableBean{
public NetworkClient(){
System.out.println("생성자 호출, url = " + url);
}
/* 나머지 함수 동일 */
@Override //의존관계 주입이 끝나면 호출
public void afterPropertiesSet() throws Exception {
connect();
call("초기화 연결 메시지");
}
@Override //소멸 전 콜백 호출
public void destroy() throws Exception {
disconnect();
}
이렇게 인터페이스를 상속받고 그 인터페이스에 있는 함수들인 afterPropertiesSet()은 의존관계 주입이 끝난 후 불러오는 함수, destroy()는 소멸 전 발동되어지는 함수를 정의할 수 있다.
따라서 위와 같이 의존관계 주입이 끝나고 connect()와 call을 호출하게 되는데 우리가 등록한 @Bean을 보면 생성자의 호출(new~)를 한 후 setUrl()을 하는데 생성자 호출 시점에는 url이 null이지만 의존관계를 주입할 때 setUrl이 적용되므로 주입이 끝나고 connect()와 call을 부르면 url이 set된 상태가 된다.
단점
- 이 인터페이스는 스프링 전용 인터페이스이다. 코드가 스프링 전용 인터페이스에 의존하게 된다.
- 초기화, 소멸 메서드의 이름을 변경할 수 없다.
- 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.
이러한 방법은 스프링 초창기에 나온 방법이고 지금은 더 나은 방법들이 있기 때문에 거의 사용하지 않는다.
빈 등록 초기화, 소멸 메서드
설정 정보에 @Bean(initMethod = “init”, destroyMethod = “close”) 처럼 초기화, 소멸 메서드를 지정할 수 있다.
1
2
3
4
5
6
7
8
9
10
11
//NetworkClient
//의존관계 주입이 끝나면 호출
public void init() throws Exception {
connect();
call("초기화 연결 메시지");
}
//소멸 전 콜백 호출
public void close() throws Exception {
disconnect();
}
이렇게 코드를 바꾸고 빈 등록시 @Bean(initMethod = “init”, destroyMethod = “close”)를 해주면 된다.
장점
- 메서드 이름을 자유롭게 설정 가능하다.
- 스프링 빈이 스프링 코드에 의존하지 않는다. (init, close 함수는 순수 자바)
- 코드가 아니라 설정 정보를 사용하기 문에 코드를 고칠 수 없는 외부 라이브러리에서도 초기화, 종료 메서드를 적용할 수 있다.
외부 라이브러리는 대부분 close, shutdown 이라는 이름의 종료 메서드를 사용한다. @Bean의 distroyMethod는 기본값이 “inferred”로 등록되어 있는데 이 뜻은 추론할 수 있다는 뜻이다. 따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다.
애노테이션 @PostConstruct, @PreDestroy
이 방법을 사용하는 것을 권장한다.
1
2
3
4
5
6
7
8
9
10
11
12
13
//NetworkClient
//의존관계 주입이 끝나면 호출
@PostConstruct
public void init() throws Exception {
connect();
call("초기화 연결 메시지");
}
//소멸 전 콜백 호출
@PreDestroy
public void close() throws Exception {
disconnect();
}
이 어노테이션 둘은 자바 표준이다. 스프링이 아닌 다른 컨테이너에도 동작한다.
컴포넌트 스캔과 잘 어울린다. 유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다.
외부 라이브러리를 초기화, 종료 해야 한다면 @Bean의 initMethod, destroyMethod를 사용하자.