[Spring] 스프링 빈 생명주기와 콜백

kdkdhoho·2022년 2월 27일

목록 보기

12/26

이 글은 인프런 - 스프링 핵심 원리 기본편을 보고 공부한 것을 정리한 글입니다.

1. 빈 생명주기 콜백 시작

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

이 초기화와 종료 작업을 어떻게 진행하는지 알아보자

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

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

public class BeanLifeCycleTest {

    @Test
    void lifeCycleTest() {
        AnnotationConfigApplicationContext 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 = null
connect: null
call: null message = 초기화 연결 메시지

당연하지만, url을 set 해주기 전에 생성자에서 출력하면 올바른 정보가 나오지 않는다.

스프링 빈은 간단히 객체 생성 -> 의존관계 주입의 라이프 사이클을 가진다.

스프링 빈은 객체를 생성하고, 의존관계 주입이 끝난 이후에야 필요한 데이터를 사용할 수 있는 준비가 완료된다.
따라서 초기화 작업은 의존관계 주입이 끝나고 난 뒤에야 호출해야 한다.
그럼 의존관계 주입이 끝나는 시점은 어떻게 알 수 있을까?

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

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

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

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

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

참고
객체의 생성과 초기화를 분리하자
이 말은 즉슨, 객체의 필수 정보는 생성자에 파라미터로 하여금 객체를 생성하고,
그 후 외부 커넥션을 연결하는 등의 무거운 동작의 초기화는 따로 빼어 구분하는 것이 유지보수 관점에서 좋다.

참고
싱글톤 빈들은 스프링 컨테이너가 종료될 때 모두 종료한다.
때문에 스프링 컨테이너가 종료되기 전에 소멸전 콜백이 호출된다.

인터페이스(IntitalizingBean, DisposableBean)

public class NetworkClient implements InitializingBean, DisposableBean {

    private String url;

    public NetworkClient() {
        System.out.println("생성자 호출, url = " + url);
    }

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

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

    // 서비스 시작 시 호출
    public void connect() {
        System.out.println("connect: " + url);
    }

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

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

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

생성자 호출, url = null
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
19:29:39.654 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@61001b64, started on Sun Feb 27 19:29:39 KST 2022
close http://hello-spring.dev

InitializingBean, DisposableBean 인터페이스를 구현해준다.
각 인터페이스에는 afterPropertiesSet()과 destory()가 있다. 각 메서드는 주입이 끝난 후, 소멸전 콜백이 호출되었을 때 호출된다.

인터페이스 방법은 단점이 있다.

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

이 방법은 초기에 나온 방법이며, 지금은 잘 사용하지 않는다.

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

@Bean(initMethod = "init", destroyMethod = "close")
public NetworkClient networkClient() {
     NetworkClient networkClient = new NetworkClient();
     networkClient.setUrl("http://hello-spring.dev");

     return networkClient;
}

 // 의존관계 주입 후 호출
public void init() throws Exception {
    connect();
    call("초기화 연결 메시지");
}

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

위에서 Bean으로 등록할 때, 설정 정보를 적어준다.

이 방법의 특징으로

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

여기서 destroyMethod는 default가 (inferred)(추론)이다.
이 추론 기능은, close나 shutdown 라는 이름의 메서드를 자동으로 호출해준다.
따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작한다.
추론 기능을 사용하기 싫다면 destoryMethod="" 처럼 공백으로 지정하면 된다.

(중요)어노테이션 @PostConstruct, @PreDestory

// 의존관계 주입 후 호출
@PostConstruct
public void init() throws Exception {
	connect();
	call("초기화 연결 메시지");
}

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