[스프링 핵심원리 - 기본편] 빈 생명주기 콜백

빈 생명주기 콜백 시작

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

애플리케이션 시작 시점에 connect() 를 호출해서 연결을 맺고, 애플리케이션이 종료되면 disConnect() 를 호출해서 연결을 끊는 NetworkClient 예제를 살펴보자

//Networkclient.java

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

//BeanLifeCycleTest.java

package hello.core.lifecycle;

import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

public class BeanLifeCycleTest {

    @Test
    public 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("<http://hello-spring.dev>");
            return networkClient;
        }
    }
}

생성자 부분을 보면 url 정보 없이 connect가 호출되는 것을 확인할 수 있다. 객체를 생성하는 단계에는 url이 없고, 객체 생성 이후에 setUrl() 이 호출되어 url이 입력 된다.

 

스프링 빈은 간단하게 다음과 같은 라이프사이클을 가진다.

객체 생성 → 의존관계 주입

그러므로 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야한다.

 

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

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

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

객체를 생성하는 부분과 초기화 하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋다.

 

스프링의 빈 생명주기 콜백 방법

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

 

 

인터페이스 InitializingBean, DisposableBean

//Networkclient.java

package hello.core.lifecycle;

import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;

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

• InitializingBean 은 afterPropertiesSet() 메서드로 초기화를 지원한다.
• DisposableBean 은 destroy() 메서드로 소멸을 지원한다.

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

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

→ 거의 사용하지 않는다.

 

 

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

@Bean(initMethod = "초기화 메서드 이름", destroyMethod = "소멸 메서드 이름") 코드를 통해 초기화, 소멸 메서드를 지정할 수 있다.

//Networkclient.java

package hello.core.lifecycle;

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() {
        connect();
        call("초기화 연결 메시지");
    }

    public void close() {
        disconnect();
    }
}

//BeanLifeCycleTest.java

package hello.core.lifecycle;

import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

public class BeanLifeCycleTest {

    @Test
    public void lifeCycleTest() {
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        Networkclient client = ac.getBean(Networkclient.class);
        ac.close();

    }
    @Configuration
    static class LifeCycleConfig {
        @Bean(initMethod = "init", destroyMethod = "close")
        public Networkclient networkclient(){
            Networkclient networkClient = new Networkclient();
            networkClient.setUrl("<http://hello-spring.dev>");
            return networkClient;
        }
    }
}

특징

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

종료 메서드 추론

라이브러리는 대부분 ‘close’, ‘shutdown’이라는 이름의 종료 메서드를 사용한다.

@Bean의 ‘destroyedMethod’ 는 기본 값이 ‘inferred’로 등록되어 있는데, 이 추론 기능은 ‘close’, ‘shutdown’이라는 이름의 메서드를 자동으로 호출해준다.

따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 도착한다.

이 기능을 사용하기 싫을 경우 destroyedMethod=””와 같이 빈 공백을 지정하면 된다.

 

 

 

애노테이션 @PostConstruct, @PreDestroy

@PostConstruct , @PreDestroy 이 두 애노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다.

 //Networkclient.java
 
 @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 애노테이션을 사용하자

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