8. 빈 생명주기 콜백 (-ing)

SPRING 핵심 원리 [ 기본편 ]

8. 빈 생명주기 콜백 (-ing)

wlalsu_u 2023. 6. 24. 10:06

8.1 빈 생명주기 콜백 시작

애플리케이션은 시작 시점에 필요한 연결을 미리 해두고, 종료 시점에 연결을 안전하게 종료하려면,

객체의 초기화와 종료 작업이 필요하다.

1) 데이터베이스 커넥션 풀

웹 어플리케이션과 데이터베이스는 서로 다른 시스템이므로, 데이터베이스 드라이버를 통해 데이터베이스에 연결

사용자로부터 요청이 올때마다 TCP 소켓을 열고 닫는 것은 시간이 오래 걸림

어플리케이션 서버와 DB를 미리 연결해 놓고, 필요할 때 재활용하여 사용

2) 네트워크 소켓

소켓을 미리 연결해 놓고, 사용자 요청이 들어오면 열러 있는 소켓을 이용하여 빠른 연결 가능

스프링을 통한 초기화와 종료 작업 예제는 다음과 같다.

서버가 뜨기 전에 외부 네트워크에 미리 연결을 해 놓고,

서버 종료 전에 미리 연결을 끊어야 하는 객체를 하나 생성한다고 가정해보자.

(실제로 네트워크에 연결하는 것은 아니고, 단순히 문자만 출력하도록 한다.)

NetworkClient 는 애플리케이션 시작 시점에 connect() 를 호출해서 연결을 맺어두고,

애플리케이션이 종료되면 disConnect() 를 호출해서 연결을 끊는다.

package hello.core.lifecycle;

public class NetworkClient {

 private String url; // 접속할 서버의 url
 public NetworkClient() {
 	System.out.println("생성자 호출, url = " + url);
 	connect();
 	call("초기화 연결 메시지");
 }
 
 // url은 외부에서 setter로 주입
 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.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); // 빈 조회
 	//스프링 컨테이너를 종료, ConfigurableApplicationContext 인터페이스필요
    // 기본 ApplicationContext가 지원하지 않음
    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 정보 없이 connect가 호출된다.

따라서 객체를 생성하는 단계에는 url이 없고,

객체를 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl() 이 호출되어야 url이 존재하게 된다.

스프링 빈의 라이프 사이클은 다음과 같다.
(예외. 생성자 주입의 경우 스프링 빈 생성시에 의존관계 주입이 일어남)

객체 생성 -> 의존관계 주입

스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료된다.

따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다.

그런데 개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까?

스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공한다.

또한 스프링은 스프링 컨테이너가 종료되기 직전(싱글톤의 경우)에 소멸 콜백을 준다.

따라서 안전하게 종료 작업을 진행할 수 있다.

[스프링 빈의 이벤트 라이프사이클]

스프링 컨테이너 생성 -> 스프링 빈 생성 -> 의존관계 주입(setter 주입, 필드 주입) -> 초기화 콜백 -> 사용 -> 소멸 전 콜백 -> 스프링 종료

초기화 콜백 : 빈이 생성되고, 빈의 의존관계 주입이 완료된 후 호출

소멸전 콜백 : 빈이 소멸되기 직전에 호출

[참고] 생성자 내에서 한번에 처리하는게 좋지 않을까?

객체의 생성과 초기화를 분리하자! (단일책임원칙)
생성자는 필수 정보(파라미터)를 받고, 메모리를 할당해서 객체를 생성하는 책임을 가진다.
반면에 초기화는 이렇게 생성된 값들을 활용해서 외부 커넥션을 연결하는등 무거운 동작을 수행한다.
따라서 생성자 안에서 무거운 초기화 작업을 함께 하는 것 보다는 객체를 생성하는 부분과 초기화 하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋다. 물론 초기화 작업이 내부 값들만 약간 변경하는 정도로 단순한 경우에는 생성자에서 한번에 다 처리하는게 더 나을 수 있다.

스프링은 크게 3가지 방법으로 빈 생명주기 콜백을 지원한다.

1) 인터페이스(InitializingBean, DisposableBean)

2) 설정 정보에 초기화 메서드, 종료 메서드 지정

3) @PostConstruct, @PreDestroy 애노테이션 지원

8.2 인터페이스 InitializingBean, DisposableBean

InitializingBean 은 afterPropertiesSet() 메서드로 초기화를 지원한다.

DisposableBean 은 destroy() 메서드로 소멸을 지원한다.

package hello.core.lifecycle;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;

// 초기화 빈과 종료 빈을 implements 해줌
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 afterPropertiesSet() throws Exception {
 	connect();
 	call("초기화 연결 메시지");
 }
 
 // 종료 시 호출
 @Override
 public void destroy() throws Exception {
 	disConnect();
 }
}

출력 결과

생성자 호출, url = null
NetworkClient.afterPropertiesSet
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing NetworkClient.destroy
close + http://hello-spring.dev

출력 결과를 보면 초기화 메서드가 주입 완료 후에 적절하게 호출 된 것을 확인할 수 있다.

그리고 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출 된 것도 확인할 수 있다

초기화, 소멸 인터페이스 단점

이 인터페이스는 스프링 전용 인터페이스이므로, 해당 코드가 스프링 전용 인터페이스에 의존한다.

따라서 초기화, 소멸 메서드의 이름을 변경할 수 없다.

내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.

[참고]
인터페이스를 사용하는 초기화, 종료 방법은 스프링 초창기에 나온 방법들이고,
지금은 다음의 더 나은 방법들이 있어서 거의 사용하지 않는다.

8.3 빈 등록 초기화, 소멸 메서드 지정

설정 정보에 @Bean(initMethod = "init", destroyMethod = "close") 를 작성하여

초기화, 소멸 메서드를 지정할 수 있다.

package hello.core.lifecycle;

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);
 }
 // method 이름 init으로 변경 
 public void init() {
 	System.out.println("NetworkClient.init");
 	connect();
 	call("초기화 연결 메시지");
 }
 
 public void close() {
 	System.out.println("NetworkClient.close");
 	disConnect();
 }
}

@Configuration
static class LifeCycleConfig {
// 설정 정보에 초기화 소멸 메서드 지정
 @Bean(initMethod = "init", destroyMethod = "close")
 public NetworkClient networkClient() {
 	NetworkClient networkClient = new NetworkClient();
 	networkClient.setUrl("http://hello-spring.dev");
 	return networkClient;
 }
}

실행 결과

생성자 호출, url = null
NetworkClient.init
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
13:33:10.029 [main] DEBUG
org.springframework.context.annotation.AnnotationConfigApplicationContext -
Closing NetworkClient.close
close + http://hello-spring.dev

설정 정보 사용 특징

1) 메서드 이름을 자유롭게 줄 수 있다.

2) 스프링 빈이 스프링 코드에 의존하지 않는다.

3) 코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다.

종료 메서드 추론

@Bean의 destroyMethod 속성에는 아주 특별한 기능이 있다.

외부 라이브러리는 대부분 close , shutdown 이라는 이름의 종료 메서드를 사용한다.

@Bean의 destroyMethod 는 기본값이 (inferred) (추론)으로 등록되어 있다.

이 추론 기능은 close , shutdown 라는 이름의 메서드를 자동으로 호출해준다.

즉 종료 메서드를 추론해서 호출해준다.

따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다.

추론 기능을 사용하지 않으려면 destroyMethod="" 처럼 빈 공백을 지정하면 된다. (버그 만들고 싶으면 ^__^)

8.4 애노테이션 @PostConstruct, @PreDestroy

@PostConstruct , @PreDestroy 애노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다.

(가장 권장하는 방법)

package hello.core.lifecycle;
import javax.annotation.PostConstruct;
import javax.annotation.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();
 	}
}

@Configuration
static class LifeCycleConfig {
 	@Bean
 	public NetworkClient networkClient() {
 		NetworkClient networkClient = new NetworkClient();
 		networkClient.setUrl("http://hello-spring.dev");
 		return networkClient;
	}
}

실행 결과

생성자 호출, url = null
NetworkClient.init
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
19:40:50.269 [main] DEBUG
org.springframework.context.annotation.AnnotationConfigApplicationContext -
Closing NetworkClient.close
close + http://hello-spring.dev

@PostConstruct, @PreDestroy 애노테이션 특징

1) 최신 스프링에서 가장 권장하는 방법이다.

2) 애노테이션 하나만 붙이면 되므로 매우 편리하다.

3) 패키지를 잘 보면 javax.annotation.PostConstruct 이다.

(스프링에 종속적인 기술이 아니라 JSR-250 라는 자바 표준)

따라서 스프링이 아닌 다른 컨테이너에서도 동작한다.

4) 컴포넌트 스캔과 잘 어울린다.

5) 유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다.

외부 라이브러리를 초기화, 종료 해야 하면 @Bean의 기능을 사용하자.

[정리]

@PostConstruct, @PreDestroy 애노테이션을 사용하자
코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료해야 하면 @Bean 의 initMethod , destroyMethod 를 사용하자

'SPRING 핵심 원리 [ 기본편 ]' 카테고리의 다른 글

9. 빈 스코프 (-ing) (0)	2023.06.24
[스프링 핵심 원리] 섹션 3.9 객체 지향 원리 적용 (스프링으로 전환하기) (0)	2023.01.31
[스프링 핵심 원리] 섹션 3.8 객체 지향 원리 적용 (IoC, DI, 그리고 컨테이너) (0)	2023.01.31
[스프링 핵심 원리] 섹션 3.7 객체 지향 원리 적용 (좋은 객체 지향 설계의 5가지 원칙의 적용) (0)	2023.01.31
[스프링 핵심 원리] 섹션 3.5 객체 지향 원리 적용 (새로운 구조와 할인정책 적용) (0)	2023.01.31

현재글8. 빈 생명주기 콜백 (-ing)

개발자는 언어를 잘 아는 사람이 아닌, 문제를 해결해 나가는 사람! 문제를 해결할 줄 아는, 멋있는 개발자가 되기 위한 기록✏️

Today :
Yesterday :

일	월	화	수	목	금	토
					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

빛나는 아이디어✨