이 시리즈는 인프런 강의(김영한 님의 ‘스프링 핵심 원리 - 기본편’)로 공부하며 혼자 기록하고, 사람들과도 공유할 수 있도록 작성하는 글이다. 최대한 추가적인 정보는 공식 홈페이지, 문서를 보며 얻을 예정이다.
(개인적인 생각과 이해가 들어가 있기 때문에 저의 ‘무식함’이 있을 수 있습니다😜 혹시라도 이 글을 보게 되시는 분이 계시다면 잘못된 부분 댓글로 많이 알려주시면 너무 감사하겠습니다!!)
GitHub Repository : https://github.com/jcw1031/spring-core-study
빈 생명주기와 콜백
데이터베이스 커넥션 풀, 네트워크 소켓처럼 애플리케이션 시작 시점에 필요한 연결을 미리 설정하고, 애플리케이션 종료 시점에 모든 연결을 종료하는 작업을 진행하려면, 객체의 초기화 작업과 종료 작업이 필요하다.
스프링 빈이 생성된 직후나 죽기 직전에 빈 내부의 메서드를 호출해 주는 기능을 사용하여 구현할 수 있다. 간단한 내용이지만, 3가지 방식 각각의 특징을 통해 배울 수 있는 내용들이 있다.
InitalizingBean,DisposableBean인터페이스@Bean의initMethod,destroyMethod@PostConstruct,@PreDestroy애노테이션
우선 문제가 되는 예제 코드를 작성해 보자.
문제의 코드
test 패키지에 NetworkClient라는 임의의 객체를 하나 생성한다.
필드와 생성자, setter를 추가한다. 필드는 String 타입의 url, 생성자는 로그 출력, setter는 필드 값 설정.
그리고 서비스 시작 시에 호출되어야 하는 connect()와 call() 메서드를 추가한다.
서비스 종료 직전에 호출되어야 하는 disconnect() 메서드도 추가한다.
서비스 시작 시 호출되어야 하는 메서드들을 생성자에서 호출해 보자.
BeanLifeCycleTest 클래스를 생성하여 테스트 코드를 작성한다. 우선 임의의 설정 클래스를 내부 클래스로 만든다. NetworkClient 객체를 생성하고 setUrl() 메서드를 호출해 필드 값을 설정하고 이후에 스프링 빈으로 등록이 된다.
스프링 컨테이너를 생성하는데, 여기서 ConfigurableApplicationContext 인터페이스를 사용하였다. 이 인터페이스는 AnnotationConfigApplicationContext의 상위 인터페이스로, close() 메서드를 사용하기 위해 해당 인스턴스로 참조하도록 하였다.
테스트를 실행해 보면, url이 null이다. 왜냐하면 생성자에서 먼저 connect()와 call() 메서드가 호출되고 이후에 setUrl() 메서드로 url의 값을 설정했기 때문이다.
스프링 빈의 이벤트 라이프 사이클 🌀
스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해 초기화 시점을 알려준다. 또한 스프링 컨테이너가 종료되기 직전에 소멸 콜백을 통해 알려준다.(안전하게 종료 작업이 가능하다.)
스프링 컨테이너 -> 스프링 빈 생성 -> 의존관계 주입 -> 초기화 콜백 -> 사용 -> 소멸 전 콜백 -> 스프링 종료객체의 생성과 초기화를 분리하자!
생성자는 필수 정보(파라미터)를 받고, 메모리를 할당하여 객체를 생성하는 책임을 가진다. 반면 초기화는 생성된 값들을 활용해 외부 커넥션을 연결하는 등 무거운 동작을 수행한다. 따라서 생성자 안에서 무거운 작업을 함께 수행하는 것보다는 객체를 생성하는 부분과 초기화하는 부분을 명확하게 나누는 것이 유지 보수 관점에서 좋다. (경우에 따라 다르다.)
1️⃣ InitializingBean, DisposableBean 인터페이스
인터페이스들을 사용하는 방식은 스프링 초창기 방식이고, 지금은 훨씬 좋은 방법들이 있어서 거의 사용하지 않는 방식이다. 그래도 한 번 적용해 보도록 하자.
코드 ⌨️
NetworkClient가 InitializingBean 인터페이스의 afterPropertiesSet() 메서드를 오버라이딩하고, 이 메서드 내부에서 서비스 시작 시 호출되어야 하는 메서드를 호출한다. (생성자에서 호출하던 부분은 지운다.)
의존관계 주입이 끝난 후 호출
마찬가지로 DisposableBean 인터페이스의 destroy() 메서드를 오버라이딩하고, 서비스 종료 시 호출되어야 하는 메서드를 내부에 호출한다.
ac.close()호출 후 실행(소멸 전 실행)
테스트를 실행하면 잘 동작한다.
단점 👎
이 인터페이스들은 스프링 전용 인터페이스이기 때문에 해당 코드가 전부 스프링 전용 인터페이스에 의존하게 된다. 또한 초기화와 소멸 메서드의 이름을 변경할 수 없다. 그리고 코드를 수정할 수 없는 외부 라이브러리에는 적용할 수 없다.
2️⃣ @Bean의 initMethod, destroyMethod
구성 정보에서 @Bean 애노테이션에 설정이 가능하다. @Bena(initMethod = “메서드이름”, destroyMethod = “메서드이름”)
특징
메서드 이름이 자유롭게 설정이 가능하고, 스프링 빈(NetworkClient)이 스프링 코드에 의존하지 않는다. 코드가 아닌, 설정 정보를 사용하기 때문에 코드를 수정할 수 없는 외부 라이브러리에도 적용이 가능하다.
코드 ⌨️
NetworkClient에 init()과 close()라는 이름의 메서드를 추가한다. 이름은 마음대로 지어도 된다.
구성 정보인 LifeCycleConfig에서 initMethod와 destroyMethod를 사용해 각각 초기화 메서드와 소멸 메서드를 지정할 수 있다.
종료 메서드 추론 기능
@Bean의destroyMethod속성에는 ‘추론’이라는 특별한 기능이 존재한다. 라이브러리는 대부분close()나shutdown()이라는 이름의 종료 메서드를 사용한다.@Bean의destroyMethod의 기본값은 “(inferred)“(추론)로 등록되어 있다. 이 추론 기능은 종료 메서드를 추론하여close(),shutdown()이라는 이름의 메서드를 호출한다.
3️⃣ @PostConstruct, @PreDestroy 애노테이션
결론은 이 방법을 사용하면 된다.
특징
이 애노테이션들은 javax 패키지의 애노테이션으로, 자바 진영에서 공식적으로 지원하기 때문에 스프링이 아닌 다른 컨테이너를 사용해도 적용이 가능하다. 현재 가장 권장되는 방법으로 매우 편리하고, 컴포넌트 스캔과 잘 어울린다.
코드 ⌨️
이 전에 @Bean의 initMethod와 destroyMethod 설정은 지워주고, init()과 close() 메서드에 두 애노테이션을 추가하면 끝이다. 매우 간단하다.
이 방식의 유일한 단점은 코드 수정이 불가능한 외부 라이브러리에는 적용이 불가능하다!
정리 📝
@PostConstruct와 @PreDestroy 애노테이션을 기본으로 사용한다. 만약 코드를 수정할 수 없는 외부 라이브러리에 초기화, 소멸 메서드를 호출해야 하면 @Bean의 initMethod와 destroyMethod를 사용한다.
