개발/Spring Core

Spring 핵심원리 빈 생명주기 콜백

Debin 2021. 12. 31.
반응형
본 게시글은 인프런 김영한 선생님 강의 스프링 핵심 원리를 완강하고 배운 것을 남기고자 적은 포스팅입니다.

 

강의 링크는 아래와 같습니다.

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

 

스프링 핵심 원리 - 기본편 - 인프런 | 강의

스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., 스프링 핵심 원리를 이해하고, 성장하는 개발자가 되어보세요! 📢 수강 전

www.inflearn.com

 

DB 커넥션 풀, 네트워크 소켓처럼 애플리케이션 시작 지점에 필요한 연결을 미리 해두고, 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화와 종료 작업이 필요하다. 이번에는 스프링을 통해 이런 초기화 작업과 종료 작업에 대해 알아보겠다.

 

간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정한다. NetworkClient는 애플리케이션 시작 시점에 connect()를 호출해 연결을 맺고, 애플리케이션이 종료하면 disconnect()를 호출해서 연결을 끊어야한다. 아래 코드로 확인해보자.

 

package spring.core.lifecycle;

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 setUrl(String url) {
        this.url = 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 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("https://hello.spring.dev");
            return networkClient;
        }
    }
}

 

 실행하면 출력 결과는 다음과 같다.

 

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

 

생성자 부분을 보면 url 정보 없이 connect가 호출되는 것을 확인할 수 있다.

당연하지만 객체를 생성하는 단계에서 url이 없고, 객체를 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl()이 호출되어야 url이 존재하게 된다.

 

우선 스프링 빈은 간단하게 객체 생성 -> 의존관계 주입이라는 라이프 사이클을 가진다.

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

따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 후에 호출해야 한다. 그런데 개발자가 어떻게 의존관계 주입이 완료된 시점을 바로 파악할 수 있을까?

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

 

스프링 빈의 이벤트 라이프사이클은 아래와 같다.

 

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

 

생성자는 필수 파라미터를 받고, 메모리를 할당해서 객체를 생성하는 책임을 지닌다.

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

따라서 생성자 부분과 초기화 부분을 나누는 것이 유지보수 관점에서 좋다. 물론 아주 단순한 경우에만 생성자에서 처리하는 경우가 나을 수도 있다. 결론은 초기화 작업 파트와 생성자는 구분하자!!!!

 

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

 

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

 

먼저 인터페이스 (InitializingBean, DisposableBean)부터 알아보자.

 

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 { //이 메서드로 초기화 지원
     connect();
     call("초기화 연결 메시지");
   }
   @Override
   public void destroy() throws Exception { //이 메서드로 소멸을 지원
     disConnect();
   }
}

 

이렇게 수정한 후 위에 테스트 코드를 다시 실행시키면 출력결과는 아래처럼 잘 나온다.

 

생성자 호출, url = null
NetworkClient.afterPropertiesSet
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
13:24:49.043 [main] DEBUG
org.springframework.context.annotation.AnnotationConfigApplicationContext -
Closing NetworkClient.destroy
close + http://hello-spring.dev

//초기화 메서드도 주입 완료에 적절하게 호출되었고,
//소멸자도 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출 된 것을 확인할 수 있다.

 

이 코드의 단점에 대해 알아보자. 우선 코드가 스프링 전용 인터페이스에 의존하게 된다. 또한 오버라이딩하므로 초기화, 소멸 메서드의 이름을 변경할 수 없고, 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다. 따라서 이 방법은 현재 잘 쓰지 않는다.

 

다음은 빈 등록 초기화 소멸 메서드 지정이다.

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

코드로 확인해보자.

 

//설정 정보를 사용할 수 있게 클래스를 변경한다.

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

 

이제 우리 설정 정보에 초기화 소멸 메서드를 지정한다.

 

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

 

마지막 애노테이션 @PostConstruct와 @PreDestroy다.

코드는 아래와 같다. 정말 단순하다.

 

public class NetworkClient {
    private String url;

    public NetworkClient() {
        System.out.println("생성차 호출, url = " + url);
        
    }
    //서비스 시작 시 호출
    public void connect(){
        System.out.println("connect = " + url);
    }
    public void setUrl(String url) {
        this.url = 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();
    }
}

 

정말 애노테이션만 추가했다. 이러고 최상단 테스트 코드를 돌리면 테스트가 통과한다. 가장 편리한 방법!!!

이 방법은 자동 의존 주입에서도 사용할 수 있다.

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

 

결론은 @PostConstruct, @PreDestroy를 사용하자.

코드 못 고치는 외부 라이브러리를 사용할 경우에는 초기화 소멸 메서드 지정 방법을 사용!!!

 

 

이상입니다. 감사합니다.

반응형

댓글