@PostConstruct, @PreDestroy로 빈 생명주기 관리하기

데이터베이스 커넥션 풀이나, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고, 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화와 종료 작업이 필요합니다. 이번 포스팅은, 스프링을 통해 이러한 초기화 작업과 종료 작업을 @PostConstruct와 @PreDestroy를 통해서 구현하는 방법에 대해 작성하였습니다.

---

스프링 빈은 간단하게 아래와 같은 라이프 사이클을 가집니다.

 

객체 생성 → 의존관계 주입

즉, 스프링 빈은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료됩니다. 따라서, 초기화 작업은 의존관계 주입이 모두 완료되고 난 후 호출해야 합니다. 개발자가 의존관계 주입이 완료된 시점을 알아야 이렇게 작업을 할 수 있는데, 이를 위해 스프링은 2가지의 콜백 메서드를 통해 그 시점을 알려줍니다.

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

즉, @PostConstruct를 사용하면 스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주고, @PreDestroy를 사용하면 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 주어 안전하게 종료 작업을 진행할 수 있습니다.

 

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

---

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

---

 

아래 코드를 통해 확인해 보겠습니다.

 

NetWorkService 빈을 생성하기 위해 NetWorkService 클래스 내부에 빈 초기화 및 소멸을 관리하기 위해 @PostConstruct, @PreDestroy를 초기화 및 소멸 전 콜백 함수 위에 작성하였습니다.

---

class NetWorkService {
        private String initValue;

        public NetWorkService() {
            System.out.println("생성자 호출, initValue = " + initValue);
        }

        public void setInitValue(String initValue) {
            this.initValue = initValue;
        }

        public void connect() {
            System.out.println("connect: " + initValue);
        }

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

        //서비스 종료시 호출
        public void disConnect() {
            System.out.println("close + " + initValue);
        }

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

        @PreDestroy
        public void close() {
            System.out.println("Bean.close");
            disConnect();
        }
  }

---

 

그 후, 빈을 생성하는 configuration 클래스를 아래와 같이 작성하였습니다.

---

@Configuration
class LifeCycleConfig{
      @Bean
      public NetWorkService netWorkService(){
          NetWorkService netWorkService = new NetWorkService();
          netWorkService.setInitValue("Hello");
          return netWorkService;
      }
 }

---

 

이 코드들을 테스트 코드 안에 생성하여 테스트 코드로 작성하였습니다. 즉, 전체 코드는 아래와 같습니다.

---

public class BeanInitDestroyTest {
    @Test
    public void lifeCycleTest() {
        ConfigurableApplicationContext ac = new
                AnnotationConfigApplicationContext(LifeCycleConfig.class);
        NetWorkService service = ac.getBean(NetWorkService.class);
        ac.close(); //스프링 컨테이너를 종료, ConfigurableApplicationContext 필요
    }
    static class NetWorkService {
        private String initValue;

        public NetWorkService() {
            System.out.println("생성자 호출, initValue = " + initValue);
        }

        public void setInitValue(String initValue) {
            this.initValue = initValue;
        }

        public void connect() {
            System.out.println("connect: " + initValue);
        }

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

        //서비스 종료시 호출
        public void disConnect() {
            System.out.println("close + " + initValue);
        }

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

        @PreDestroy
        public void close() {
            System.out.println("Bean.close");
            disConnect();
        }
    }
    @Configuration
    static class LifeCycleConfig{
        @Bean
        public NetWorkService netWorkService(){
            NetWorkService netWorkService = new NetWorkService();
            netWorkService.setInitValue("Hello");
            return netWorkService;
        }
    }
}

---

[출력 결과]

생성자 호출, initValue = null
Bean.init
connect: Hello
call: Hello message = 초기화 연결 메시지
Bean.close
close + Hello

 

---

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

 

---

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

• 해당 애너테이션이 속한 패키지는 javax.annotation.*입니다. 즉, 스프링에 종속적인 기술이 아니라 JSR-250라는 자바 표준이다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작합니다.
• 최신 스프링에서 가장 권장하는 방법으로, 애너테이션 하나만 붙이면 되므로 매우 편리합니다.
• 단점은, 외부 라이브러리에는 적용하지 못한다는 것입니다. 외부 라이브러리를 초기화, 종료해야 하면 @Bean의 initMethod, destroyMethod를 사용해야 합니다.

---

@Bean의 initMethod, destroyMethod

설정 정보에 @Bean(initMethod = "init", destroyMethod = "close") 로 설정할 수 있습니다.

---

public class BeanInitDestroyTest {
    @Test
    public void lifeCycleTest() {
        ConfigurableApplicationContext ac = new
                AnnotationConfigApplicationContext(LifeCycleConfig.class);
        NetWorkService service = ac.getBean(NetWorkService.class);
        ac.close(); //스프링 컨테이너를 종료, ConfigurableApplicationContext 필요
    }
    static class NetWorkService {
        private String initValue;

        public NetWorkService() {
            System.out.println("생성자 호출, initValue = " + initValue);
        }

        public void setInitValue(String initValue) {
            this.initValue = initValue;
        }

        public void connect() {
            System.out.println("connect: " + initValue);
        }

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

        //서비스 종료시 호출
        public void disConnect() {
            System.out.println("close + " + initValue);
        }

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

      
        public void close() {
            System.out.println("Bean.close");
            disConnect();
        }
    }
    
    @Configuration
    static class LifeCycleConfig{
        @Bean(initMethod = "init", destroyMethod = "close")
        public NetWorkService netWorkService(){
            NetWorkService netWorkService = new NetWorkService();
            netWorkService.setInitValue("Hello");
            return netWorkService;
        }
    }
}

---

출력 결과는 @PostConstruct, @PreDestroy와 같습니다. 

여기서 종료 메서드(@Bean의 destroyMethod 속성)에 특별한 성질이 있습니다.

• 라이브러리는 대부분 ` close` , ` shutdown`이라는 이름의 종료 메서드를 사용합니다. 
• @Bean의 destroyMethod는 기본값이 (inferred) - 추론으로 등록되어 있습니다. 이 추론 기능은 close, shutdown이라는 이름의 메서드를 자동으로 호출해 줍니다. 즉, 이름 그대로 종료 메서드를 추론해서 호출해 줍니다. 
• 따라서, 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작합니다.
• 만약, 추론 기능을 사용하기 싫으면 (destroy 메서드가 없을 때) destroyMethod=" "처럼 빈 공백으로 지정하면 됩니다.

---

참고: 싱글톤 빈들은 스프링 컨테이너가 종료될 때 싱글톤 빈들도 함께 종료되기 때문에 스프링 컨테이너가 종료되기 직전에 소멸 전 콜백이 일어납니다.  싱글톤처럼 컨테이너의 시작과 종료까지 생존하는 빈 도 있지만, 생명주기가 짧은 빈들도 있는데 (프로토타입 빈 등) 이 빈들은 컨테이너와 무관하게 해당 빈이 종료되기 직전에 소멸 전 콜백이 일어납니다.

---

[전체 소스코드]

GitHub - eunhwa99/SpringBlog

 

 

[참고자료]

김영한, "스프링 핵심 원리 - 기본편", 인프런