빈 생명주기 콜백

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

 

외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정했을 때, 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);
    }
}

 

public class BeanLifeCycleTest {

    @Test
    public void lifeCycleTest() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        NetworkClient client = ac.getBean(NetworkClient.class);
        ac.close();
    }

    @Configuration
    static class LifeCycleConfig {
        @Bean
        public NetworkClient networkClient() {
            NetworkClient networkClient = new NetworkClient();
            networkClient.setUrl("http://hello-spring.dev");
            return networkClient;
        }
    }
}

 

 

결과값은 url이 null이 나온다. 

객체를 생성하는 시점에선 url이 없고, 생성한 다음에 외부에서 setter 주입을 통해서 setUrl이 호출되어야 url이 존재하기 때문이다.

 

스프링 빈은 객체 생성 -> 의존관계 주입 라이프 사이클을 가진다.

객체를 생성하고, 의존관계 주입이 끝 난 다음에 필요한 데이터를 사용할 수 있는 준비를 할 수 있게 되는 것이다.

따라서 초기화 작업은 의존관계가 주입이 완료된 후에 호출해야하는데, 개발자가 의존관계 주입이 완료된 시점을 어떻게 확인할 수 있을까?

 

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

스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다. 따라서 안전하게 종료 작업을 진행할 수 있게 된다.

 

스프링 빈의 이벤트 사이클

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

 

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

생성자는 파라미터를 받고 메모리를 할당해서 객체를 생성하는 책임을 가진다. 반면에 초기화는 이렇게 생성된 값들을 활용해서 외부 커넥션을 연결하는 무거운 동작을 수행한다.

따라서 생성자 안에서 무거운 초기화 작업을 함께 하는 것 보다 객체를 생성하는 부분과 초기화 하는 부분을 명확히 나누는 것이 유지보수 관점에서 좋다.

 

콜백을 사용하는 이유

빈 생명주기 콜백은 필수가 아니라 선택적으로 사용하는 기능이다.

- 의존성 검증을 위해 필요한 의존성이 제대로 주입되었는지 확인할 수 있고,

- 주입된 의존성을 사용해 추기적인 초기화작업을 할 수 있고,

- 생성자 주입에서 발생할 수 있는 순환참조 문제를 피하면서 의존성이 모두 준비된 상태에서 초기화 작업을 할 수 있고,

- 복잡한 초기화 로직을 분리할 수 있다. (생성자는 간단하게, 복잡한 초기화 로직은 별도의 메서드로 분리가능)

 

어떨때 사용하냐?

- 데이터베이서 커넥션 초기화/종료시

- 파일 시스템 리소스 확보/해제시

- 외부 서비스 연결/연결 해제시

- 캐시 초기화/정리시

 

 

인터페이스 InitializingBean, DisposableBean

public class NetworkClient implements InitializingBean, DisposableBean {

    private String url;

    public NetworkClient() {

    ... 중략

    // 의존관계 주입이 끝나면 호출하는 메서드
    @Override
    public void afterPropertiesSet() throws Exception {
        connect();
        call("초기화 연결 메세지");
    }

    @Override
    public void destroy() throws Exception {
        disconnect();
    }
}

 

InitializingBean은 afterPropertiesSet() 메서드로 초기화를 지원한다.

DisposableBean은 destory() 메서드로 소멸을 지원한다.

 

출력 결과를 보면 초기화 메서드가 주입 완료 후에 적절하게 호출되는것을 확인할 수 있다.

그리고 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출되는것도 확인할 수 있다.

 

이 방법은 스프링 전용 인터페이스로 해당 코드가 스프링 전용 인터페이스에 의존한다.

초기화, 소멸 메서드의 이름을 변경할 수 없고, 내가 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.

위 방법은 초창기에 나온 방법이라 요즘엔 잘 사용하지 않는다.

 

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

설정 정보에 @Bean(initMethod = "init", destoryMethod = "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;
    }
}

 

메서드 이름을 자유롭게 줄 수 있게 바뀌었다. (오버라이딩을 하지 않아도 됨)

스프링 빈이 스프링 코드에 의존하지 않게 되었다.

코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다.

 

destoryMethod에는 추론 기능이 있는데, 보통 라이브러리는 close, shutdown이라는 이름의 종료 메서드를 사용한다.

destoryMethod는 기본값이 (inferred) = 추론으로 등록되어있어서, close, shutdown 라는 이름의 메서드를 자동으로 호출해준다.

 

@PostConstruct, @PreDestroy

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

@PreDestroy
public void close() {
    System.out.println("NetworkClient.close");
    disconnect();
}

 

@PostConstruct, @PreDestroy 어노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다.

가장 권장하는 방법이다. 어노테이션만 붙이면 되니 가장 편리하다.

패키지를 보면 javax.annotation.PostConstruct이다. 스프링에 종속된 기술이 아니라 자바 표준이기 때문에 다른 컨테이너에서도 잘 작동한다.

컴포넌트 스캔과 잘 어울린다. 하지만 외부 라이브러리에는 적용하지 못한다는것이 한가지 단점이 된다.

외부 라이브러리를 초기화, 종료 해야된다고 하면 @Bean 기능을 사용하자 (init 메서드)

 

외부라이브러리를 초기화할 수 있고, 없고가 무슨 뜻일까?

@PostConstruct같은 어노테이션을 사용하려면 그 어노테이션을 해당 클래스 내부에 추가해야된다.

하지만 외부 라이브러리 (내가 만든 게 아닌 다른 사람이 만든 라이브러리)는 코드 자체를 수정할 수 없다.

그러니 @PostConstruct를 추가할 수 없게 되는 것이다.

 

📌 외부 라이브러리를 초기화해야 하는 경우

1. 데이터베이스 커넥션 풀

• 애플리케이션 시작 시 DB와 미리 연결을 해놓고 사용

• 종료할 때는 연결을 닫아줘야 함 (close() 호출)

• 예: HikariCP, Apache DBCP 같은 커넥션 풀 라이브러리

2. 네트워크 연결 (소켓, 메시지 큐 등)

• 예를 들어 Redis, Kafka, RabbitMQ 같은 외부 서비스와 연결을 유지하는 라이브러리

• 시작할 때 연결 (connect()), 종료할 때 연결 해제 (disconnect())

3. 캐시 시스템 (Ehcache, Caffeine 등)

• 서버 실행 시 캐시를 미리 로드할 필요가 있을 때

• 종료 시 캐시 데이터를 정리해야 할 때

4. 파일 시스템, 로깅 라이브러리

• 애플리케이션이 시작할 때 특정 디렉터리를 스캔하거나 로그 파일을 연다면 초기화가 필요

• 종료할 때는 파일 스트림을 닫아줘야 한다

 

이 경우엔 @Bean기능을 사용해서 초기화, 종료를 해주어야 한다.