빈 생명주기 콜백

빈 생명주기 콜백

1. 빈 생명주기 콜백 시작

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

예제 코드

// NetworkClient.java

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.java

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("http://hellospring.dev");
            return networkClient;
        }
    }
}

// 테스트 결과

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

객체 생성 단계에서는 url이 없으므로 url 정보가 호출되지 않는다

url은 객체 생성 이후 수장자 주입을 통해 setUrl()이 호출되어야 존재하게 된다.

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

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

객체를 먼저 생성하고 의존관계 주입이 끝난 다음에 초기화가 이루어진다

스프링에서 생성/소멸 콜백 메서드 기능을 제공해준다

참고: 객체의 생성과 초기화 분리

생성자는 필수 정보(파라미터)를 받고 메모리를 할당해서 객체를 생성

반면, 초기화는 생성된 값들을 활용해 외부 커넥션을 연결하는 등 무거운 동작 수행

✔ 따라서 생성자 안에서 무거운 초기화 작업을 함께 진행하는 것보다 생성과 초기화를 분리하는 것이 유지 보수 관점에서 바람직

초기화 작업이 가볍고 단순한 경우에는 생성자에서 한번에 처리 가능

스프링의 3가지 빈 생명주기 콜백

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

2. 인터페이스(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() 메서드로 소멸을 지원한다.

출력 결과

생성자 호출, url = null
NetworkClient.afterPropertiesSet
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
13:24:49.043 [main] DEBUG
org.springframework.context.annotation.AnnotationConfigApplicationContext -
Closing NetworkClient.destroy
close + http://hello-spring.dev

초기화 메서드가 의존성 주입 이후에 호출된다

스프링 컨테이너 종료에따라 소멸 메서드가 호출된다

단점

스프링 전용 인터페이스

초기화, 소멸 메서드 이름 변경 불가능

✔ 내가 코드를 고칠 수 없는 외부 라이브러리에 적용 불가능

위와 같은 단점드롤 인해 최근에는 자주 사용x

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

설정 정보에 @Bean(initMethod = "init", destroyMethod = "close") 처럼 초기화, 소멸 메서드를 지정할 수 있다.

적용 코드

// NetworkClient.java

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.java

@Configuration
static class LifeCycleConfig {

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

설정 정보에 초기화 소멸 메서드를 지정해준다

출력 결과

생성자 호출, url = null
NetworkClient.init
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
13:33:10.029 [main] DEBUG
org.springframework.context.annotation.AnnotationConfigApplicationContext -
Closing NetworkClient.close
close + http://hello-spring.dev

설정 정보 사용의 장점

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

스프링빈이 스플이 코드에 의존하지 않는다

✔ 코드가 아닌 설정 정보를 사용하기 때문에 외부 라이브러리에도 초기화, 종료 메서드 적용 가능

종료 메서드 추론

✔ @Bean의 destroyMethod 는 기본값이 (inferred) (추론)으로 등록되어 있다.

추론 기능은 close, shutdown이라는 메서드를 자동으로 호출해준다

따라서 직접 스프링빈으로 등록하면 종료 메서드를 따로 적어주지 않아도 동작한다

추론 기능을 사용하지 않으려면 destroyMethod=""처럽 빈 공백 지정

Annotation @PostConstruct, @PreDestroy

적용 코드

// NetworkClient.java

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() {
        System.out.println("NetworkClient.destroy");
        disconnect();
    }
}

// LifeCycleConfig.java

@Configuration
static class LifeCycleConfig {

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

출력 결과

생성자 호출, url = null
NetworkClient.init
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
19:40:50.269 [main] DEBUG
org.springframework.context.annotation.AnnotationConfigApplicationContext -
Closing NetworkClient.close
close + http://hello-spring.dev

애노테이션을 사용해 편리하게 초기화와 종료를 실행할 수 있다

@PostConstruct, @PreDestroy의 애노테이션 특징

✔ 최신 스프링에서 가장 권장하는 방법

간편하고 편리

javax 패키지 사용: 스프링 종속적인 기술이 아니라 자바 표준 기술 -> 다른 컨테이너에서도 동작

컴포넌트 스캔과 잘 어울림

단점: 외부 라이브러리 적용 불가 -> @Bean 기능 사용

정리

✔ 기본적으로는 @PostConstruct, @PreDestroy 애노테이션을 사용

✔ 코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료해야 하면 @Bean 의 initMethod, destroyMethod 사용하자