티스토리 뷰
[SpringBoot] 스프링 핵심 원리 섹션 8 | 빈 생명주기 콜백 | 스프링 인터페이스 | 애노테이션 @PostConstruct @PreDestroy
YouJungJang 2024. 1. 2. 17:44본 포스팅은 인프런 김영한 강사님의 스프링 부트 핵심 원리 강의 섹션 8을 수강하고 배운 점을 정리했습니다.
스프링 핵심 원리 - 기본편 강의 - 인프런
스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., 스프링 핵심 원리를 이해하고, 성장하는 백엔드 개발자가 되어보세요! 📢
www.inflearn.com
1. 스프링 빈의 초기화 시점
데이터베이스 커넥션 풀이나, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고, 애플리케이션
종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화와 종료 작업이 필요하다. 스프링에서 이러한 초기화 작업과 종료 작업을 어떻게 진행하는 걸까?
외부 네트워크에 연결하는 객체를 생성하는 예제로 알아보자
- 예제 코드 NetworkClient
package hello.core.lifecycle;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
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);
}
}
- 스프링 환경 설정과 테스트
package hello.core.lifecycle;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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이 존재하게 된다.
스프링 빈은 객체를 생성하고, 의존 관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있다.
따라서 초기화 작업은 의존 관계 주입이 모두 완료되고 난 다음에 호출 돼야 한다.
❓그럼 개발자가 의존 관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까?
✅ 스프링이 초기화 시점을 알려주는 방법 = 콜백 매서드
스프링은 의존 관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려준다.
또한 안전하게 종료하도록 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다.
✅스프링 빈의 이벤트 Life Cycle
스프링 컨테이너 생성 ➡️ 스프링 빈 생성 ➡️ 의존관계 주입 ➡️ 초기화 콜백 ➡️ 사용 ➡️ 소멸 전 콜백 ➡️ 스프링 종료
✅ 객체의 생성과 초기화를 분리하자.
생성자: 필수 정보를 받고, 메모리를 할당해서 객체를 생성하는 책임
초기화: 이렇게 생성된 값들을 활용해서 외부 커넥션을 연결하는 등 무거운 동작 수행
➡️ 따라서 생성자 안에서 무거운 초기화 작업을 함께하기보다는 객체 생성과 초기화 부분을 명확히 나누는 것이 유지 보수 관점에서 좋다.
✅ 스프링이 지원하는 빈 생명주기 콜백 3가지
1️⃣ 인터페이스(InitializingBean, DisposableBean)2️⃣ 설정 정보에 초기화 메서드, 종료 메서드 지정3️⃣ @PostConstruct, @PreDestroy 애노테이션 지원밑에서 각각 자세히 알아보자
2. 빈 생명주기 콜백1️⃣: 인터페이스(InitializingBean, DisposableBean)
예제 코드 NetworkClient: 인터페이스 오버라이드 추가
package hello.core.lifecycle;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
public class NetworkClient implements InitializingBean, DisposableBean {
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);
}
// 인터페이스 오버라이드
@Override
public void destroy() throws Exception {
disConnect();
}
@Override
public void afterPropertiesSet() throws Exception {
connect();
call("초기화 연결 메시지");
}
}기존 NetworkClient가 InitializingBean, DisposableBean 두 인터페이스를 오버라이드 하도록 추가한다.
✅ InitializingBean: afterPropertiesSet() 메서드로 초기화를 지원한다.
✅ DisposableBean: destroy() 메서드로 소멸을 지원한다.
출력 결과
출력 결과 초기화 메서드 주입 완료 후에 적절하게 호출된 것을 확인할 수 있다.
또한 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 적절히 호출된 것도 확인할 수 있다.
✅인터페이스 사용의 단점
- 초기화, 소멸 메서드의 이름을 변경할 수 없다.
- 이 인터페이스는 스프링 전용 인터페이스다. 해당 코드가 스프링 전용 인터페이스에 의존한다.
- 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.
3. 빈 생명주기 콜백2️⃣ : 빈 등록 초기화, 소멸 메서드 지정
설정 정보에 @Bean(initMethod = "init", destroyMethod = "close")처럼 초기화, 소멸 메서드를 지정할 수 있다.
예제 코드 NetworkClient: 인터페이스 삭제 후 생성자, 소멸자 이름 변경
package hello.core.lifecycle;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
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 void init() {
System.out.println("NetworkClient.init");
connect();
call("초기화 연결 메시지");
}
public void close() {
System.out.println("NetworkClient.close");
disConnect();
}
}1에서 생성한 인터페이스 오버라이드를 삭제하고 생성자, 소멸자를 각각 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, destroyMethod 설정 정보를 각각 위에서 추가한 생성자와 소멸자로 지정해 준다.
테스트 결과
생성자와 소멸자에 적어둔 콘솔 출력문이 올바르게 출력된 모습
✅설정 정보 사용 특징
- 메서드 이름을 자유롭게 줄 수 있다.
- 스프링 빈이 스프링 코드에 의존하지 않는다.
- 코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적
용할 수 있다.
✅ 종료 메서드 추론: @Bean의 destroyMethod 속성
- 이 추론 기능은 close , shutdown라는 이름의 종료 메서드를 추론해서 자동으로 호출해 준다. - 기본값이 (inferred) (추론)으로 등록되어 있다. 따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다.- 추론 기능을 사용하기 싫으면 destroyMethod=""처럼 빈 공백을 지정하면 된다.
4. 빈 생명주기 콜백3️⃣: 애노테이션 @PostConstruct, @PreDestroy
예제 코드 NetworkClient: 생성자, 소멸자에 각각 @PostConstruct, @PreDestroy 애노테이션 추가
package hello.core.lifecycle;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
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);
}
@PostConstruct
public void init() {
System.out.println("NetworkClient.init");
connect();
call("초기화 연결 메시지");
}
@PreDestroy
public void close() {
System.out.println("NetworkClient.close");
disConnect();
}
}
설정 정보에 초기화 소멸 메서드 삭제
@Configuration
static class LifeCycleConfig{
@Bean
public NetworkClient networkClient(){
NetworkClient networkClient = new NetworkClient();
networkClient.setUrl("http://hello-spring.dev");
return networkClient;
}
}
테스트 결과는 2번과 같다.
➡️@PostConstruct , @PreDestroy 이 두 애노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다.
✅@PostConstruct, @PreDestroy 애노테이션 특징
- 애노테이션 하나만 붙이면 돼서 매우 편리하므로 최신 스프링에서 가장 권장하는 방법이다.
- 패키지를 잘 보면 javax.annotation.PostConstruct이다. 스프링에 종속적인 기술이 아니라 JSR-250라는 자바 표준이다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작한다.
- 컴포넌트 스캔과 잘 어울린다.
- 유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다. 외부 라이브러리를 초기화, 종료해야 하면 @Bean의 기능을 사용하자.