[Spring] 빈 생명주기 콜백

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

 

ublic class NetworkClient {
    private String url;

    public void setUrl(String url) {
        this.url = url;
    }

    public NetworkClient() {
        System.out.println("생성자 호출, url = " + url);
        connect();
        call("초기화 연결 메시지");
    }

    //서비스 시작시 호출
    public void connect() {
        System.out.println("connect: " + url);

    }

    public void call(String meesage) {
        System.out.println("call: " + url + " message = " + meesage);

    }

    //서비스 종료시 호출
    public void disconnect() {
        System.out.println("close: " + url);

    }
}

@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://helo-spring.dev");
        return networkClient;
    }
}

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

당연하게도 url 정보를 세팅하기전에 객체를 생성했기 떄문에 url은 null이 나타나게 된다

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

스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료된다.

따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야한다.

 

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

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

 

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

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

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

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

 

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

생성자는 필수 정보(파라미터)를 받고, 메모리를 할당해서 객체를 생성하는 책임을 가진다.

반면에 초기화는 이렇게 생성된 값들을 활용한 외부 커넥션을 연결하는등 무거운 동작을 수행한다.

따라서 생성자 안에서 무거운 초기화 작업을 하는 것 보다는 객체를 생성하는 부분과 초기화 하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋다. 물론 초기화 작업이 내부 값들만 약간 변경하는 정도로 단순한 경우에는 생성자에서 한번에 다 처리하는게 더 나을 수 있다.

 

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

- 인터페이스

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

- @PostConstruct, @PreDestroy (보통 이걸 사용함)

 

인터페이스

public class NetworkClient implements InitializingBean, DisposableBean {

    @Override //생성 후 실행하는 콜백 메서드
    public void afterPropertiesSet() throws Exception {
        System.out.println("NetworkClient.afterPropertiesSet");
        connect();
        call("초기화 연결 메시지");
    }

    @Override //종료시 실행하는 콜백 메서드
    public void destroy() throws Exception {
        System.out.println("NetworkClient.destroy");
        disconnect();
    }

//    NetworkClient.afterPropertiesSet
//    connect: http://helo-spring.dev
//    call: http://helo-spring.dev message = 초기화 연결 메시지
//    close: http://helo-spring.dev

단점

- 스프링 전용 인터페이스이기 때문에 해당 코드가 스프링 전용 인터페이스에 의존한다.

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

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

 

>> 초기에 나온 방법이라 잘 사용 안함

 

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

public class NetworkClient {

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

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

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

//        connect: http://helo-spring.dev
//        call: http://helo-spring.dev message = 초기화 연결 메시지
//        NetworkClient.close
//        close: http://helo-spring.dev

장점

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

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

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

 

라이브러리는 대부분 close, shutdown이라는 이름의 종료메서드를 사용한다.

@Bean의 destoryMethod의 디폴트값은 (inffered) 추론

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

추론기능 자체를 사용하지 않으려면 destroyMethod = "" 처럼 공백으로 지정하면 된다.

 

애노테이션 @PostConstruct, @PreDestroy -> 보통 이거를 사용함

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

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

javax.annotation -> 자바 기본 패키지

지정하고자 하는 메서드에 애노테이션만 붙여주면 초기화, 종료 콜백 메서드를 호출할 수 있다.

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

유일한 단점은 외부라이브러리에는 적용하지 못하기 때문에

외부 라이브러리를 초기화, 종료해야하면 @Bean 기능을 사용하자

보통 이걸 많이 쓰니 이걸 꼭 기억하자!