hoon's bLog

Spring gradle project 스프링 핵심 원리 기본편 | Java Bean Lifecycle and Callback 생명 주기 콜백 본문

IT/Spring

Spring gradle project 스프링 핵심 원리 기본편 | Java Bean Lifecycle and Callback 생명 주기 콜백

개발한기발자 2024. 6. 11. 14:04
반응형


본 포스팅은 인프런에 있는 인터넷 강좌인,

김영한 강사님의 스프링 핵심 원리 기본편을 공부하며,

개인적으로 공부하고, 정리하는 용도로 포스팅을 해보겠다.

 

Spring gradle project 환경설정 및 회원 가입 서비스 예제 만들기
Spring gradle project 주문/할인 도메인 설계

Spring gradle project 객체 지향 원리 적용

Spring gradle project AppConfig 리팩토링 OCP 위반 해결 및 중복 제거

Spring gradle project 좋은 객체 지향 설계 5가지 원칙 적용 및 스프링 전환

Spring gradle project 스프링 컨테이너와 스프링 빈

Spring gradle project BeanFactory, ApplicationContext 이해 및 차이

Spring gradle project XML 설정 사용, BeanDefinition, 스프링 빈 설정 메타 정보

Spring gradle project 웹 애플리케이션과 싱글톤, WebApplication and Singleton

Spring gradle project 싱글톤 컨테이너, @Configuration

Spring gradle project 컴포넌트 스캔 의존관계, @Autowired, @ComponentScan

빈 생명주기 콜백 시작

이번 포스팅에서는 스프링을 통해, 이러한 초기화 작업과 종료 작업을 어떻게 진행하는지 예제로 알아보자.

데이터베이스 Connection Pool이나, 네트워크 소켓처럼, 애플리케이션 시작 시점에 필요한 연결을 미리 해두고,

애플리케이션 종료 시점에 연결을 모두 종료하는 작업을 진행하려면, 객체의 초기화와 종료 작업이 필요하다.

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

실제로 네트워크에 연결하는 것은 아니 고, 단순히 문자만 출력하도록 했다.

아래 NetworkClient는 애플리케이션 시작 시점에 connect()를 호출해서 연결을 맺어두어야 하고,

애플리케이션이 종료되면 `disConnect()` 를 호출해서 연결을 끊어야 한다.

테스트 하위에 생성한 예제코드

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

Spring 환경설정과 실행

import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
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://hello-spring.dev");
            return networkClient;
        }
    }
}
  • Spring 애플리케이션 컨텍스트를 생성하고 LifeCycleConfig 설정 클래스를 로드하여 NetworkClient Bean을 등록하고 초기화
  • NetworkClient Bean의 초기화와 소멸 과정을 확인하기 위해 ac.close()로 컨테이너를 종료하여 소멸 Callback을 실행

실행 결과는 다음과 같다.

생성자 호출, url = null
connect: null
call: null message = 초기화 연결 메시지
  • url 정보 없이 connect가 호출되는 것을 확인할 수 있다
  • 객체를 생성하는 단계에는 url이 없고, 객체를 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl()이 호출되어야 url이 존재!

SpringBean의 Lifecycle

  • 스프링 컨테이너 생성  스프링 빈 생성 → 의존관계 주입  초기화 콜백   사용  소멸 전 콜백  스프링 종료
  • 초기화 콜백 : 빈이 생성되고, 빈의 의존관계 주입이 완료된 후 호출
  • 소멸전 콜백 : 빈이 소멸되기 직전에 호출
  • SpringBean은 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료
  • 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다!
  • Spring은 의존관계 주입이 완료되면 Spring Bean에게 콜백 메서드를 통해서 초기화 시점을 알려주는 다양한 기능을 제공한다.
  • 또한 Spring은 Spring Container가 종료되기 직전에 소멸 콜백을 주면서, 안전하게 종료 작업을 진행할 수 있다.

객체의 생성과 초기화 분리

  • 생성자는 필수 정보(파라미터)를 받고, 메모리를 할당해서 객체를 생성하는 책임을 가진다.
  • 반면에 초기화는 이렇게 생성된 값들을 활용해서 외부 커넥션을 연결하는 등 무거운 동작을 수행한다.
  • 따라서 생성자 안에서 무거운 초기화 작업을 함께 하는 것보다는 객체를 생성하는 부분과 초기화하는 부분을 명확하게 나누는 것이 유지보수 관점에서 좋다. (초기화 작업이 내부 값들만 약간 변경하는 정도로 단순한 경우)
  • 싱글톤 빈들은 스프링 컨테이너가 종료될 때 싱글톤 빈들도 함께 종료되기 때문에 스프링 컨테이너가 종료되기 직전에 소멸 전 콜백이 일어난다.

Spring의 빈 생명주기 콜백 지원 3가지

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

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

// 결과
// 생성자 호출, url = null
// NetworkClient.afterPropertiesSet
// connect: http://hello-spring.dev
// call: http://hello-spring.dev message = 초기화 연결 메시지
// 13:48:49.043 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing NetworkClient.destroy
// close + http://hello-spring.dev
  • InitializingBean은 afterPropertiesSet() 메서드로 초기화를 지원한다.
  • DisposableBean은 destroy() 메서드로 소멸을 지원한다.
  • 출력 결과를 보면 초기화 메서드가 주입 완료 후에 적절하게 호출된 것을 확인할 수 있다.
  • 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출 된 것도 확인할 수 있다.

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

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

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

위의 예제 코드에 초기화와 소멸 메서드를 추가한다.

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

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

스프링 환경설정 예제를 아래와 같이 수정한다.

@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 = 초기화 연결 메시지
// 13:58:47.215 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing NetworkClient.close
// close + http://hello-spring.dev

설정 정보 사용 특징

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

@PostConstruct, @PreDestroy

package hello.core.lifecycle;

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

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();
    }
}
@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 = 초기화 연결 메시지
// 13:58:47.215 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing NetworkClient.close
// close + http://hello-spring.dev
  • @PostConstruct, @PreDestroy 애노테이션은 최신 스프링에서 가장 권장하는 방법이다.
  • 가장 편리한 방법으로 초기화와 종료를 실행할 수 있다.
  • 패키지를 잘 보면 javax.annotation.PostConstruct이다.
    (스프링에 종속적인 기술이 아니라 JSR-250라는 자바 표준이다. 따라서 스프링이 아닌 다른 컨테이너에서도 동작한다.)
  • 컴포넌트 스캔과 잘 어울린다.
  • 유일한 단점은 외부 라이브러리에는 적용하지 못한다는 것이다. 외부 라이브러리를 초기화, 종료해야 하면 @Bean의 기능을 사용하자.

이제 거의 끝이 보인다.

인강을 다 듣는다고 다 알아지는 게 아니니, 계속해서 반복 또 반복, 실행하는 수밖에 없다.

그간 실무 코드에서 적용하지 못하고, 잘 알지 못했던 부분을 인강과 개인 공부를 통해서나마, 좀 더 깊게 알아가야겠다.

 

끝.

728x90
반응형