빈 생명주기 콜백

빈 생명주기 콜백 시작

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

 

미리 외부 네트워크와 연결하는 테스트: 애플리케이션 시작 시점에 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(){
        // BeanFactory > ApplicationContext > ConfigurableApplicationContext > AnnotationConfigApplicationContext
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(lifeCycleConfig.class);
        NetworkClient bean = 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이 없고, 객체를 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl이 호출되기 때문
• 스프링 빈은 간단하게 객체 생성 -> 의존관계 주입 의 라이프사이클을 가진다.(생성자 주입은 같이 일어난다.)

 

• 스프링 빈은 객체를 생성하고, 의존관계 주입이 끝난 다음에 필요한 데이터를 사용할 수 있는 준비가 완료된다. 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다.
• 초기화 작업이란 객체 안에 필요한 값이 모두 들어가 있는 경우, 처음 일을 시작하는 경우

 

💡 개발자가 의존관계 주입이 완료된 시점을 어떻게 알 수 있을까?

 

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

 

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

1. 스프링 컨테이너 생성
2. 스프링 빈 생성(생성자는 여기서 의존관계 주입)
3. 의존관계 주입(수정자, 필드)
4. 초기화 콜백 "의존관계 주입 끝났어~"
5. 사용
6. 소멸전 콜백
7. 스프링 종료

• 초기화 콜백: 빈이 생성되고, 빈의 의존관계 주입이 완료된 후 호출
• 소멸전 콜백: 빈이 소멸되기 직전에 호출
• 스프링은 다양한 방식의 생명주기 콜백을 지원한다.

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

단일책임원칙(SRP): 그냥 생성(메모리 할당)되는 것에 집중. 초기화는 동작

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

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

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

 

1. 인터페이스 InitializingBean, DisposableBean

public class NetworkClient implements InitializingBean, DisposableBean {

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

// DisposableBean
    @Override
    public void destroy() throws Exception {
        // 삭제 전
        disconnect();
    }
}

✔️ 초기화, 소멸 인터페이스의 단점

• 스프링 전용 인터페이스다. 해당 코드가 스프링 전용 인터페이스에 의존한다.
• 초기화, 소멸 메서드의 이름을 변경할 수 없다.
• 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.
• 스프링 초창기에 나온 방법으로 거의 사용되지 않는다.

 

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

빈 등록 시 @Bean(initMethod = "{초기화 메서드명}", destroyMethod = "{소멸 메서드명}")

public class BeanLifeCycleTest {

    @Configuration
    static class lifeCycleConfig{

        @Bean(initMethod = "init", destroyMethod = "close")
        public NetworkClient networkClient(){
            NetworkClient networkClient = new NetworkClient();
            // 외부에서 값 세팅 후 초기화가 진행되어야 한다.
            networkClient.setUrl("http://hello-spring.dev");
            return networkClient;
        }
    }
}

package hello.core.lifecycle;

public class NetworkClient {

    public void init() throws Exception {
        // 의존관계 주입이 끝나면 호출
        connect();
        call("초기화 연결 메시지");
    }

    public void close() throws Exception {
        System.out.println("NetworkClient.destroy");
        // 삭제 전
        disconnect();
    }
}

✔️ 장점

• 메서드 이름을 자유롭게 사용할 수 있음
• 스프링 빈이 스프링 코드에 의존하지 않는다.
• 코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다.

🐤 종료 메서드 추론

• @Bean의 destroyMethod 속성에는 아주 특별한 기능이 있다.
• 라이브러리는 대부분 close, shutdown이라는 이름의 종료 메서드를 사용한다.
• @Bean의 destroyMethod는 기본값이 "(inferred)"(추론)으로 등록되어 있다.
• 이 추론 기능은 close, shutdown이라는 이름의 메서드를 자동으로 호출해준다. 이름 그대로 종료 메서드를 추론해 호출해준다.
• 따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다.
• 추론 기능을 사용하기 싫으면 destroyMethod=""처럼 공백을 주면 된다.

 

3. 애노테이션 @PostConstruct, @PreDestory

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

public class NetworkClient {

    @PostConstruct
    public void init() throws Exception {
        // 의존관계 주입이 끝나면 호출
        connect();
        call("초기화 연결 메시지");
    }

    @PreDestroy
    public void close() throws Exception {
        System.out.println("NetworkClient.destroy");
        // 삭제 전
        disconnect();
    }
}

javax는 자바에서 공식적으로 지원하는 것이다.

 

✔️ 특징

• 최신 스프링에서 권장하는 방법
• 애노테이션 하나만 붙이면 된다.
• javax로 스프링 종속적인 기술이 아니라 자바 인터페이스의 모음이다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작한다.
• 컴포넌트 스캔과 잘 어울린다?
• 유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다. 외부 라이브러리 초기화, 종료 해야하면 @Bean 기능을 사용하자.

 

✔️ 정리

• @PostConstruct, @PreDestroy 애노테이션을 사용하자.
• 코드를 고칠 수 없는 외부 라이브러리는 @Bean을 사용하자.