빈 생명주기 콜백 시작
애플리케이션 시작 시점에 필요한 연결을 미리 해두고, 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화와 종료 작업이 필요하다.(안전하게 종료 처리시키는 것이 필요하다)
(참고 : 마치 TCP/IP 연결할 때 오래 걸리니까 미리 DB 와 연결해놓는 데이터베이스 커넥션 풀과 같은 개념이라고 생각하면 된다.)
[예제]
간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정해보자. (서버가 뜰 때 미리 외부 네트워크에 연결)
실제로 네트워크에 연결하는 것은 아니고, 단순히 문자만 출력하도록 했다.
이 NetworkClient 는 애플리케이션 시작 시점에 connect() 를 호출 -> 연결을 맺어두어야 하고,
애플리케이션이 종료되면 disConnect() 를 호출 -> 연결을 끊어야 한다.
package hello.core.lifecycle;
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); //어떤 url과 연결 되었는지
}
//연결된 상태
public void call(String message)
{
//어떤 url과 연결되어 있고 메시지는 어떤 것인지 출력
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);
//ConfigurableApplicationContext는 AnnotationConfigApplicationContext의 상위 것이다.
NetworkClient client = ac.getBean(NetworkClient.class);
ac.close(); //스프링 컨테이너를 종료, ConfigurableApplicationContext 필요
}
@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가 호출되는 것을 확인할 수 있다.객체를 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl() 이 호출을 통해 세팅이 되어야지 비로소 url이 존재하게 될 것이다.
[스프링 빈의 라이프 사이클]
스프링 빈은 간단하게 다음과 같은 라이프사이클을 가진다.
1) 필드 주입, 2) 수정자 주입의 경우 => 객체 생성한 다음에 의존관계 주입이 있어야한다.
필드 주입과 수정자 주입과 달리 3) "생성자 주입"의 경우 => 객체를 생성할 때 파라미터에 빈이 같이 들어와야 한다.
스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료된다. 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다. 초기화는 객체를 생성하는 작업이 아니라 객체 안에 필요한 값이 다 연결이 되어 있고 외부와 제대로 처음 작업을 시작하는 것을 초기화라고 한다.
그런데 개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까?
1) 초기화 가능 : 스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공한다. (마치 '의존관계 주입이 다 완료되었으니 이제 초기화 가능합니다~' 라고 알려주는 메서드)
2) 종료 시점 : 또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다.
이에 따라 안전하게 종료 작업을 진행할 수 있다.
[ 스프링 빈의 이벤트 라이프사이클 ]
[싱글톤의 경우]
스프링컨테이너생성
→ 스프링빈생성(생성자 주입)
→ 의존관계주입(필드 주입, 수정자 주입 같은 )
→ 초기화콜백
→ 사용 (애플리케이션 동작)
→ 소멸 전 콜백
→ 스프링 종료
- 초기화 콜백: 빈이 생성되고, 빈의 의존관계 주입이 완료된 후 호출
- 소멸전 콜백: 빈이 소멸되기 직전에 호출
스프링은 다양한 방식으로 생명주기 콜백을 지원한다.
참고: 객체의 생성과 초기화를 분리하자.
단일 책임 원칙에 의하여 객체를 생성할 때는 객체를 생성할 때 초집중을 해야 한다.
- 생성자는 필수 정보(파라미터)를 받고, 메모리를 할당해서 객체를 생성하는 책임을 가진다.
- 반면에 초기화는 이렇게 생성된 값들을 활용해서 외부 커넥션을 연결하는등 무거운 동작을 수행한다.(실제 동작)
- 따라서 생성자 안에서 무거운 초기화 작업을 함께 하는 것 보다는 객체를 생성하는 부분과 초기화 하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋다.
- 물론 초기화 작업이 내부 값들만 약간 변경하는 정도로 단순한 경우에는 생성자에서 한번에 다 처리하는게 더 나을 수 있다.
스프링은 크게 3가지 방법으로 빈 생명주기 콜백을 지원한다.
- 인터페이스(InitializingBean, DisposableBean)
- 설정 정보에 초기화 메서드, 종료 메서드 지정
- @PostConstruct, @PreDestroy 애노테이션 지원
하나씩 알아보자.
1) 인터페이스(InitializingBean, DisposableBean)
InitializingBean 은 afterPropertiesSet() 메서드로 초기화를 지원한다. DisposableBean 은 destroy() 메서드로 소멸을 지원한다.
출력 결과
생성자 호출, url = null
NetworkClient.afterPropertiesSet
connect: <http://hello-spring.dev>
call: <http://hello-spring.dev> message = 초기화 연결 메시지
13:24:49.043 [main] DEBUG
org.springframework.context.annotation.AnnotationConfigApplicationContext -
Closing NetworkClient.destroy
close + <http://hello-spring.dev>
출력 결과를 보면 초기화 메서드가 주입 완료 후에 적절하게 호출 된 것을 확인할 수 있다. 그리고 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출 된 것도 확인할 수 있다.
초기화, 소멸 인터페이스 단점
- 이 인터페이스는 스프링 전용 인터페이스다. 해당 코드가 스프링 전용 인터페이스에 의존한다.(스프링이 있어야 사용가능)
- 초기화, 소멸 메서드의 이름을 변경할 수 없다.
- 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.
참고: 인터페이스를 사용하는 초기화, 종료 방법은 스프링 초창기에 나온 방법들이고, 지금은 다음의 더 나은 방법들이 있어서 거의 사용하지 않는다.
2) 빈 등록 초기화, 소멸 메서드 지정
설정 정보에 @Bean(initMethod = "init", destroyMethod = "close") 처럼 초기화, 소멸 메서드를
지정할 수 있다.
package hello.core.lifecycle;
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); //어떤 url과 연결 되었는지
}
//연결된 상태
public void call(String message)
{
//어떤 url과 연결되어 있고 메시지는 어떤 것인지 출력
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();
}
}
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);
//ConfigurableApplicationContext는 AnnotationConfigApplicationContext의 상위 것이다.
NetworkClient client = ac.getBean(NetworkClient.class);
ac.close(); //스프링 컨테이너를 종료, ConfigurableApplicationContext 필요
}
@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의 destroyMethod 속성에는 아주 특별한 기능이 있다.(@Bean으로 등록할 때만 해당)
라이브러리(외부 라이브러리)는 대부분 close , shutdown 이라는 이름의 종료 메서드를 사용한다.
@Bean의 destroyMethod 는 기본값이 (inferred) (추론)으로 등록되어 있다.
이 추론 기능은 close , shutdown 라는 이름의 메서드를 자동으로 호출해준다.
이름 그대로 종료 메서드를 추론해서 호출해준다.
따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다.
추론 기능을 사용하기 싫으면 destroyMethod="" 처럼 빈 공백을 지정하면 된다.
3) 애노테이션 - @PostConstruct, @PreDestroy
@PostConstruct , @PreDestroy 이 두 애노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다.
@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; //이렇게 리턴한 결과물이 스프링 빈에 적용이 된다.
}
}
@PostConstruct, @PreDestroy 애노테이션 특징
최신 스프링에서 가장 권장하는 방법이다.
애노테이션 하나만 붙이면 되므로 매우 편리하다.
패키지를 잘 보면 javax.annotation.PostConstruct 이다.
스프링에 종속적인 기술이 아니라 JSR-250라는 자바 표준이다.
따라서 스프링이 아닌 다른 컨테이너에서도 동작한다.
컴포넌트 스캔과 잘 어울린다.(빈으로 따로 등록하지 않아도 된다)
유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다.
외부 라이브러리를 초기화, 종료 해야 하면 @Bean의 기능을 사용하자.(2번째 방법인 init 메소드 사용)
정리
@PostConstruct, @PreDestroy 애노테이션을 사용하자
코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료해야 하면 @Bean 의 initMethod , destroyMethod 를 사용하자.
이 글은 김영한님의 스프링 기본편 강의와 자료를 참고하여 작성했습니다.
'WEB > Spring' 카테고리의 다른 글
[Spring Security] 스프링 시큐리티란? (0) | 2023.03.08 |
---|---|
[JPA] JPA와 JPA의 필요성 (0) | 2023.02.26 |
같은 타입인 여러 개의 빈들을 조회하고 싶을 때 (1) | 2022.09.10 |
Lombok 라이브러리의 @RequiredArgsConstructor (2) | 2022.09.09 |
의존관계 주입 4가지 방법과 생성자 주입 권장 이유 (0) | 2022.09.04 |