[Spring] 빈 생명주기 콜백

이 글은 인프런에서 김영한 님의 "스프링 핵심원리 - 기본편"을 수강 후 공부한 내용을 정리한 게시글입니다. 부족한 부분이 있다면 언제든 지적 부탁드립니다.

✏️ 빈 생명 주기 콜백

---

스프링 어플리케이션 시작 시점에 필요한 연결을 미리 해두고 어플리케이션 종료 시점에 연결을 모두 종료하는 객체 초기화 작업과 종료 작업이 필요하다.

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

위 예제 코드에서 생성자 호출시 connect() 메소드를 실행하여 연결을 맺는 초기화 작업을 수행하도록 되어있다.

그러나 위 코드를 실행해보면 이상한 결과가 나온다.

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

이런 결과가 나오는 이유는 객체가 생성된 후에 url을 주입하기 때문이다.

처음에는 객체를 생성할때 파라미터로 url을 주입해주면 되지 않나 생각했는데

이 객체는 스프링 컨테이너가 올라갈때 빈으로 생성되야 하기 때문에 url을 사용자가 입력할 수 없다.

또한 객체의 생성과 초기화를 분리하는 것이 좋다.

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

이러한 이유로 생성자에서 url을 저장하지 않는다.

그렇다면 스프링 빈은 객체 생성 → 의존 관계 주입 라이프 사이클을 가지게 되는데 의존 관계 주입이 끝난 후에 개발자는 객체를 호출 해야 온전하게 의도한 바대로 객체를 사용할 수 있다.

그렇게 하기 위해서는 의존관계 주입이 끝난 시점을 개발자가 알아야한다.

이 시점을 스프링이 알려준다.

스프링은 의존관계 주입이 완료되면 스프링빈에게 콜백 메서드를 통해 초기화 시점을 알려주는 다양한 기능을 제공한다.

또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다.

따라서 종료 작업을 안전하게 진행할 수 있다.

<스프링 빈의 이벤트 라이프사이클>
스프링 컨테이너 생성

→ 스프링 빈 생성

→ 의존관계 주입

→ 초기화 콜백

→ 사용

→ 소멸 전 콜백

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

✏️ 빈 생명주기 콜백 방법

---

인터페이스(InitializingBean, DisposableBean)

package hello.core.lifecycle;
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, DisposableBean 인터페이스를 사용한다.
• InitializingBean은 afterPropertiesSet() 메서드로 초기화를 지원한다.
• DisposableBean은 destroy() 메서드로 소멸을 지원한다
• 단점
  • 이 인터페이스는 스프링 전용 인터페이스이다. 따라서 해당 코드가 스프링 전용 인터페이스에 의존한다.
  • 초기화, 소멸 메소드의 이름을 변경할 수 없다.
  • 개발자가 코드를 고칠 수 없는 외부 라이브러리에는 적용할 수 없다.
• 거의 사용하지 않는다.

설정 정보에 초기화 메서드, 종료 메서드 지정

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

@PostConstruct, @PreDestroy 애노테이션 지원

package hello.core.lifecycle;
import javax.annotation.PostConstruct;
import javax.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();
    }
}

• 최근 스프링에서 가장 권장하는 방법이다.
• javax.annotation.PostConstruct이다. 스프링에 종속적인 기술이 아니라 JSR-250라는 자바 표준이다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작한다
• 유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다. 외부 라이브러리를 초기화, 종료 해야 하면 @Bean의 기능을 사용하자.

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