[스프링 기본 원리] 빈 생명주기 콜백

 

초기화 및 종료 전 메소드 호출

데이터베이스 커넥션 풀(네트워크 전 미리 연결해두기)이나, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 해두고, 애플리케이션 종료 시점(DB 미리 연결 끊기 등)에 연결을 모두 종료하는 작업을 진행한다.

public class BeanLifeCycleTest {

    @Test
    public void lifeCycleTest() {
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        NetworkClient client = ac.getBean(NetworkClient.class);
        ac.close(); // ApplicationContext가 미제공
    }

    @Configuration
    static class LifeCycleConfig {
        @Bean
        public NetworkClient networkClient() {
            NetworkClient networkClient = new NetworkClient();
            networkClient.setUrl("<http://hello-spring.dev>");
            return networkClient;
        }
    }
}

• AnnotationConfigApplicationContext 를 바꾸거나 ConfigurableApplicationContext 로 바꾸기
  • ApplicationContext - ConfigurableApplicationContext - AnnotationConfigApplicationContext (하위)

• ApplicationContext 는 close()를 제공하지 않고 하위까지 내려가야 함

package hello.core.lifecycle;

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

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

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

 

실행 결과 > 객체 생성 후 외부에서 수정자 주입을 하기 때문에 null

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

• 이와 같이 외부에서 값을 세팅 후 초기화 진행해야할 경우가 많음
• 스프링 빈 라이프사이클 객체 생성 → 의존관계 주입 (생성자 주입은 예외)

 

• 스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려주는 기능 제공
• (싱글톤의 경우) 스프링 컨테이너가 종료되기 직전에 소멸 콜백 기능

 

[싱글톤] 스프링 빈의 이벤트 라이프사이클

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

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

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

따라서 객체를 생성하고 메모리에 등록하는 작업과 의존관계를 주입한 뒤, 커낵션을 연결하는 등의 객체의 동작인 초기화작업은 따로 분리. 즉, 생성자 안에서는 객체 내부에 값을 세팅하는 정도만 작업하고 이외에 무거운 수행 동작은 메소드를 분리하라!

 

• 객체 생성과 초기화를 분리했을 때의 장점 : 연결만 생성해두고 초기화 동작을 지연 > 실제 요청이 들어오면 초기화 진행할 수도 있음

참고: 싱글톤 빈들은 스프링 컨테이너가 종료될 때 싱글톤 빈들도 함께 종료되기 때문에 스프링 컨테이너가 종료되기 직전에 소멸전 콜백이 일어난다. 뒤에서 설명하겠지만 싱글톤 처럼 컨테이너의 시작과 종료까지 생존하는 빈도 있지만, 생명주기가 짧은 빈들도 있는데 이 빈들은 컨테이너와 무관하게 해당 빈이 종료되기 직전에 소멸전 콜백이 일어난다. 자세한 내용은 스코프에서 알아보겠다.

 

스프링 빈 생명주기 콜백 3가지 방법 

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

하나씩 알아보자.

---

1. 인터페이스 InitializingBean, DisposableBean

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

- InitializingBean

싱글톤 빈이라 컨테이너 올라올 때 빈이 생성이 되고 의존관계 주입이 다 끝나고 나면 호출이 됨

- DisposableBean

싱글톤 빈들이 죽을 때

 

생성자 호출 url = null
connect = <http://hello-spring.dev>
call = <http://hello-spring.dev> message = 초기화 연결 메시지
21:05:44.655 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@4dbb42b7, started on Thu Oct 27 21:05:44 KST 2022
close = <http://hello-spring.dev>

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

• 이 인터페이스는 스프링 전용 인터페이스다. 해당 코드가 스프링 전용 인터페이스에 의존한다.
• 초기화, 소멸 메서드의 이름을 변경할 수 없다.
• 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.
  • class 파일로 컴파일된 것을 받아서 maven이나 gradle로
• 초창기에 나온 방법들이라 지금은 잘 사용하지 않는다.

---

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

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

---

3. 애노테이션 @PostConstruct, @PreDestroy

import javax.annotation.PostConstruct;	//javax 로 시작하면 자바 진영에서 공식적으로 지원함
import javax.annotation.PreDestroy;

public class NetworkClient {
		@PostConstruct
    public void init() {
        //의존 관계 주입이 끝나면
        System.out.println("NetworkClient.init");
        connect();
        call("초기화 연결 메시지");
    }

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

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

 

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

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

정리

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

스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술을 수강하며 기록한 글입니다.