[Spring] Bean Callback

Bean 생성, 소멸시 Callback 사용

앞서 Bean의 생명주기에 대해 알아 보았다.

https://vprog1215.tistory.com/67

[Spring] Bean 생명주기

 

그럼 생성과 소멸시 어떻게 callback을 사용할 것인지 예제로 보자.

 

 

 

콜백을 등록하는 방법

• InitializingBean, DosposableBean
• @Bean 등록 초기화, 소멸 메서드 지정
• 애노테이션 사용 @PostConstruct, @PreDestory (권장하는 방식)

 

 

InitializingBean 과 DisposableBean 사용

• InitializingBean: 주입이 완료된 후 콜백
• DisposableBean: Bean 이 소멸전 콜백

인터페이스 이므로 직접 구현해서 사용해야된다.

 

InitializingBean의 afterPropertiesSet() 을 사용하여 주입 완료후 콜백을 구현 할 수 있다.

DisposableBean의 destroy() 을 사용하여 소멸전 콜백을 구현할수 있다.

 

단점

• 스프링전용이다. 코드가 스프링 전용 인터페이스에 의존될수 밖에 없다.
• 초기화, 소명 메서드의 이름을 변경할 수 없다.
• 내가 코드를 고칠 수 없는 외부 라이브러리에 적용할 수 없다.
• 예전 코드이기 때문에 거의 사용되지 않는다.

 

코드

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

        // move to afterPropertiesSet
        //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 ");
    }

    // 서비스 종료시 호출
    public void disconnect() {

        System.out.println("close: "+ url);
    }

    // 빈생성후 초기화
    @Override
    public void afterPropertiesSet() throws Exception {
        connect();
        call("초기화 연결 메시지");
    }

    //컨테이너가 내려가고 빈 이 죽을때 함수호출
    @Override
    public void destroy() throws Exception {
        disconnect();
    }
}

 

 

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

• 설정 정보에 @Bean(initMethod = "init", destroyMethod = "close") 처럼 지정할수 있다.
• init 과 close 에는 함수명을 적어준 것이다.

 

특징

1. 메서드 이름을 자유롭게 줄 수 있다.

 @Bean(initMethod = "init", destroyMethod = "close") 이런식으로 지정해 줄수 있다.

 

2. 스프링 빈이 스프링 코드에 의존하지 않는다.

스프링 코드를 적어줄 필요가 없다. 예제에서 설명하겠습니다.

 

3. 코드가 아니라 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화

종료 메서드를 적용할 수 있다.

 

 

destroyMethod 의 기능

• destroyMethod 는 특별한 기능을 가지고 있다.
• 라이브러리는 대부분 close, shutdown이라는 종료 메서드를 사용한다
• @Bean의 destroyMethod는 기본값이 (inferred) 로 등록 되어있다.
• 해당 기능은 close, shutdown 이름을 가진 메서드를 자동으로 호출해준다.
• 추론기능을 사용하지 않을 경우 destroyMethod = "" 으로 지정해 주자

 

코드

• afterPropertiesSet 을 init으로 
• destroy 를 close 로 변경해주었다.
• 위에서 특징 2번 을 보면 스프링 빈이 스프링 코드에 의존하지 않는다. 라고 되어있다.
• 다음 코드에서 스프링에 관련된 코드가 없다는 뜻이다.
• 단 설정정보에서 지정해줘야 한다.
• 두 코드를 돌려보면 init 과 close 함수가 호출 된다.

package hello.core.lifecycle;

public class NetworkClient {

    private String url;

    public NetworkClient() {
        System.out.println("생성자 호출 ,url = "+url);

        // move to afterPropertiesSet
        //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 ");
    }

    // 서비스 종료시 호출
    public void disconnect() {

        System.out.println("close: "+ url);
    }

    // 빈생성후 초기화
    public void init() {
        System.out.println("Init");
        connect();
        call("초기화 연결 메시지");
    }

    //컨테이너가 내려가고 빈 이 죽을때 함수호출
    public void close() {
        System.out.println("Close");
        disconnect();
    }
}

 

 

설정정보 코드

public class BeanLifeCycleTest {

    @Test
    public void lifeCycleTest() {
        //ApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        // 변경함. close를 사용하기 위함.
        // close를 사용할 이유가 많지 않다.
        ConfigurableApplicationContext ac = new AnnotationConfigApplicationContext(LifeCycleConfig.class);
        NetworkClient client = ac.getBean(NetworkClient.class);
        ac.close();
    }

    @Configuration
    static class LifeCycleConfig {

        @Bean(initMethod = "init", destroyMethod = "close") //callback 메서드 지정
        public NetworkClient networkClient() {
            NetworkClient networkClient = new NetworkClient();
            networkClient.setUrl("http://hello-spring.dev");
            return networkClient;
        }
    }
}

 

 

애노테이션 @PostConstruct, @PreDestory

특징

최신 스프링에서 가장 권장하는 방법이다.

애노테이션 하나만 붙이면 끝. 간편하다.

패키지를 보면 javax.annotation.PostConstruct 이다. 자바표준이라는 뜻

컴포넌트 스캔과 잘 어울린다.

 

단점

외부 라이브러리에는 적용하지 못한다. 외부 라이브러리를 초기화, 종료 해야 된다면 @Bean 방식을 이용하자.

 

코드

단순하게 init 메소드와 close 메소드에 추가만 해주면 된다.

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

        // move to afterPropertiesSet
        //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 ");
    }

    // 서비스 종료시 호출
    public void disconnect() {

        System.out.println("close: "+ url);
    }

    // 빈생성후 초기화 
    @PostConstruct
    public void init() {
        System.out.println("Init");
        connect();
        call("초기화 연결 메시지");
    }

    //컨테이너가 내려가고 빈 이 죽을때 함수호출
    @PreDestroy
    public void close() {
        System.out.println("Close");
        disconnect();
    }
}

 

결론

• 웬만해서는 @PostConstruct, @PreDestory 애노테이션을 사용하자
• 코드를 고칠 수 없는 외부 라이브러리를 초기화, 종료해야 하면 @Bean 의 initMethod , destroyMethod
  를 사용하자

 

 

 

 

 

 

참고: 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/lecture/55389?tab=curriculum&mm=null 

스프링 핵심 원리 - 기본편 - 인프런 | 학습 페이지