빈 생명주기 콜백, 빈 생명주기 콜백 - 시작, InitializingBean/DisposableBean, 빈 등록 초기화/소멸 메서드 지정, @PostConstruct/@PreDestory

  출처 : 인프런 - 스프링 핵심원리 - 기본편(유료) / 김영한님  
  유료 강의이므로 정리에 초점을 두고 코드는 일부만 인용  

https://inf.run/kCYMv

---

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

1) 빈 생명주기 콜백

• 스프링 빈이 생성되거나 종료 직전에 빈의 메서드를 호출하는 기능(객체의 초기화와 종료 작업)
• 데이터 베이스 커넥션 풀이나 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고, 애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면 객체의 초기화 종료 작업이 필요함

(1) NetworkClient

• test 하위에 lifecycle이라는 패키지를 생성하여 작성
• 간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정하여 테스트 코드를 작성
• 실제로 네트워크에 연결하는 것은 아니며 단순히 문자만 출력하며 NetworkClient는 애플리케이션 시작 시점에 connect()를 호출해서 연결을 맺어두고 애플리케이션이 종료되면 disConnect()를 호출해서 연결을 종료해야 함

package hello.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 call(String message) {
        System.out.println("call: " + url + " message= " + message);
    }

    public void setUrl(String url) {
        this.url = url;
    }

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

 

(2) BeanLifeCycleTest - 스프링 환경설정 및 실행

• LifeCycleConfig 설정 클래스를 스프링 빈으로 등록하고 등록된 스프링빈을 꺼낸 후 스프링 컨테이너를 종료

public class BeanLifeCycleTest {

    @Test
    public void lifeCycleTest() {
        // close 메서드를 호출하려면 참조변수가 ConfigurableApplicationContext(상위 타입) 타입이거나
        //                              AnnotationConfigApplicationContext 타입이여야 함
        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;
        }
    }
}

 

(3) 실행 결과

• 실행해보면 아래와같은 결과가 나오는데 생성자 부분을 보면 url정보 없이 connect가 호출되고 있음
• 당연한 이야기이지만 객체를 생성하는 단계에는 url이 없고 객체를 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl()이 호출되어야 url이 존재하게 됨

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

2) 스프링 빈의 라이프 사이클

(1) 객체 생성 -> 의존관계 주입

• 스프링 빈은 객체를 생성하고 의존관계 주입이 다 끝난 다음에 필요한 데이터를 사용할 수 있는 준비가 완료 됨
• 그렇기 때문에 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야함
• 스프링은 의존관계 주입이 완료 되면 스프링 빈에게 콜백 메서드를 통해 초기화 시점을 알려주는 다양한 기능을 제공함
• 스프링은 스프링 컨테이너가 종료되기 직전에 소멸 콜백(싱글톤)을 주어 안전하게 종료 작업을 진행할 수 있음

(2) 스프링 빈의 이벤트 라이프사이클(싱글톤)

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

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

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

 

** 참고1 - 객체의 생성과 초기화를 분리하는 것이 좋음

• 생성자는 필수 정보(파라미터)를 받고 메모리를 할당해서 객체를 생성하는 책임을 가짐
• 초기화는 생성된 값들을 활용해서 외부 커넥션을 연결하는등의 무거운 동작을 수행함
• 생성자안에서 무거운 초기화 작업을 하는 것보다 객체를 생성부분과 초기화 부분을 명확하게 나누는 것이 유지보수 관점에서 좋음
• 초기화 작업이 내부 값들만 약간 변경하는 정도로 단순한 경우에는 생성자에서 한번에 처리하는 것이 나을 수 있음
• 객체를 생성만 해놓고 지연시켜놓다가 요청이 들어왔을 때 호출이 되도록 하는 등의 유연한 설계도 가능

** 참고2 - 소멸전 콜백

• 싱글톤 빈 : 스프링 컨테이너가 종료될 때 함께 종료되어 스프링컨테이너가 종료되기 직전에 소멸전 콜백이 일어남
• 생명주기가 짧은 빈들 : 컨테이너와 무관하게 해당 빈이 종료되기 직전에 소멸전 콜백이 일어남(빈 스코프에서 자세히 다룸)

---

2. 인터페이스 InitializingBean, DisposableBean

1) 인터페이스 사용

(1) NetworkClient에 인터페이스 구현

• 기본 생성자에서 
• InitializingBean : afterPropertiesSet() 메서드로 초기화를 지원
• DisposableBean : destroy() 메서드로 소멸을 지원

package hello.core.lifecycle;

public class NetworkClient implements InitializingBean, DisposableBean {

    public NetworkClient() {
        System.out.println("생성자 호출, url= " + url);	// 기본생성자에서 초기화코드를 분리
    }
    
    // 기존 코드 동일
    
    @Override
    public void afterPropertiesSet() throws Exception {
        connect();
        call("초기화 연결 메시지");
    }

    @Override
    public void destroy() throws Exception {
        disconnect();
    }
}

 

(2) 적용 후 BeanLifeCycleTest 실행

• 출력 결과를 보면 의존관계 주입 완료 후에 초기화 메서드가 적절하게 호출되고 스프링 컨테이너의 종료되자 소멸 메서드가 호출 되는 것을 확인할 수 있음

생성자 호출, url = null
NetworkClient.afterPropertiesSet
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메세지
14:44:49.018 [Test worker] DEBUG o.s.c.a.AnnotationConfigApplicationContext -- ...
NetworkClient.destroy
close: http://hello-spring.dev

 

(3) InitializingBean, DisposableBean 인터페이스의 단점

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

** 참고

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

---

3. 빈 등록 초기화, 소멸 메서드 지정

1) 설정 정보에 지정

(1) NetworkClient 수정

• 초기화하는 init메서드와 소멸하는 close메서드를 생성

package hello.core.lifecycle;

public class NetworkClient {
    
    // ... 기존 코드 동일

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

    public void close() {
        System.out.println("NetworkClient.close");
        disconnect();
    }
}

 

(2) BeanLifeCycleTest 수정

• 설정정보에 @Bean(initMethod = "초기화메서드이름", destryoMethod = "종료메서드이름") 처럼 초기화, 소멸 메서드를 지정

package hello.core.lifecycle;

public class BeanLifeCycleTest {
    
    // test 코드 동일
    
    @Configuration
    static class LifeCycleConfig {
		
        // @Bean 설정 정보에 초기화 및 소멸 메서드를 지정
        @Bean(initMethod = "init", destroyMethod = "close")
        public NetworkClient networkClient() {
            // NetworkClient() 생성 메서드 동일
        }
    }
}

 

(3) 출력 결과

• init메서드와 close메서드의 결과가 정상적으로 출력된 것을 확인할 수 있음

생성자 호출, url= null
NetworkClient.init
connect: http://hello-spring.dev
call: http://hello-spring.dev message= 초기화 연결 메시지
20:16:31.628 [Test worker] DEBUG o.s.c.a.AnnotationConfigApplicationContext --
                Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@3fb6cf60, started on Mon Nov 11 20:16:31 KST 2024
NetworkClient.close
close: http://hello-spring.dev

 

(4) 설정 정보 사용 특징

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

(5) 종료 메서드 추론

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

---

4. 애노테이션 @PostConstruct, @PreDestory

1) 애노테이션 활용

(1) NetworkClient 수정

• init()메서드와 close()메서드에 각각 @PostConstruct, @PreDestroy 애노테이션을 적용

package hello.core.lifecycle;

public class NetworkClient {

    // 기존 코드 동일
    
    @PostConstruct
    public void init() {
        System.out.println("NetworkClient.init");
        connect();
        call("초기화 연결 메시지");
    }

    @PreDestroy
    public void close() {
        System.out.println("NetworkClient.close");
        disconnect();
    }
}

 

(2) BeanLifeCycleTest 수정 후 실행

• @Bean설정을 원상태로 복구시키고 실행하면 메서드에 적용한 애노테이션이 동작하여 초기화 및 종료 메서드가 정상적으로 동작함
• @PostConstruct, @PreDestroy 두 애노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있음

package hello.core.lifecycle;

public class BeanLifeCycleTest {
    
    // Test코드 동일
    
    @Configuration
    static class LifeCycleConfig {

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

 

(3) @PostConstruct, @PreDestroy 애노테이션 특징

• 최신 스프링에서 가장 권장하는 방법으로 애노테이션 하나만 붙이면 되어서 매우 편리함
• 스프링에 종속적인 기술이 아니라 JSR-250 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 동작함
• 컴포넌트 스캔과 잘 어울림
• 유일한 단점은 외부 라이브러리에 적용할 수 없음

(4) 정리

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