빈 생명주기 콜백 📞

✅ 빈 생명주기 콜백 시작

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

• 스프링을 통해 이러한 초기화 작업과 종료 작업을 어떻게 진행할까?

예제 1

• 외부 네트워크에 미리 연결하는 객체 하나 생성
• NetworkClinet
  • 애플리케이션 시작 시점에 connect()를 호출해서 연결을 맺어두기
  • 애플리케이션 종료 시점에 disCount()를 호출해서 연결 끊기

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

BeanLifeCycleTest

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

다음과 같은 결과가 출력된다.

• 생성자 부분을 보면 url 정보 없이 connect가 호출되는 것을 볼 수 있다.
• 생성하는 단계에 url이 없고, 객체를 생성한 다음에 외부에서 수정자 주입을 통해 setUrl()이 호출되어야 url이 존재하게 된다.

✅ 스프링의 라이프 사이클

객체 생성 → 의존관계 주입

• 스프링 빈은 객체를 생성하고, 의존 관계 주입이 다 끝난 다음에 필요한 데이터를 사용할 수 있는 준비가 완료된다.
• 초기화 작업은 의존관계 주입이 모둔 완료되고 난 다음에 호출해야 한다.

개발자가 의존관계 주입이 완료된 시점을 알아야하는 방법은..?

스프링은 다양한 방식으로 생명주기 콜백을 지원한다.

• 스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해 초기화 시점을 앙려주는 다양한 기능을 제공한다.
• 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다.

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

1. 스프링 컨테이너 생성
2. 스프링 빈 생성
3. 의존관계 주입
   4. 초기화 콜백
4. 사용
   6. 소멸전 콜백
5. 스프링 종료

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

참고

객체의 생성과 초기화를 분리하자!

• 생성자는 필수 정보(파라미터)를 받고, 메모리를 할당해서 객체를 생성해야하는 책임을 가진다.
• 초기화는 이렇게 생성된 값들을 활용해서 외부 커넥션을 연결하는 등 무거운 동작을 수행한다.
• 따라서 생성자 부분과 초기화 하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋다!

스프링이 지원하는 생명주기 콜백

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

✅ 인터페이스 InitializingBean, DisposableBean

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 {
        System.out.println("NetworkClient.afterPropertiesSet");
        connect();
        call("초기화 연결 메세지");
    }

    @Override
    public void destroy() throws Exception {
        System.out.println("NetworkClient.destroy");
        disconnect();
    }
}

• InitializingBean은 afterPropertiesSet() 메서드로 초기화를 지원
• DisposableBean은 destroy() 메서드로 소멸 지원

• 초기화 메서드가 주입 완료 후에 적절하게 호출된것을 확인할 수 있다.
• 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출 된것도 확인할 수 있다.

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

• 스프링 전용 인터페이스이므로, 해당 코드가 스프링 전용 인터페이스에 의존
• 초기화, 소멸 메서드 이름 변경 불가
• 외부 라이브러리에 적용할 수 없음

따라서, 거의 사용하지 않는다!

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

설정 정보에 @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();
    }
}

LifeCycleConfig 수정

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(initMethod = "init", destroyMethod = "close")
        public NetworkClient networkClient(){
            NetworkClient networkClient = new NetworkClient();
            networkClient.setUrl("http://hello.spring.dev");
            return networkClient;
        }
    }
}

설정 정보 사용 특징

• 메서드 이름을 자유롭게 줄 수 있다.
• 스프링 빈이 스프링 코드에 의존 X
• 코드가 아니라 설정 정보에 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화/종료 메서드 적용 가능

종료 메서드 추론

• @Bean의 destroyMethod 속성의 특별한 기능이 있다.
• 라이브러리는 대부분 close, shutdown 이름의 종료 메서드를 사용한다.
• @Bean의 destroyMethod는 기본값이 (inferred) (추론)으로 등록되어 있다.
• 이 추론 기능은 close, shutdown 메서드를 자동으로 호출해준다.
• 직접 스프링 빈으로 등록하면 종료 메서드를 따로 적어주지 않아도 잘 동작한다.
• 추론 기능을 사용하기 싫다면 destroyMethod=" "처럼 빈 공백을 지정하면 된다.

✅ 애노테이션 @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;
        }
    }

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

• 최신 스프링에서 권장하는 방법이다.
• 패키지가 javax.annotation.PostConstructor, JSR-250 자바 표준, 스프링이 아닌 다른 컨테이너에서도 동작한다.
• 컴포넌트 스캔과 잘 어울린다.
• 유일한 단점 - 외부 라이브러리에서 적용하지 못한다.
  • 외부 라이브러리를 초기화/소멸 한다면 @Bean 기능을 사용!