8. 빈 생명주기 콜백

빈 생명주기 콜백 시작

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

이 작업이 어떻게 되는지 알아보자.

간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정해보자. (실제로 네트워크에 연결하는 것은 아니고, 단순히 문자만 출력한다. ) 이 NetworkClient는 애플리케이션 시작 시점에 connect()를 호출해서 연결을 맺어두어야 하고, 애플리케이션이 종료되면 disConnect()를 호출해서 연결을 끊어야 한다.

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() {
        ConfigurableApplicationContext 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("https://hello-spring.dev");
            return networkClient;
        }
    }
}

출력 결과를 보면, 생성자에서 connect호출 시 url이 null인 상태가 된다.

• 스프링은 간단하게 객체생성 ⇒ 의존관계 주입의 라이프 사이클을 갖는다.

스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료된다. 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다. 그런데 개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까?

스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공한다. 또한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 준다. 따라서 안전하게 종료 작업을 진행할 수 있다.

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

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

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

• 소멸전 콜백: 빈이 소멸되기 직전에 호출

💡

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

스프링은 크게 3가지 방법으로 빈 생명주기 콜백을 지원한다.

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

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

생성자 호출, url = null
connect: https://hello-spring.dev
call: https://hello-spring.dev message = 초기화 연결 메시지
13:31:31.653 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@54a7079e, started on Thu Jun 09 13:31:31 KST 2022
close: https://hello-spring.dev

특징

• 이 인터페이스는 스프링전용 인터페이스이다. 따라서 해당 코드가 스프링 전용이 된다.

• 초기화, 소멸 메서드의 이름을 변경할 수 없다.

• 내가 코드를 고칠 수 없는 라이브러리에 적용할 수 없다.

⇒ 현재는 거의 사용하지 않는다.

빈 등록 초기화, 소멸 메소드

@Configuration
static class LifeCycleConfig {
    @Bean(initMethod = "init", destroyMethod = "close")
    public NetworkClient networkClient() {
        NetworkClient networkClient = new NetworkClient();
        networkClient.setUrl("https://hello-spring.dev");
        return networkClient;
    }
}

특징

• 메서드 이름을 자유롭게 줄 수 있다.

• 스프링 빈이 스프링에 의존하지 않는다.

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

종료 메서드 추론

• Bean의 destroyMethod속성에는 아주 특별한 기능이 있다.

• close, shundown 이라는 이름의 메서드가 있으면 자동으로 호출해준다.

• 이 추론 기능을 사용하기 싫으면 destoryMethod=""처럼 빈 공백을 지정하면 된다.

⇒ 얘도 잘 안쓴다.

어노테이션 @PostConstruct, @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(){
        connect();
        call("초기화 연결 메시지");
    }

    @PreDestroy
    public void close(){
        disconnect();
    }
}

생성자 호출, url = null
connect: https://hello-spring.dev
call: https://hello-spring.dev message = 초기화 연결 메시지
13:43:34.151 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@54a7079e, started on Thu Jun 09 13:43:33 KST 2022
close: https://hello-spring.dev

특징

• 스프링에서 권장하는 방법이다.

• 스프링 정속적인 기술이 아니라, Java의 표준이다.

• 컴포넌트 스캔과 잘 어울린다.

• 유일한 단점은 외부 라이브러리에는 적용을 못 한다는 점이다. 외부 라이브러리 초기화, 종료 시 @Bean 기능을 활용하자.

정리

• @PostConstruct, @PreDestroy 애노테이션을 사용하자.

• 외부라이브러리를 초기화/종료 해야하면, @Bean의 initMethod, destroyMethod 를 사용하자.

Uploaded by N2T

(23.05.31 22:38)에 작성된 글 입니다.