8. 빈 생명주기 콜백

jinhxxxxkim·2023년 2월 6일
Spring빈 생명주기스프링콜백
0

Spring핵심

목록 보기
8/9
post-thumbnail

8. 빈 생명주기 콜백

1. 빈 생명주기 콜백 - 빈 생명주기 콜백 시작

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

객체의 초기화와 객체의 생성은 다르다!

예제 코드

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("NetworkClient.connect: " + url);
    }

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

    //서비스 종료 시 호출
    public void disconnect(){
        System.out.println("NetworkClient.disconnect: " + url);
    }
}
  • 외부 네트워크에 미리 연결하는 클래스다.
  • 간단히 구현하기 위해 문자만 출력한다.
  • NetworkClient는 애플리케이션 시작 시점에 connect()를 호출해서 연결을 맺어두어야 하고, 애플리케이션이 종료되면 disconnect() 를 호출해서 연결을 끊어야 한다.

Configuration

@Configuration
static class LifeCycleConfig{
	@Bean
    public NetworkClient networkClient(){
    	NetworkClient networkClient = new NetworkClient();
        networkClient.setUrl("http://hello-spring.dev");
        return networkClient;
	}
}
  • NetworkClient를 스프링 빈으로 등록한다.
  • NetworkClient 인스턴스를 생성하고, setter를 통해 URL을 설정한다.

Test

@Test
void lifeCycleTest(){
	ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
	NetworkClient client = ac.getBean(NetworkClient.class);
    ac.close();
}
  • close()라는 메소드는 ApplicationContext에는 없으므로, 하위 인터페이스인 ConfigurableApplicationContext를 이용한다.
  • 설정정보로 LifeCycleConfig를 전달하고, 빈을 조회한다.
  • 모든 처리가 끝나면, close()를 통해 어플리케이션의 연결을 종료한다.

출력

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

스프링 빈의 라이프사이클

객체 생성 →\to 의존관계 주입

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

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

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

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

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

객체의 생성과 초기화의 분리

  • 생성자: 필수 정보(파라미터)를 받고, 메모리를 할당해서 객체를 생성하는 책임
  • 초기화: 생성된 값들을 활용해서 외부 커넥션을 연결하는등 무거운 동작을 수행

따라서 생성자 안에서 무거운 초기화 작업을 함께 하는 것 보다는 객체를 생성하는 부분과 초기화 하는부분을 명확하게 나누는 것이 유지보수 관점에서 좋다.

물론 초기화 작업이 내부 값들만 약간 변경하는 정도로 단순한 경우에는 생성자에서 한번에 다 처리하는게 더 나을 수 있다.

콜백 지원 방법

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

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

빈 생명주기 콜백 - 인터페이스 InitializingBean, DisposableBean

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

예제 코드

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();
    }
}
  • afterPropertiesSet()메소드는 외부 커넥션을 연결하고, 메시지를 전송하도록 구현한다.
  • destroy()메소드는 외부 커넥션을 끊도록 disconnect() 메소드를 호출하도록 구현한다.

출력

생성자 호출, url = null
NetworkClient.afterPropertiesSet
NetworkClient.connect: http://hello-spring.dev
call: http://hello-spring.dev message: 초기화 연결 메시지
19:58:17.888 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@d5b810e, started on Mon Feb 06 19:58:17 KST 2023
NetworkClient.destroy
NetworkClient.disconnect: http://hello-spring.dev
  • 생성자 호출 시 url은 null이다.
  • 스프링 빈의 생성과 의존관계 주입이 완료되고 나면, afterPropertiesSet()메소드 호출을 통해 초기화를 한다.
  • 어플리케이션이 종료될 때 destroy()메소드가 호출되는 것을 확인할 수 있다.

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

  • 이 인터페이스는 스프링 전용 인터페이스다. 해당 코드가 스프링 전용 인터페이스에 의존한다.
  • 초기화, 소멸 메서드의 이름을 변경할 수 없다.
  • 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.
    • 만일 외부 라이브러리가 인터페이스를 구현하지 않는다면 내가 직접 초기화 및 소멸시킬 수 없다 라고 이해하였다.

인터페이스를 사용하는 초기화, 종료 방법은 스프링 초창기에 나온 방법들이고, 지금은 다음의 더 나은 방법들이 있어서 거의 사용하지 않는다.

빈 생명주기 콜백 - 빈 등록 초기화, 소멸 메서드 지정

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

예제 코드

NetworkClient 클래스

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

    public void close() {
        System.out.println("NetworkClient.destroy");
        disconnect();
    }
}
  • 초기화 메소드인 init()를 선언한다.
  • 종료 메소드인 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(initMethod = "init", destroyMethod = "close")를 통해 초기화, 소멸 메소드를 전달한다.

출력

생성자 호출, url = null
NetworkClient.afterPropertiesSet
NetworkClient.connect: http://hello-spring.dev
call: http://hello-spring.dev message: 초기화 연결 메시지
19:58:17.888 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@d5b810e, started on Mon Feb 06 19:58:17 KST 2023
NetworkClient.destroy
NetworkClient.disconnect: http://hello-spring.dev

설정 정보 사용 특징

  • 메서드 이름을 자유롭게 줄 수 있다.
  • 스프링 빈이 스프링 코드에 의존하지 않는다.
    • 스프링의 인터페이스를 구현하는 등의 의존이 필요하지 않다.
  • 코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다.
    • 외부 라이브러리가 만들어둔 초기화, 소멸 메소드를 아고만 있다면, 설정정보의 수정을 통해 초기화, 소멸을 진행할 수 있다.

종료 메소드 추론

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

빈 생명주기 콜백 - @PostConstruct, @PreDestroy 어노테이션

예제 코드

NetworkClient 클래스

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

    @PreDestroy
    public void close() {
        System.out.println("NetworkClient.close");
        disconnect();
    }
}
  • 초기화 메소드에는 @PostConstructor어노테이션을, 소멸 메소드에는 @PreDestroy어노테이션을 추가한다.

출력

생성자 호출, url = null
NetworkClient.afterPropertiesSet
NetworkClient.connect: http://hello-spring.dev
call: http://hello-spring.dev message: 초기화 연결 메시지
19:58:17.888 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@d5b810e, started on Mon Feb 06 19:58:17 KST 2023
NetworkClient.destroy
NetworkClient.disconnect: http://hello-spring.dev
  • @PostConstruct , @PreDestroy 이 두 애노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다.

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

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

출처: 인프런 스프링 핵심 원리 - 기본편 (김영한)
인프런 스프링 핵심 원리

profile
jinhxxxxkim
.
이전 포스트

7. 의존관계 자동 주입

다음 포스트

9. 빈 스코프

0개의 댓글