인프런 스프링 기본 강의 정리 #8

1. 빈 생명주기 콜백

데이터베이스 커넥션 풀이나, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고, 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화와 종료 작업이 필요하다.

 

외부 네트워크에 미리 연결하는 객체를 하나 생성해보자.

src/test/java에 lifecycle 패키지를 생성하고, 그 안에 NetworkClient 클래스를 생성한다.

 

이 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);
 }
 
 public void call(String message) {
 System.out.println("call: " + url + " message = " + message);
 }
 
 //서비스 종료시 호출
 public void disconnect() {
 System.out.println("close: " + url);
 }
}

1. 생성자(Constructor):
   • 생성자에서는 url을 출력하고 connect()와 call() 메서드를 호출
   • 주의할 점은 생성자 내에서 url을 사용하여 출력하고 connect() 메서드를 호출하는데, 이때 url 값은 아직 null일 수 있다. 따라서 url을 초기화하기 전에 사용하는 것은 안전하지 않을 수 있다.
2. setUrl() 메서드:
   • url을 설정하는 메서드
3. connect() 메서드:
   • 네트워크 연결을 수행하는 메서드로, url을 이용하여 연결을 시도
4. call() 메서드:
   • 주어진 메시지와 함께 특정 url에 메시지를 보내는 메서드
5. disconnect() 메서드:
   • 네트워크 연결을 해제하는 메서드로, url을 이용하여 연결을 종료

다음으로 src/test/java/lifecycle에 BeanLifeCycleTest 클래스를 생성해 테스트 코드를 작성한다.

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(); //스프링 컨테이너를 종료, ConfigurableApplicationContext 필요
    }
    
    @Configuration
    static class LifeCycleConfig {
    
        @Bean
        public NetworkClient networkClient() {
            NetworkClient networkClient = new NetworkClient();
            networkClient.setUrl("http://hello-spring.dev");
            return networkClient;
        }
    }
}

1. BeanLifeCycleTest 클래스:
   • lifeCycleTest 메서드가 정의되어 있다. 이 메서드는 빈의 라이프사이클을 확인하기 위한 테스트 메서드
   • AnnotationConfigApplicationContext를 생성하여 LifeCycleConfig 클래스를 사용하여 스프링 컨테이너를 초기화
   • NetworkClient 빈을 가져온다.
   • 마지막으로 ac.close()를 호출하여 스프링 컨테이너를 종료
2. LifeCycleConfig 내부 클래스:
   • LifeCycleConfig는 @Configuration 애노테이션이 붙은 내부 클래스
   • networkClient() 메서드는 NetworkClient 빈을 생성하여 반환
   • 이 빈은 setUrl 메서드를 호출하여 url을 설정한 후에 반환

실행해보면 아래와 같은 결과가 나온다.

생성자 호출, url = null
connect: null
call: null message = 초기화 연결 메시지

객체를 생성하는 단계에는 url이 없고, 객체를 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl() 이 호출되어야 url이 존재하게 된다는 것을 확인할 수 있다. 이러첨 스프링은 의존관계 주입이 필요하다.

 

구체적인 빈의 라이프 사이클은 다음과 같다.

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

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

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

• 인터페이스(InitializingBean, DisposableBean)
• 설정 정보에 초기화 메서드, 종료 메서드 지정
• @PostConstruct, @PreDestroy 어노테이션 지원

2. 인터페이스 InitializingBean, DisposableBean

InitializingBean, DisposableBean을 implements해서 초기화 메소드를 오버라이드하여 사용하는 방법이다.

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);
 }
 
 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();
 }
}

• 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

초기화 메서드가 주입 완료 후에 적절하게 호출되고, 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출된다.

 

그러나 이 방법은 스프링 전용 인터페이스에 의존하며 초기화, 소멸 메소드 이름 변경이 불가능하다. 또한 코드 수정이 불가한 외부라이브러리에 적용할 수 없기 때문에 최근에는 잘 사용하지 않는다.

3.  빈 등록 초기화, 소멸 메서드

설정 정보에 @Bean(initMethod = "init", destroyMethod = "close") 처럼 초기화, 소멸 메서드를 지정할 수 있다.

다음과 같이 NetworkClient 클래스를 수정한다.

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();
 }
}

다음으로 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;
 }
}

 

initMethod, destroyMethod를 사용하면 메서드 이름을 자유롭게 사용할 수 있고, 스프링 빈 스프링 코드에 의존하지 않는다. 또한 설정 정보를 사용하기 때문에 외부라이브러리에도 초기화, 종료 메서드를 적용할 수 있다.

 

종료 메서드에는 추론 기능도 있다. 보통 라이브러리는 대부분 close, shutdown 등의 종료 메서드명을 사용한다.

이때 @Bean의 destroyMethod는 기본값이 (inferred)로 등록되어 있다. 그래서 종료 메서드를 따로 적지 않아도 작동한다.

4. 애노테이션 @PostConstruct, @PreDestroy

다음과 같이 @PostConstrut와 @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 이 두 어노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다.

 

스프링이 아닌 다른 컨테이너에서도 동작하며, 최신 스프링에서 가장 권장하는 방법이다.

다만 외부 라이브러리에는 적용하지 못한다는 단점이 있다.

 

따라서 기본적으로 @PostConstruct, @PreDestroy 애노테이션을 사용하는 것이 좋다.

또한 코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료해야하면 @Bean 의 initMethod , destroyMethod 를 사용한다.