Spring - 빈 생명주기 콜백

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

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

 

Spring은 크게 3가지 빈 생명주기(Bean LifeCycle) 콜백을 지원합니다

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

---

 

 

1. 인터페이스(InitializingBean, DisposableBean)

먼저 인터페이스를 사용하는 방법을 알아보겠습니다.

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() 메서드를 구현해 줍니다.

해당 메서드는 빈이 종료될 때 자동으로 호출된다.

 

그러므로 그 타이밍에 해야 하는 일들을 해당 메서드들에 작성해 주면 됩니다.

 

package hello.core.lifecycle;

import org.junit.jupiter.api.Test;
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(); //스프링 컨테이너를 종료, ConfigurableApplicationContext 필요
    }

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

 

위와 같은 테스트 코드를 실행해 보면 정상적으로 실행되는 것을 확인할 수 있습니다.

인터페이스(InitializingBean, DisposableBean)를 사용하는 방법은 단점이 존재합니다.

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

사실 해당 방법은 스프링 초창기 때 나온 방법이며, 현재는 잘 사용하지 않는다고 합니다.

---

 

2. 설정 정보에 초기화 메서드, 종료 메서드 지정

위의 코드에서 implements 부분을 제거해 주고 구현했던 메서드들도 살짝 바꿔줍니다.

package hello.core.lifecycle;

public class NetworkClient {

	...
    
    // afterPropertiesSet() -> init() Bean에서 해주는 설정만 통일하면 다른 이름으로 해도 됨.
    public void init() {
        connect();
        call("초기화 연결 메시지");
    }

	// destroy() -> close() 마찬가지.
    public void close() {
        disconnect();
    }
}

 

다음으로는 @Bean에 옵션을 추가해 줍니다.

// 앞에서 생성한 메서드명을 사용하면 됩니다.
@Bean(initMethod = "init", destroyMethod = "close")

해당 옵션은 initMethod로 "init"이라는 이름을 가진 메서드를 사용하겠다는 뜻

마찬가지로 destroyMethod로 "close"라는 이름을 가진 메서드를 사용하겠다는 뜻

 

그리고 테스트를 실행해 보면 같은 결과를 볼 수 있습니다.

 

설정 정보 사용 특징

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

참고) destoryMethod
대부분의 라이브러리는 close, shutdown이라는 이름의 종료 메서드를 사용합니다
@Bean의 destroyMethod는 기본값으로 close, shutdown 이라는 이름을 가진 메서드를 자동으로 호출해 줍니다.
따라서 close() 또는 shutdown() 메서드를 만들었다면 직접 설정해주지 않아도 됩니다.
+ 종료메서드를 사용하고 싶지 않다면 destroyMethod = "" 이라고 하면 됩니다.

---

 

 

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

Spring에서 공식적으로 권장하는 방법입니다
애너테이션명 그대로 @PostConstruct는 생성이 된 이후에 동작하고 @PreDestroy는 소멸되기 이전에 동작한다

package hello.core.lifecycle;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

public class NetworkClient {

	...

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

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

 

그리고 @Bean에 붙였던 (initMethod = "init", destroyMethod = "close")는 필요 없으니 지워주자.

 

그리고 실행해 보면 마찬가지로 같은 결과를 얻을 수 있다.

 

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

• 최신 스프링에서 가장 권장하는 방법
• 애노테이션 하나만 붙이면 되므로 매우 편리함
• 패키지를 잘 보면 javax.annotation.PostConstruct 이다. 스프링에 종속적인 기술이 아니라 JSR-250 라는 자바 표준이다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작함
• 컴포넌트 스캔과 잘 어울림
• 유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다 (코드를 수정해야하기 때문)

 

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