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

본 내용은 온라인 강의 사이트 인프런의 김영한 님의 강의 내용이 포함되어 있습니다.
'스프링 핵심 원리 - 기본편'

스프링 핵심 원리 - 기본편 - 인프런 | 강의

 

스프링 빈 생명주기 콜백

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

 

스프링 빈 생명주기 콜백은 스프링 빈이 생성된 이후 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 호출하여 초기화나 종료 시점을 알려주는 등의 기능을 제공한다.

 

스프링 빈의 라이프사이클 : 객체 생성 → 의존관계 주입 (생성자 주입은 예외)

• 스프링 빈은 객체를 생성하고, 의존관계 주입 이후 데이터를 사용할 수 있다.
• 의존관계 주입 후 콜백 메서드를 통해 초기화 시점, 종료 시점 등을 알 수 있다.

 

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

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

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

 

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

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

스프링에서는 @PostConstruct, @PreDestory 방식을 권장하고 있다.

 

참고로 객체의 생성과 초기화는 분리하는 것이 좋다.

• 생성자는 파라미터를 받고, 메모리를 할당하여 객체를 생성하는 책임을 가진다.
• 반면에 초기화는 생성된 값을 활용하여 외부 커넥션을 연결하는 등의 동작을 수행한다.
• 따라서, 생성자 안에서 초기화 작업을 함께 하는 것보다 객체를 생성하는 부분과 초기화하는 부분을 명확하게 나누는 것이 유지보수 측면에 유리하다.
• 하지만, 초기화 작업이 내부 값들만 약간 변경하는 정도로 단순할 경우에는 생성자에서 한 번에 처리하는 것이 좋을 때도 있다.

 

InitializingBean, DisposableBean 인터페이스

InitializingBean 인터페이스

• afterPropertiesSet() 메서드를 통해 빈이 생성되고, 의존관계 주입이 완료된 후 호출된다.

DisposableBean 인터페이스

• destory() 메서드를 통해 스프링이 종료되기 직전에 호출된다.

 

다음 코드는 외부 네트워크에 미리 연결하는 객체를 생성한다고 가정하여 단순 문자를 출력하는 예제 코드이다.

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

    @Override
    public void destroy() throws Exception {
                System.out.println("NetworkClient.destroy");
        disconnect();
    }
}

 

테스트 코드

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 = null
NetworkClient.afterPropertiesSet
connect: <http://hello-spring.dev>
call: <http://hello-spring.dev> message = 초기화 연결 메시지
01:48:58.212 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@13fd2ccd, started on Sun Oct 23 01:48:57 KST 2022
NetworkClient.destroy
close: <http://hello-spring.dev>

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

• 스프링 전용 인터페이스로 해당 코드가 스프링 전용 인터페이스에 의존한다.
• 초기화, 소멸 메서드의 이름을 변경할 수 없다.
• 직접 코드를 수정할 수 없는 외부 라이브러리에 적용할 수 없다.
• 스프링 초창기에 나온 방법으로 지금은 거의 사용하지 않는다.

 

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

설정 정보에 @Bean(initMethod = “init”, destroyMethod = “close”) 등과 같이 초기화, 소멸 메서드를 지정할 수 있다.

설정 정보 사용 방법의 특징

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

 

예제 코드

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

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

 

테스트 코드

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

// 출력
생성자 호출, url = null
NetworkClient.init
connect: <http://hello-spring.dev>
call: <http://hello-spring.dev> message = 초기화 연결 메시지
02:03:50.891 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@13fd2ccd, started on Sun Oct 23 02:03:50 KST 2022
NetworkClient.close
close: <http://hello-spring.dev>

종료 메서드(destroyMethod)의 추론(inferred)

• @Bean의 destroyMethod 속성에는 특별한 기능이 있다.
• 라이브러리는 대부분 close, shutdown이라는 이름의 종료 메서드를 사용한다.
• 하지만 @Bean의 destroyMethod는 기본값이 (inferred)으로 등록되어 있다.
• 추론(inferred) 기능은 close, shutdown이라는 이름의 메서드를 자동으로 추론해서 호출한다.
• 따라서 직접 스프링 빈으로 등록하면 종료 메서드는 따로 적어주지 않아도 잘 동작하게 된다.
• 추론 기능을 사용하지 않으려면 destroyMethod="”으로 빈 공백을 지정하면 된다.

 

@PostConstruct, @PreDestory 어노테이션 사용

@PostConstruct, @PreDestory 두 가지 어노테이션을 사용하여 편리하게 초기화와 종료를 실행할 수 있다.

 

@PostConstruct, @PreDestory 어노테이션의 특징

• 스프링에서 현재 권장하고 있는 방법이다.
• 어노테이션을 붙이는 것으로 편리하게 사용할 수 있다.
• 스프링에 종속적인 기술이 아닌 JSR-250 자바 표준으로 스프링이 아닌 다른 컨테이너에서도 동작한다.
• 컴포넌트 스캔과 유연하게 사용할 수 있다.
• 단점으로는 외부 라이브러리에는 적용하지 못하여 이때는 @Bean의 기능을 사용해야 한다.

 

예제 코드

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

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

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

 

테스트 코드

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 = null
NetworkClient.init
connect: <http://hello-spring.dev>
call: <http://hello-spring.dev> message = 초기화 연결 메시지
02:18:32.337 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@4659191b, started on Sun Oct 23 02:18:32 KST 2022
NetworkClient.close
close: <http://hello-spring.dev>