본문 바로가기
Develop/Spring

[Spring/기본편] 빈 생명주기 콜백

by J-rain 2024. 3. 19.

 

 

빈 생명주기 콜백

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

스프링 빈은 다음과 같은 라이프사이클을 가진다.

객체 생성의존관계 주입

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

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

 

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

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

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

 

 

인터페이스 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 {
        connect();
        call("초기화 연결 메시지");
    }

    @Override
    public void destroy() throws Exception {
        disconnect();
    }
}
  •  InitializingBean  은  afterPropertiesSet()  메서드로 초기화를 지원한다.
  •  DisposableBean  은  destroy()  메서드로 소멸을 지원한다.
    • 초기화, 소멸 인터페이스 단점
    • 이 인터페이스는 스프링 전용 인터페이스다. 해당 코드가 스프링 전용 인터페이스에 의존함
    • 따라서 거의 사용안함 (최근에는 애노테이션방법을 사용함)

 

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

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


    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;
        }
    }
  • 특징
  • 메서드 이름을 자유롭게 줄 수 있다.
  • 스프링 빈이 스프링 코드에 의존하지 않는다.
  • 코드가 아니라 설정 정보를 사용하기에 코드를 고칠 수 없는 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다.
  • 이 방법도 주로 쓰이진 않는다.
@Bean 의 destroyMethod 속성에는 특별한 기능이 있다. 라이브러리는 대부분 close , shutdown 이라는 이름의 종료 메서드를 사용한다.
@Bean 의 destroyMethod 는 기본값이 (inferred) (추론) 으로 등록되어 있다. 이 추론 기능은 close , shutdown 이라는 이름의 메서드를 자동으로 호출한다.
이름 그대로 종료 메서드를 추론해서 호출해준다. 따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 작동한다. 추론 기능을 사용하기 싫다면 destroyMethod="" 처럼 빈 공백을 지정하면 된다.

 

 

어노테이션  @PostConstruct  @PreDestroy 

package hello.core.lifecycle;


import jakarta.annotation.PostConstruct;
import jakarta.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;
        }
    }

 

  •  @PostConstruct  @PreDestroy  이 두 애노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다.
  • 스프링이 아닌 다른 컨테이너에서도 동작한다. (스프링 종속 기술x)
  • 컴포넌트 스캔과 잘 어울린다.
  • 유일한 단점은 외부 라이브러리에 적용하지는 못한다. 종료 해야 하면 @Bean 의 기능을 사용하자.

 

 

정리

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

댓글