빈 생명 주기 콜백 (InitializingBean, DisposableBean, @Bean, @PostConstruct, @PreDestroy)
의존 관계 자동 주입 - 2 (@Autowired, @Qualifier, @Primary, 어노테이션 생성, 자동-수동 주입의 기준)
의존 관계 자동 주입 - 2 (@Autowired, @Qualifier, @Primary, 어노테이션 생성, 자동-수동 주입의 기준)
의존관계 자동 주입 - 1 (의존관계 주입 방법들, 생성자 주입 사용 이유, lombok 설정 + 적용) 의존관계 자동 주입 - 1 (의존관계 주입 방법들, 생성자 주입 사용 이유, lombok 설정 + 적용) 컴포넌트 스
soohykeee.tistory.com
빈 생명주기 콜백 시작
데이터베이스 커넥션 풀이나, 네트워크 소켓처럼 애플리케이션 시작 지점에 필요한 연결을 미리 하고, 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하기 위해서는 객체의 초기화와 종료 작업이 필요하다. 그렇기에 이번 예제에서는 스프링을 통해 초기화 작업, 종료 작업을 어떻게 하는지 알아볼것이다.
예를 들어, 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 해보자. (실제로 네트워크에 연결하는 것은 아니고, 간단한 예제를 해보는 것이다.) 해당 객체를 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 {
@Configuration
static class LifeCycleConfig {
@Bean
public NetworkClient networkClient () {
NetworkClient networkClient = new NetworkClient();
networkClient.setUrl("http://hello-spring.dev");
return networkClient;
}
}
@Test
public void lifeCycleTest() {
ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
NetworkClient client = ac.getBean(NetworkClient.class);
ac.close();
}
}
위 처럼 테스트 코드를 작성 후, 실행해보면 생성자 부분에서 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 destroy() throws Exception {
disconnect();
}
@Override
public void afterPropertiesSet() throws Exception {
connect();
call("초기화 연결 메시지");
}
}
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 {
@Configuration
static class LifeCycleConfig {
@Bean(initMethod = "init", destroyMethod = "close")
public NetworkClient networkClient() {
NetworkClient networkClient = new NetworkClient();
networkClient.setUrl("http://hello-spring.dev");
return networkClient;
}
}
@Test
public void lifeCycleTest() {
ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
NetworkClient client = ac.getBean(NetworkClient.class);
ac.close();
}
}
위 처럼 작성해도 결과가 동일하게 나오는 것을 확인할 수 있다.
설정 정보 사용 특징은 다음과 같다.
- 메서드 이름을 자유롭게 정할 수 있다.
- 스프링 빈이 스프링 코드에 의존하지 않는다.
- 코드가 아니라 설정 정보를 사용하기에, 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드 적용이 가능
종료 메서드 추론
@Bean 어노테이션의 destroyMethod 속성에는 특별한 기능들이 존재한다. 대부분의 라이브러리들은 close, shutdown과 같은 이름으로 종료 메서드를 사용한다. 그렇기에 @Bean의 destroyMethod는 기본값이 inferred (추론)으로 등록되어 있다. 해당 추론 기능은 close, shutdown 이라는 이름의 메서드를 자동으로 호출해준다. 말 그대로 종료 메서드를 추론해서 호출해주는 기능이다. 따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다. 해당 기능을 사용하기 싫다면 destroyMethod = "" 처럼 빈 공백을 지정하면 된다.
어노테이션 @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() {
System.out.println("NetworkClient.init");
connect();
call("초기화 연결 메시지");
}
@PreDestroy
public void close() {
System.out.println("NetworkClient.close");
disconnect();
}
}
public class BeanLifeCycleTest {
@Configuration
static class LifeCycleConfig {
@Bean
public NetworkClient networkClient() {
NetworkClient networkClient = new NetworkClient();
networkClient.setUrl("http://hello-spring.dev");
return networkClient;
}
}
@Test
public void lifeCycleTest() {
ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
NetworkClient client = ac.getBean(NetworkClient.class);
ac.close();
}
}
해당 기능인 @PostConstruct, @PreDestroy 어노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다.
@PostConstruct, @PreDestroy 특징
- 스프링에서 가장 권장하는 방법이다.
- 어노테이션만 붙이면 동작하므로, 매우 편리하다.
- 패키지를 확인해보게 되면, javax.annotation.PostContruct이다. 스프링에 종속적인 기술이 아니라, JSR-250이라는 자바 표준이다. 그렇기에 스프링이 아닌 다른 컨테이너에서도 동작한다.
- 컴포넌트 스캔과 잘 어울린다.
- 단점이 있다면, 외부 라이브러리에 적용하지 못한다. 만약 외부 라이브러리에 적용하려면 앞서 봤던 @Bean의 기능을 사용해야 한다.
정리
- @PostConstruct, @PreDestroy 애노테이션을 사용을 권장
- 코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료해야 하면 @Bean 의 initMethod , destroyMethod 를 사용.