이번 섹션에서는 [빈 생명주기 콜백]에 대해서 알아보자.
목차는 다음과 같다.
1) 빈 생명주기 콜백 시작
2) 인터페이스 InitializingBean, DisposableBean
3) 빈 등록 초기화, 소멸 메서드
4) 애노테이션 @PostConstruct, @PreDestroy
1) 빈 생명주기 콜백 시작
데이터베이스 커넥션 풀이나, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고, 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화와 종료 작업이 필요하다.
따라서 이번 내용에서는 스프링을 통해 이러한 초기화 작업과 종료 작업을 어떻게 진행하는지 예제로 알아보자.
간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정해보자. 실제로 네트워크에 연결하는 것은 아니고, 단순히 문자만 출력하도록 했다. 이 NetworkClient 는 애플리케이션 시작 시점에 connect() 를 호출해서 연결을 맺어두어야 하고, 애플리케이션이 종료되면 disconnect() 를 호출해서 연결을 끊어야 한다.
👉 예제 코드로 만들어보자.
- test > java > hello > core > lifyCycle 패키지를 생성하고 그 내부에 NetworkClient 클래스를 생성하자.
- 테스트를 위해 BeanLifeCycleTest 클래스를 생성 후 실행해보자.
- 실행해보면 위와 같은 결과가 나온다.
- 생성자 부분을 보면 url 정보 없이 connect가 호출되는 것을 확인할 수 있다. 너무 당연한 이야기이지만 객체를 생성하는 단계에는 url이 없고, 객체를 생성한 다음에 외부에서 수정자 주입을 통해서
setUrl()이 호출되어야 url이 존재하게 된다.
스프링 빈은 간단하게 다음과 같은 라이프사이클을 가진다.
- 객체 생성 -> 의존관계 주입
: (객체를 생성한 다음에 의존관계를 주입한다. 물론 여기서 "생성자 주입"은 예외이다. 생성자 주입은 객체를 생성할 때 스프링 빈이 파라미터로 같이 들어와야 하기 때문에 예외이고, 나머지 수정자 주입이나 필드 주입 등은 객체 생성이 다 끝나고 그 다음 의존관계 주입이 일어난다.)- 스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료된다. 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다. 그런데 개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까?
: 스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공한다. 또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다. (빈이 종료되기 직전에 소멸 콜백을 받을 수 있음.) 따라서 안전하게 종료 작업을 진행할 수 있다.
- 스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료된다. 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다. 그런데 개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까?
스프링 빈의 이벤트 라이프사이클 (참고. 싱글톤에 대한 예시이다.)
: 스프링 컨테이너 생성 -> 스프링 빈 생성 -> 의존관계 주입(setter 주입, 필드 주입) -> 초기화 콜백 -> 사용 -> 소멸전 콜백 -> 스프링 종료
- 초기화 콜백: 빈이 생성되고, 빈의 의존관계 주입이 완료된 후 호출
- 소멸전 콜백: 빈이 소멸되기 직전에 호출
✔️ 참고
-
객체의 생성과 초기화를 분리하자.
(객체의 생성은 객체 생성에 필요한 필수값들만 정의해서 객체가 생성되는데에만 집중하고(=메모리 할당에 초점), 이후 객체가 기능을 하기위해 동작하기 위한 초기화 작업은 별도로 분리하자. (단일 책임의 관점))- 생성자는 필수 정보(파라미터)를 받고, 메모리를 할당해서 객체를 생성하는 책임을 가진다. 반면에 초기화는 이렇게 생성된 값들을 활용해서 외부 커넥션을 연결하는등 무거운 동작을 수행한다. 따라서 생성자 안에서 무거운 초기화 작업을 함께 하는 것 보다는 객체를 생성하는 부분과 초기화하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋다. 물론 초기화 작업이 내부 값들만 약간 변경하는 정도로 단순한 경우에는 생성자에서 한번에 다 처리하는게 더 나을 수 있다.
-
싱글톤 빈들은 스프링 컨테이너가 종료될 때 싱글톤 빈들도 함께 종료되기 때문에 스프링 컨테이너가 종료되기 직전에 소멸전 콜백이 일어난다. 뒤에서 설명하겠지만 싱글톤 처럼 컨테이너의 시작과 종료까지 생존하는 빈도 있지만, 생명주기가 짧은 빈들도 있는데 이 빈들은 컨테이너와 무관하게 해당 빈이 종료되기 직전에 소멸전 콜백이 일어난다. 자세한 내용은 스코프에서 알아보겠다.
👉 스프링은 크게 3가지 방법으로 빈 생명주기 콜백을 지원한다.
- 인터페이스(InitializingBean, DisposableBean)
- 설정 정보에 초기화 메서드, 종료 메서드 지정
- @PostConstruct, @PreDestroy 애노테이션 지원
하나씩 알아보자.
2) 인터페이스 InitializingBean, DisposableBean
: 인터페이스로 초기화와 소멸전 콜백을 받는 방법.
👉 코드로 확인해보자.
- 위에서 생성했던 NetworkClient 클래스에 InitializingBean과 DisposableBean 인터페이스를 구현하자.
InitializingBean은 afterPropertiesSet() 메서드로 초기화를 지원한다.DisposableBean은 destroy() 메서드로 소멸을 지원한다.
- BeanLifeCycleTest 클래스의 lifeCycleTest 테스트를 다시 실행해보자.
- 생성자 호출 단계에서는 당연히 url 정보는 없게 출력된다. 그리고 빈 생성이 끝나고 의존관계 주입이 끝난 다음 afterPropertiesSet가 호출되면서 connect와 call이 호출된다. 그다음 스프링 컨테이너가 내려가서 종료되기 전에 destroy가 호출되며 disconnect가 호출된다.
- (참고) 출력 결과를 보면 초기화 메서드가 주입 완료 후에 적절하게 호출된 것을 확인할 수 있다.
- (참고) 그리고 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출된 것도 확인할 수 있다.
✔️ 초기화, 소멸 인터페이스 단점
- 이 인터페이스는 스프링 전용 인터페이스다. 해당 코드가 스프링 전용 인터페이스에 의존한다.
- 초기화, 소멸 메서드의 이름을 변경할 수 없다.
- 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.
✔️ 참고
- 인터페이스를 사용하는 초기화, 종료 방법은 스프링 초창기에 나온 방법들이고, 지금은 다음의 더 나은 방법들이 있어서 거의 사용하지 않는다.
3) 빈 등록 초기화, 소멸 메서드
: 설정 정보에 @Bean(initMethod = "init", destroyMethod = "close") 처럼 초기화, 소멸 메서드를 지정할 수 있다.
👉 설정 정보를 사용하도록 변경해보자.
- NetworkClient 클래스의 코드를 아래와 같이 변경해보자. (이전에 했던 InitializingBean, DisposableBean 인터페이스도 제거하자.)
- 설정 정보에 초기화, 소멸 메소드를 지정하고 실행해보자.
- 정상적으로 출력된 것을 볼 수 있다.
✔️ 설정 정보 사용 특징
- 메서드 이름을 자유롭게 줄 수 있다.
- 스프링 빈이 스프링 코드에 의존하지 않는다.
- 코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다. (은근 외부라이브러리 중에 초기화, 종료 메서드를 호출해줘야하는게 있다.)
✔️ 종료 메서드 추론
@Bean의 destroyMethod속성에는 아주 특별한 기능이 있다.- 라이브러리는 대부분
close,shutdown이라는 이름의 종료 메서드를 사용한다. - @Bean의
destroyMethod는 기본값이(inferred)(추론)으로 등록되어 있다. - 이 추론 기능은
close,shutdown라는 이름의 메서드를 자동으로 호출해준다. 이름 그대로 종료 메서드를 추론해서 호출해준다. - 따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다.
- 추론 기능을 사용하기 싫으면
destroyMethod=""처럼 빈 공백을 지정하면 된다.
4) 애노테이션 @PostConstruct, @PreDestroy
👉 코드로 확인해보자.
- NetworkClient 클래스에 @PostConstruct, @PreDestroy를 적용해주자.
- BeanLifeCycleTest 클래스에서 이전에 작성했던 초기화(initMethod), 소멸메서드(destroyMethod) 속성을 제거한 후 실행해보자.
- 정상적으로 출력된 것을 볼 수 있다.
@PostConstruct,@PreDestroy이 두 애노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다.
✔️ @PostConstruct, @PreDestroy 애노테이션 특징
- 최신 스프링에서 가장 권장하는 방법이다.
- 애노테이션 하나만 붙이면 되므로 매우 편리하다.
- 패키지를 잘 보면
javax.annotation.PostConstruct이다. 스프링에 종속적인 기술이 아니라 JSR-250 라는 자바 표준이다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작한다. - 컴포넌트 스캔과 잘 어울린다.
- 유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다. 외부 라이브러리를 초기화, 종료해야 하면
@Bean의 기능을 사용하자.
✔️ 정리
- @PostConstruct, @PreDestroy 애노테이션을 사용하자.
- 코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료해야 하면
@Bean의initMethod,destroyMethod를 사용하자.
강의를 듣고 정리한 글입니다. 코드와 그림 등의 출처는 김영한 강사님께 있습니다.
