빈 생명주기 콜백

현시기얌·2022년 3월 4일
0

Spring 핵심원리

목록 보기
13/15

빈 생명주기 콜백

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

예제 코드 (외부 네트워크와 미리 연결하는 객체)

@Setter
public class NetworkClient {

    private String url;

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

    // 서비스 시작시 호출
    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);
    }

}

@Configuration
static class LifeCycleConfig{

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

}

@Test
void lifeCycleTest() {
    ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
    final NetworkClient client = ac.getBean(NetworkClient.class);
    ac.close();
}

실행 결과

생성자 호출, url = null
connect: null
call: null message = 초기화 연결 메시지
  • 생성자 부분을 보면 url 정보 없이 connect가 호출되는 것을 확인할 수 있다.
  • 객체를 생성하는 단계에는 url이 없고 객체를 생성한 다음에외부에서 수정자 주입을 통해서 setUrl()이 호출되어야 url이 존재하게 된다.

스프링 빈 라이프 사이클

  • 스프링 빈은 객체를 생성하고 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료된다.
  • 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다.
  • 그런데 개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까?
    • 스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메소드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공한다.
    • 도한 스프링은 스프링 컨테이너가 종료되기 직전에 소멸콜백을 준다.
    • 따라서 안전하게 종료 작업을 진행할 수 있다.

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

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

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

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

스프링이 제공하는 빈 생명주기 콜백 방법

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

인터페이스(InitializingBean, DisposableBean)

@Setter
public class NetworkClient implements InitializingBean, DisposableBean {

    private String url;

    public NetworkClient() {
        System.out.println("생성자 호출, 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();
    }
}

public class BeanLifeCycleTest {

    @Configuration
    static class LifeCycleConfig{

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

    }

    @Test
    void lifeCycleTest() {
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        final NetworkClient client = ac.getBean(NetworkClient.class);
        ac.close();
    }
}

실행 결과

connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
20:48:16.055 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@1de5f259, started on Fri Mar 04 20:48:15 KST 2022
close http://hello-spring.dev
  • 출력 결과를 보면 초기화 메소드가 주입 완료 후에 적절하게 호출 된 것을 확인할 수 있다.
  • 그리고 스프링 컨테이너의 종료가 호출되자마자 소멸 메소드가 호출 된 것도 확인할 수 있다.

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

  • 이 인터페이슨느 스프링 전용 인터페이스다.
  • 해당 코드가 스프링 전용 인터페이스에 의존하게 된다.
  • 초기화, 소멸 메소드의 이름을 변경할 수 없다.
  • 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.

cf) 거의 사용하지 않는다.

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

  • 설정 정보에 
@Bean(initMethod = "init", destroyMethod = "close")

처럼 초기화, 소멸 메소드를 지정할 수 있다.

@Setter
public class NetworkClient {

    private String url;

    public NetworkClient() {
        System.out.println("생성자 호출, 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() {
        connect();
        call("초기화 연결 메시지지");
    }

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

public class BeanLifeCycleTest {

    @Configuration
    static class LifeCycleConfig{

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

    }

    @Test
    void lifeCycleTest() {
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        final NetworkClient client = ac.getBean(NetworkClient.class);
        ac.close();
    }
}

실행 결과

생성자 호출, url = null
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지지
20:57:54.971 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@1de5f259, started on Fri Mar 04 20:57:54 KST 2022
close http://hello-spring.dev

설정 정보 사용 특징

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

종료 메소드 추론

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

애노테이션 @PostConstruct, @PreDestroy

@Setter
public class NetworkClient {

    private String url;

    public NetworkClient() {
        System.out.println("생성자 호출, 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: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지지
21:05:06.583 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@6404f418, started on Fri Mar 04 21:05:05 KST 2022
close http://hello-spring.dev

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

  • 스프링에서 가장 권장하는 방법이다.
  • 애노테이션 하나만 붙이면 되므로 매우 편리하다.
  • 패키지를 보면 javax.annotation.PostConstruct이다. 스프링에 종속적인 기술이 아니라 자바 표준이다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작한다.
  • 컴포넌트 스캔과 잘 어울린다.
  • 단점 : 외부 라이브러리에는 적용하지 못한다. 외부 라이브러리의 초기화, 종료를 해야 하면 @Bean의 기능을 사용해야 한다.

정리

  • @PostConstruct, @PreDestroy 애노테이션을 사용하자.
  • 코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료 해야 한다면 @Bean의 initMehotd, destroyMethod를 사용하자.
profile
현시기얌
현시깁니다
이전 포스트

@Autowired 필드명, @Quilifier , @Primary

다음 포스트

빈 스코프

0개의 댓글