빈 생명주기 콜백

땡글이·2023년 1월 16일
빈빈 생명주기 콜백스프링스프링부트
0

Spring Framework

목록 보기
3/8

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

데이터베이스 커넥션 풀(DBPC : Database Connection Pool)이란 ?
웹 컨테이너(WAS)가 실행되면서 DB와 미리 connection(연결)을 해놓은 객체들을 pool에 저장해두었다가, 클라이언트 요청이 오면 connection을 빌려주고, 처리가 끝나면 다시 connection을 반납받아 pool에 저장하는 방식을 말합니다.

스프링에서 객체의 초기화와 종료 작업 방식에 대해 알아보자. 예시로 아래의 네트워크 클라이언트 객체와 테스트 코드를 참고해보자.

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

위의 테스트 코드를 실행하면, 아래와 같이 url이 설정되지 않은 상황에서 동작해서 의도치 않은 오류(url이 null)를 만들어냈다.

  • url이 설정된 뒤에, connect() 함수가 수행되어야 한다.
생성자 호출, url = null
connect: null
call: null message = 초기화 연결 메시지

스프링 빈은 간단하게 다음과 같은 라이프사이클을 가진다.
객체 생성 ⇒ 의존관계 주입

  • 생성자 주입은 예외이다. 생성자 주입은 객체가 생성되면서 의존관계가 주입 된다.
  • 위의 라이프사이클은 setter 주입, 메서드 주입, 필드 주입에 해당한다.

따라서, 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다. 그런데 개발자가 의존관계 주입이 모두 완료된 시점을 어떻게 알 수 있을까?

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

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

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

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

그럼 여기서 생기는 궁금증은 "생성자에서 의존관계 주입이나 필드 설정까지 다 마무리하는 게 좋은거 아닌가?" 이다.

답변은 "그렇지 않다" 이다. 객체의 생성과 초기화를 분리하는 것이 좋다.(초기화에서 무거운 작업을 수행할 시)

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

빈 생명주기 콜백

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

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

하나하나씩 알아보도록 하자.

인터페이스 (InitializingBean, DisposableBean)

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() 메서드로 초기화를 지원한다.
    • 의존관계 주입 끝나고, afterPropertiesSet() 메서드가 호출
  • DisposableBean 은 destroy() 메서드로 소멸을 지원한다.

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

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

해당 방법은 2003년에 나온 방법들로 최근에는 사용하지 않는다.

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

앞서 작성한 NetworkClient 클래스에서 implements InitializingBean, DisposableBean 뺀다. 그리고 빈 등록한 설정 클래스(LifeCycleConfig)에서 @Bean 대신 @Bean(initMethod = "init", destroyMethod = "close") 라고 달아준다.

  • initMethod는 초기화 메서드를 지정
  • destroyMethod 는 종료 메서드 지정
    @Configuration
    static class LifeCycleConfig {
    
    	@Bean (initMethod="init", destoryMethod="close")
        public NetworkClient networkClient() {
        	NetworkClient networkClient = new NetworkClient();
            networkClient.setUrl("http://hello-spring.dev");
            return networkClient;
		} 
        
    }

NetworkClient 클래스에서 init 함수와 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();
	}
    
}
생성자 호출, url = null
NetworkClient.init
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
13:33:10.029 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing NetworkClient.close
close + http://hello-spring.dev

위와 같은 출력문이 나오게 된다. 확인해보면, 생성자에선 url이 당연히 null이었고, setUrl 함수가 동작하고 난 뒤, 초기화 작업이 수행된 것을 확인할 수 있다. 그리고 마지막에는, 스프링 컨테이너를 종료시키면서 등록된 빈도 종료 메서드를 통해 소멸되는 것을 확인할 수 있다.

설정 정보 사용 특징

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

종료 메서드 추론

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

어노테이션 @PostConstruct, @PreDestroy

@PostConstruct , @PreDestroy 이 두 애노테이션을 사용하면 가장 편리하게 초기화와 종료를 실행할 수 있다. 어노테이션 이름 또한 굉장히 직관적이라 이해하기도 쉽다.

public class NetworkClient {
    
    ...
    
    @PostConstruct
	public void init() { 
    	System.out.println("NetworkClient.init"); 
        connect();
		call("초기화 연결 메시지");
	}
    
    @PreDestroy
    public void close() {
        System.out.println("NetworkClient.close");
        disConnect();
	}
    
}
	
    ...
	
    @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;
		} 
        
    }
    
    ...
생성자 호출, url = null
NetworkClient.init
connect: http://hello-spring.dev
call: http://hello-spring.dev message = 초기화 연결 메시지
13:33:10.029 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing NetworkClient.close
close + http://hello-spring.dev

어노테이션을 이용한 방법도 앞서 본 출력문과 같이 나오는 것을 확인할 수 있다.

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

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

Reference

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard
https://linked2ev.github.io/spring/2019/08/14/Spring-3-%EC%BB%A4%EB%84%A5%EC%85%98-%ED%92%80%EC%9D%B4%EB%9E%80/

profile
땡글이
꾸벅 🙇‍♂️ 매일매일 한발씩 나아가자잇!
이전 포스트

의존관계 자동 주입

다음 포스트

빈 스코프

0개의 댓글