Lined Notebook

[Spring MVC - 핵심 원리 기본] 07. 빈 생명주기 콜백

by ymkim

01. 빈 생명주기 콜백 시작

📌 스프링 빈이 생성 되거나 소멸 되기 직전에 Bean 안에 메서드를 호출하는 빈 라이프사이클
  • 스프링 빈 생성 및 소멸 전 Bean 안에 메서드 호출 기능
  • 데이터베이스 커넥션 풀이나, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고, 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화와 종료 작업이 필요하다. 이번 시간에는 스프링을 통해 이러한 초기화 작업과 종료 작업을 어떻게 진행하는지 알아본다
  • 간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정
    • 애플리케이션 시작 시점에 네트워크 연결 : connect() 호출
    • 애플리케이션 종료 시점에 네트워크 종료 : disconnect() 호출

01-1. NetworkClient

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

01-2. BeanLifeCycleTest

package hello.core.lifecycle;

...

public class BeanLifeCycleTest {

    @Test
    void lifeCycleTest() throws Exception {
        //given
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        NetworkClient networkClient = ac.getBean("networkClient", NetworkClient.class);
        ac.close();
        //when

        //then
    }

    @Configuration
    static class LifeCycleConfig {

        @Bean
        public NetworkClient networkClient() {
            NetworkClient networkClient = new NetworkClient();
            networkClient.setUrl("<http://hello-spring.dev>");
            return networkClient;
        }
    }
}
23:01:01.953 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'org.springframework.context.event.internalEventListenerProcessor'
23:01:01.956 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'org.springframework.context.event.internalEventListenerFactory'
23:01:01.957 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'org.springframework.context.annotation.internalAutowiredAnnotationProcessor'
23:01:01.959 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'org.springframework.context.annotation.internalCommonAnnotationProcessor'
23:01:01.972 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'beanLifeCycleTest.LifeCycleConfig'
23:01:01.977 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'networkClient'
생서자 호출, url = **null**
connect = **null**
call = **null**, message = 초기화 연결 메시지
23:01:02.041 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@7133da86, started on Mon Feb 27 23:01:01 KST 2023
  • 테스트 코드 실행 시 call 부분이 null로 초기화 되어 있음?
  • 현재 객체 생성 시에는 생성자를 통해 값을 셋팅하기에 당연히 여기서는 값이 셋팅 되지 않음
  • setUrl(”http://hello-spring.dev”) 하는 경우 값이 셋팅 됨

스프링 빈은 “객체 생성 후” → “의존관계 주입” 순으로 라이프 사이클을 가짐

  • 생성자 주입은 예외
  • setter
  • 필드 주입
  • 스프링 빈은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공한다. 또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다.
  • 스프링 빈의 이벤트 라이프 사이클
    • 스프링 컨테이너 생성스프링 빈 생성의존관계 주입초기화 콜백사용소멸전 콜백스프링 종료
    • 초기화 콜백 : 빈이 생성되고, 빈의 의존관계 주입이 완료된 후 호출
    • 소멸전 콜백 : 빈이 소멸되기 직전에 호출
  • 스프링은 크게 3가지 방법으로 빈 생명주기(이벤트 라이프 사이클) 콜백을 지원
    • 인터페이스 InitializingBean, DisposableBean
    • 설정 정보에 빈 등록 초기화, 소멸 메서드 추가
    • @PostConstructor, @PreDestroy

02. 인터페이스 InitializingBean, DisposableBean

02-1. NetwordClient → InitializingBean

public class NetworkClient implements InitializingBean, DisposableBean { 

	...

	//의존관계 주입이 끝나면 호출 해달라
	@Override
        public void afterPropertiesSet() throws Exception {
    	connect();
        call("초기화 연결 메시지");
	}

	//
	@Override
	public void destroy() throws Exception {
		disconnect();
	}
}
  • 이전에 만든 클래스에 InitializingBean, DisposableBean 인터페이스 추가
  • InitializingBean
    • 의존 관계 주입이 끝나면 실행
  • DisposableBean
    • 해당 Bean 종료 시 호출

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

  • 이 인터페이스는 스프링 전용 인터페이스로 해당 코드가 스프링 전용 인터페이스에 의존한다
  • 초기화, 소멸 메서드의 이름을 변경 할 수 없다
  • 내가 코드를 고칠 수 있는 외부 라이브러리에 적용할 수 없다

참고 : 인터페이스를 사용하는 초기화, 종료 방법은 스프링 초창기에 나온 방법으로 현재 거의 사용하지 않는다

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

03-1. 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;
    }
}
  • @Bean 어노테이션에 위와 같이 옵션을 추가
  • 메서드 이름을 자유롭게 작성할 수 있음
  • 스프링 빈이 스프링 코드에 의존하지 않음
  • 코드가 아니라 설정 정보를 사용하기에 코드를 고칠 수 있는 외부 라이브러리에도 초기화, 종료 메서드 적용 가능

03-2. 종료 메서드 추론

  • @Bean의 destroyMethod 속성에는 특별한 기능 존재
  • 라이브러리는 대부분 close, shutdown 이라는 이름의 종료 메서드를 사용
  • @Bean의 destroyMethod 는 기본 값이 (inferred) (추론)으로 등록되어 있음
  • 이 추론 기능은 close, shutdown 라는 이름의 메서드를 자동으로 호출
    • 이름 그래도 종료 메서드를 추론하여 자동으로 실행
  • 따라서 직접 스프링 빈으로 등록 시 종료 메서드는 따로 안 적어도 됨
  • 추론 사용 안하려면 destroyMethod = ""

04. 어노테이션 @PostConstructor, @PreDestroy

04-1. NetworkClient

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

@PostConstruct
public void init() throws Exception {
    System.out.println("NetworkClient.init");
    connect();
    call("초기화 연결 메시지");
}

@PreDestroy
public void close() throws Exception {
    System.out.println("NetworkClient.close");
    disconnect();
}
  • 최신 스프링에서 권장
  • 어노테이션 하나만 붙히면 끝
  • 패캐지를 보면 javax.annotation.xxx 인데 스프링에 종속된것이 아닌 JSR-250 자바 표준이다.
  • 컴포넌트 스캔과 잘 어울림
  • 유일한 단점은 외부 라이브러리에는 적용 못함
  • @PostConstructor, @PreDestroy 사용하자

블로그의 정보

기록하고, 복기하고

ymkim

활동하기