Spring Basic- Bean LifeCycle CallBack

DB Connection pool, Network Socket처럼 Application 시작 지점에 필요한 connection을 미리 해두고,

Application 종료 시점에 connection을 모두 종료하는 작업을 하려면, 객체 초기화와 종료 작업이 필요하다.

이 작업들이 어떻게 진행되는지 예제를 통해 알아보자.

---

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

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

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

NetworkClient 라는 클래스를 만들었다.

위의 클래스와 같은 패키지에 BeanLifeCycleTest 라는 클래스를 만들어보자.

public class BeanLifeCycle {

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

※NetworkClient 생성자 호출을 하면서 객체 생성과 동시에 파라미터값을 전달(초기화 작업)을 하지 않는 이유

1.  유지보수의 관점에서 이점이 있다.
2. 생성자 안에서 초기화 작업을 동시에 하면 외부 커넥션을 연결하는 등 무거운 작업을 하기에 부담이 될 수 있다. 

 

출력 결과

생성자 호출, url = null
connect: null
call: null message = 초기화 연결 메시지

생성자 부분을 보면 url 정보 없이 connect가 호출되는 것을 확인할 수 있다.

객체를 생성하는 단계에는 url이 없고, 객체를 생성한 다음에 외부에서 수정자 주입을 통해서 setUrl() 이 호출되어야 url이 존재하게 된다.

이를 통해 우리는 스프링 빈의 라이프사이클이 객체 생성→의존관계 주입 라는 것을 알 수 있다.

이 과정이 지나야 비로소 데이터를 사용할 준비(초기화 작업의 준비)가 된 것이다. 

그런데, 이 과정이 언제 끝나는지 우리는 어떻게 알 수 있을까?

이때 필요한 것이 Bean LifeCycle CallBack 이다.

스프링은 의존관계 주입이 완료되면 스프링 빈에게 콜백 메서드를 통해서 초기화 시점을 알려준다.

 

CallBack

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

---

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

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

 

1. 인터페이스 InitializingBean, DisposableBean

 

인터페이스 InitializingBean, DisposableBean를 상속 받아서 afterPropertiesSet()와 destroy() 메서드를 사용함.

이 방식을 사용해서 위의 NetworkClient 클래스 코드를 변경해보자.

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

초기화 메서드가 주입 완료 후에 적절하게 호출됨.

스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출됨.

 

※특징 및 단점

1. 이 인터페이스는 스프링 전용 인터페이스다.
2. 초기화, 소멸 메서드의 이름 변경이 불가능
3. 외부 라이브러리에 적용할 수 없다. (가장 큰 문제점)

 

2. 설정 정보에 초기화 소멸 메서드 지정

 

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

설정 정보에 @Bean(initMethod = "init", destroyMethod = "close") 처럼 초기화, 소멸 메서드를 지정

이를 설정하면 코드의 변경이 있다.

public class NetworkClien {
	
    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();
    }

}

@Bean의 destroyMethod 속성에는 추론 기능이 있다.

→ destroyMethod의 기본값이 (inferred) =(추론)으로 등록되어 있다.

→ 이 추론 기능은 close, shutdown 라는 이름의 메서드를 자동으로 호출해준다. 이름 그대로 종료 메서드를 추론해서 호출해준다. 따라서, 직접 스프링 빈으로 등록하면 종료 메서드가 없어도 잘 동작한다는 말이다.

 

※특징

1. 메서드 이름을 자유롭게 설정 가능
2. 스프링 빈이 스프링 코드에 의존 X
3. 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다.

 

3. @PostConstruct, @PreDestroy 애노테이션 지원

 

가장 권장하는 방법으로 애노테이션 하나만 붙이면 위의 기능들을 다 할 수 있는 간편한 방법이다.

코드로 확인하자.

public class NetworkClien {
	
    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;
        }
}

설정 정보 역시 건드리지 않아도 무방하다.

 

※특징 및 단점

1. 스프링에 종속되어 있지 않고 다른 컨테이너에서도 잘 동작한다.
2. 컴포넌트 스캔과 잘 어울린다. (스프링에서 활용하기 좋음)
3. 외부 라이브러리에 적용하지 못한다.

---

총 정리

1. 객체 생성과 동시에 초기화 작업을 피하자. 
2. @PostConstruct, @PreDestroy 애노테이션을 사용하자.
3. 외부 라이브러리를 초기화, 종료해야 하면 @Bean 의 initMethod , destroyMethod 를 사용하자.

---

다음 게시글

Bean Scope