[기본] #8 빈 생명주기 콜백

본 포스팅은 인프런 - 스프링 핵심 원리(기본편)을 강의를 바탕으로 공부하고 정리한 글입니다.

 

빈 생명주기 콜백

모든 객체는 생명주기가 존재한다.

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

 

스프링에서 제공하는 초기화와 종료 작업을 간단한 예제로 알아보자.

 

👉🏻 예제 코드

📁 test/lifecycle/NetworkClient

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);
    }
}

• NetworkClient는 애플리케이션 시작 시점에 connect()를 호출해 연결을 맺고, 애플리케이션이 종료되면 disconnect()를 호출해 연결을 끊는다.

👉🏻 실행 테스트

📁 test/lifecycle/BeanLifeCycle

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

• 객체 생성 후에 수정자(setter)를 통해 url을 넣어주도록 설계되었다.
• 실행 결과를 보면 url값이 들어오기도 전에 객체 생성 후 connect(), call()까지 호출된 것을 확인할 수 있다.

스프링 빈은 객체 생성 → 의존관계 주입 순서로 라이프사이클을 가지므로, 객체 생성 및 의존관계 주입이 끝난 후에 초기화 작업(connect, call)이 이뤄지도록 해야한다.

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

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

 

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

• 스프링 컨테이너 생성 → 스프링 빈 생성 → 의존관계 주입 → 초기화 콜백 → 사용 → 소멸전 콜백 → 스프링 종료
  • 초기화 콜백 : 빈이 생성되고, 빈의 의존관계 주입이 완료된 후 호출
  • 소멸전 콜백 : 빈이 소멸되기 직전에 호출

 

 

빈 생명주기 콜백 방법

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

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

 

인터페이스 (InitializingBean, DisposableBean)

• InitializingBean : afterPropertiesSet() 메소드로 초기화를 지원한다.
• DisposableBean : destroy() 메소드로 소멸을 지원한다

📁 test/lifecycle/NetworkClient

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 {
        System.out.println("NetworkClient.afterPropertiesSet");
        connect();
        call("초기화 연결 메세지");
    }

    // 빈 소멸 직전 호출
    @Override
    public void destroy() throws Exception {
        System.out.println("NetworkClient.destroy");
        disconnect();
    }
}

• 출력 결과 초기화 메소드가 의존관계 주입 후에 호출된 것을 확인할 수 있다.
• 또한 스프링 컨테이너의 종료가 호출되자 소멸 메소드가 호출된 것을 확인 할 수 있다.

 

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

• InitializingBean, DisposableBean 인터페이스는 스프링 전용 인터페이스로, 해당 코드가 스프링 전용 인터페이스에 의존하게 된다.
• 초기화, 소멸 메소드의 이름을 변경할 수 없다.
• 코드를 고칠 수 없는 외부 라이브러리에 적용할 수없다.
• 인터페이스를 사용하는 초기화, 종료 방법은 스프링 초창기에 나온 방법들로, 지금은 거의 사용하지 않는다.

 

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

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

👉🏻 초기화, 소멸 메소드 생성

📁 test/lifecycle/NetworkClient

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();
    }
}

• init(), close() 메소드를 만들어준다.

👉 설정 정보에 초기화, 소멸 메소드 지정

📁 test/lifecycle/BeanLifeCycleTest

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(initMethod = "init", destroyMethod = "close")
        public NetworkClient networkClient() {
            NetworkClient networkClient = new NetworkClient();
            networkClient.setUrl("http://hello-spring.dev");
            return networkClient;
        }
    }
}

• @Bean 등록시 초기화 콜백, 소멸전 콜백을 지정해준다.

 

💡 destroyMethod의 추론 기능

• destroyMethod는 기본값으로 (inferred)(=추론)으로 등록되어 있다.
• 따라서 설정하지 않아도 close, shutdown라는 이름의 종료 메소드가 있으면 찾아서 자동으로 호출해준다.
• 추론 기능을 사용하기 싫다면 destroyMetod=""처럼 빈 공백을 지정해주면 된다.

 

💡 설정정보 사용 장점

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

 

⭐️ 애노테이션 (@PostConstruct, @PreDestroy)

• @PostConstruct : 초기화 지원
• @PreDestroy : 종료 지원

📁 test/lifecycle/NetworkClient

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() {
        System.out.println("NetworkClient.init");
        connect();
        call("초기화 연결 메세지");
    }

    // 빈 소멸 직전 호출
    @PreDestroy
    public void close(){
        System.out.println("NetworkClient.close");
        disconnect();
    }
}

📁 test/lifecycle/BeanLifeCycleTest

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

 

💡 애노테이션 사용 특징

• 최신 스프링에서 가장 권장하는 방법이다.
• javax.annotation. 패키지에 있는 자바표준이다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작한다.
• 컴포넌트 스캔과 잘 어울린다.
• 단점은 외부 라이브 러리에 적용하지 못한다는 점이다. 외부 라이브러리를 초기화, 종료 해야한다면 이전의 설정 정보 방식을 사용하자.

 

💡 정리

• @PostConstruct, @PreDestroy 애노테이션을 사용하자!
• 코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료 해야 한다면 @Bean의 initMethod, destroyMethod를 사용하자