[Spring] 빈 생명주기 콜백

이 글은 김영한 님의 스프링 핵심 원리 - 기본편을 수강하며 정리한 글입니다.

 

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

 

---

 

😧 초기화 작업이 의존 관계 주입과 함께 호출되었을 때의 문제점

  간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정해 보자.

애플리케이션 시작 시점에 connect()를 호출해서 연결을 맺어 두어야 하고, 애플리케이션이 종료되면 disConnect()를 호출해서 연결을 끊어야 한다.

    @Test
    public void lifeCycleTest() {
    	// ApplicationContext에는 close를 제공해 주지 않는다
        // AnnotationConfigApplicationContext 혹은 ConfigurableApplicationContext 인터페이스 사용
        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;
        }
    }

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

1. LifeCycleConfig가 스프링 컨테이너에 등록되면서 생성자가 호출된다.
2. 객체를 모두 생성 후 Setter를 통해 url를 넣어 주었다. - 객체를 생성한 다음에 설정이 들어온 상황

생성자 호출과 데이터 사용이 함께 이뤄지고 있다.

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

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

 

---

 

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

싱글톤

 

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

 

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

위에서 말하는 의존관계 주입은 수정자 주입 혹은 필드 주입이다. 생성자 주입의 경우에는 스프링 빈이 생성될 때 의존관계 주입이 일어난다.

 

🐬 객체의 생성과 초기화를 분리하자 - 단일 책임 원칙

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

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

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

 

---

 

빈 생명주기 콜백을 지원하는 3가지 방법

 

1️⃣ 인터페이스 InitializingBean, DisposableBean

public class NetworkClient implements InitializingBean, DisposableBean {

    // ...
    
    @Override
    public void afterPropertiesSet() throws Exception { // 의존관계 주입이 끝나면 호출
        connect();
        call("초기화 연결 메시지");
    }

    @Override
    public void destroy() throws Exception { // 소멸
        disConnect();
    }
}

1. 스프링 전용 인터페이스다. 해당 코드가 스프링 전용 인터페이스에 의존한다.
2. 초기화, 소멸 메서드의 이름을 변경할 수 없다.
3. 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.

 

2️⃣ 빈 등록 초기화, 소멸 메서드

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

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

@Configuration
static class LifeCycleConfig {

    // destroyMethod: default는 close, shutdown라는 이름의 메서드를 자동으로 호출
    @Bean(initMethod = "init", destroyMethod = "close")
    public NetworkClient networkClient() {
        NetworkClient networkClient = new NetworkClient();
        networkClient.setUrl("http://hello-spring.dev");
        return networkClient;
    }
}

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

3️⃣ 애노테이션: @PostConstruct, @PreDestroy

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

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

1. 최신 스프링에서 가장 권장하는 방법
2. 스프링에 종속적인 기술이 아니라 JSR-250라는 자바 표준이다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작한다.
3. 컴포넌트 스캔과 잘 어울린다. (@Bean으로 등록하지 않기 때문에)
4. 유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다. (코드 수정이 필요하다)
   외부 라이브러리를 초기화, 종료해야 하면 @Bean의 기능을 사용하자. (initMethod, destroyMethod)