본문 바로가기
Java/Spring

빈 생명주기(라이프사이클)와 빈 스코프

by oneny 2023. 7. 3.

빈 생명주기

스프링 빈은 간단하게 다음과 같은 라이프사이클을 가진다.

객체 생성 -> 의존관계 주입

 

스프링 빈 객체를 생성하고, 의존관계 주입이 다 끝난 다음에야 필요한 데이터를 사용할 수 있는 준비가 완료된다. 따라서 초기화 작업은 의존관계 주입이 모두 완료되고 난 다음에 호출해야 한다.

 

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

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

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

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

  • 초기화 콜백: 빈이 생성되고, 빈의 의존관계 중비이 
  • 소멸전 콜백: 빈이 소멸되기 직전에 호출

 

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

 

빈 생명주기 콜백 메서드

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

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

 

빈 생명주기 콜백 적용 전 문제

public class NetworkClient {

  private String url;

  public NetworkClient() {
    System.out.println("생성자 호출, url = " + url);
    connect();
    call("초기화 연결 메시지");
  }

  public void setUrl(String url) {
    this.url = url;
  }

  // 서비스 시작시 호출
  private void connect() {
    System.out.println("connect: " + url);
  }

  private void call(String message) {
    System.out.println("call: " + url + "message = " + message);
  }

  // 서비스 종료시 호출
  private 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();
  }

  @Configuration
  static class LifeCycleConfig {

    @Bean
    public NetworkClient networkClient() {
      NetworkClient networkClient = new NetworkClient();
      networkClient.setUrl("http://oneny.dev");
      return networkClient;
    }
  }
}

위 코드는 간단하게 외부 네트워크에 미리 연결하는 객체를 하나 생성한다고 가정할 때 NetworkClient는 애플리케이션 시작 시점에 connect()를 호출해서 연결을 맺어두어야 하고, 애플리케이션이 종료되면 disConnect()를 호출해서 연결을 끊어야 하는 예시 코드이다.

 

인터페이스 InitializingBean, DisposableBean

  • InitializingBean: afterPropertiesSet() 메서드로 초기화를 지원한다.
  •  destory() 메서드로 소멸을 지원한다.

 

출력 결과

출력 결과를 확인하면 초기화 메서드가 주입 완료 후에 적절하게 호출되고, 스프링 컨테이너의 종료가 호출되자 소멸 메서드가 호출된 것도 확인할 수 있다.

하지만 이 인터페이스는 스프링 전용 인터페이스이기 때문에 위 코드는 스프링 전용 인터페이스에 의존하고 초기화, 소멸 메서드의 이름을 변경할 수 없다. 또한 내가 외부 라이브러리에 초기화 작업이 필요한 경우에 적용할 수 없다는 큰 단점이 있다. 이 인터페이스를 사용하는 초기화, 종료 방법은 스프링 초창기에 나온 방법들이고, 지금은 다음의 더 나은 방법들이 있어서 거의 사용하지 않는다.

 

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

설정 정보에 @Bean(initMethod = "init", destoryMethod = "close")처럼 초기화, 소멸 메서드를 지정할 수 있다. 설정 정보를 사용하는 경우에는 메서드 이름을 자유롭게 줄 수 있고, 스프링 빈이 스프링 코드에 의존하지 않는다는 장점이 있다. 그리고 설정 정보를 사용하기 때문에 코드를 고칠 수 없는 외부 라이브러리에도 초기화, 종료 메서드를 적용할 수 있다.

 

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

 

출력 결과

 

애노테이션 @PostConstruct, @PreDestory

@PostConstruct, @PreDestory 애노테이션은 최신 스프링에서 가장 권장하는 방법으로 가장 편리하게 초기화와 종료를 실행할 수 있다. 패키지를 보면 jakarta.annotation.PostConstruct인 것을 확인할 수 있는데 이는 스프링에 종속적인 기술이 아니라 자바 표준이라는 것을 의미한다. 즉, 스프링이 아닌 다른 컨테이너에서도 동작하고, 컴포넌트 스캔과 잘 어울린다.

하지만 이 애노테이션을 사용한 방법도 외부 라이브러리에는 적용하지 못한다는 단점이 있는데 이 경우에는 @Bean의 기능을 사용해야 한다.

 

빈 스코프

위에서 스프링 빈 생명주기 콜백 메서드를 통해 스프링 컨테이너의 시작과 함께 생성되어서 스프링 컨테이너가 종료될 때까지 유지되는 것을 확인했다. 이것은 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다. 스코프는 번역 그대로 빈이 존재할 수 있는 범위를 의미하고 스프링은 싱글톤 이외의 다양한 스코프를 지원한다.

  • 싱글톤: 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프이다.
  • 프로토타입: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프이다.
  • 웹 관련 스코프
    • request: 웹 요청이 들어오고 나갈때까지 유지되는 스코프. 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고, 관리된다.
    • session: 웹 세션이 생성되고 종료될 때까지 유지되는 스코프. HTTP Session과 동일한 생명주기를 가진다.
    • application: 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프. 서블릿 컨텍스트(ServletContext)와 동일한 생명주기를 가진다.
    • websocket: 웹 소켓과 동일한 생명주기를 가지는 스코프.

 

프로토타입 스코프

스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다. 클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다. 프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다. 그래서 @PreDestroy 같은 종료 메서드가 호출되지 않는다.

 

프로토타입 스코프 - 싱글톤 빈과 함꼐 사용시 문제점

public class SingletonWithPrototypeTest {

  @Test
  void prototypeFind() {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);
    ClientBean bean1 = ac.getBean(ClientBean.class);
    int count1 = bean1.logic();
    assertThat(count1).isEqualTo(1);

    ClientBean bean2 = ac.getBean(ClientBean.class);
    int count2 = bean2.logic();
    assertThat(count2).isEqualTo(2);
  }

  static class ClientBean {

    private final PrototypeBean prototypeBean;

    @Autowired
    public ClientBean(PrototypeBean prototypeBean) {
      this.prototypeBean = prototypeBean;
    }

    public int logic() {
      prototypeBean.addCount();
      return prototypeBean.getCount();
    }
  }

  static class PrototypeBean {

    private int count = 0;

    public void addCount() {
      count++;
    }

    public int getCount() {
      return count;
    }

    @PostConstruct
    public void init() {
      System.out.println("PrototypeBean.init " + this);
    }

    @PreDestroy
    public void destroy() {
      System.out.println("PrototypeBean.destroy");
    }
  }
}

위 코드를 보면 싱글톤 빈(ClientBean)이 프로토타입 빈(PrototypeBean)을 사용하는 것을 확인할 수 있다. 그런데 싱글톤 빈은 생성 시점에만 의존관계 주입을 받기 때문에, 프로토타입 빈이 새로 생성되기는 하지만, 싱글톤 빈과 함께 계속 유지되는 것이 문제다. 프로토타입 빈을 주입 시점에만 새로 생성하는 것이 아니라, 사용할 때마다 새로 생성해서 사용하는 것을 원할 경우에는 다음과 같은 방법을 사용하여 해결할 수 있다.

  • 스프링 컨테이너에 요청
  • ObjectFactory, ObjectProvider
  • Provider

 

스프링 컨테이너에 요청

사용할 때마다 새로 생성하기 위해서 ac.getBean()을 통해서 항상 새로운 프로토타입 빈을 반환하도록 할 수 있다.

의존관계를 외부에서 주입(DI) 받는게 아니라 이렇게 직접 필요한 의존관계를 찾는 것은 Dependency Lookup(DL) 의존관계 조회(탐색) 이라한다. 그런데 이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어렵기 때문에 DL 정도의 기능만 제공하는 것들이 있다.

 

ObjectFactory, ObjectProvider

지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하는 것이 바로 ObjectProvidewr이다. 과거에는 ObjectFactory가 있었는데, 여기에 편의 기능을 추가해서 ObjectProvider가 만들어졌다. 실행해보면 prototypeBeanObjectProvider.getObject()을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.

즉, ObjectProvider의 getObject()를 호출하면 내부에서는 스프링 컨테이너를 통해 빈을 찾아서 반환한다. 스프링이 제공하는 기능을 사용하지만, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다.

 

JSR-330 Provider

스프링부트 3.0 이상부터는 jakarta.inject:jakarta.jnject-api:2.0.1 라이브러리를 gradle에 추가해서 자바 표준을 사용하는 방법이 있다. 위 방식처럼 provider의 get()을 호출하면 내부에서 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다.(DL) 자바 표준이고, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다. 그리고 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.

 

request 스코프

 

MyLogger

@Component
@Scope(value = "request")
public class MyLogger {

  private String uuid;
  private String requestURL;

  public void setRequestURL(String requestURL) {
    this.requestURL = requestURL;
  }

  public void log(String message) {
    System.out.println("[" + uuid + "]" + "[" + requestURL + "]" + message);
  }

  @PostConstruct
  public void init() {
    uuid = UUID.randomUUID().toString();
    System.out.println("[" + uuid + "] request scope been create:" + this);
  }

  @PreDestroy
  public void close() {
    System.out.println("[" + uuid + "] request scope been close:" + this);
  }
}

사용자의 요청이 들어올 때마다 로그를 출력하기 위한 MyLogger 클래스를 생성했다. @Scope(value = "request")를 사용해서 request 스코프로 지정했다. 이제 이 빈은 사용자의 request 요청마다 각각의 빈 인스턴스가 생성되고, 관리되는 것을 확인할 수 있다. 이 빈은 클라이언트에게 다시 나갈때까지만 유지된다.

추가로 빈생명주기 콜백 메서드를 사용하여 @PostConstructor에서는 uuid를 생성해서 저장하여 다른 HTTP 요청과 구분할 수 있도록 했고, @PreDestroy에서 빈이 소멸되는 시점에 종료 메시지를 남기도록 했다. requestURL은 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력받는다.

 

 

스프링 애플리케이션을 실행하면 위 사진과 같은 에러가 발생한다. 스프링 애플리케이션을 실행하는 시점에 싱글톤 빈은 생성해서 주입이 가능하지만, request 스코프 빈은 아직 생성되지 않았다. 이 빈은 실제 고객의 요청이 와야 생성할 수 있다. 이 빈이 생성되는 시점을 지연시키기 위해서는 다음과 같은 방법들이 있다.

  •  ObjectProvider나 Provider 사용
  • proxyMode = ScopedProxyMode.TARGET_CLASS

위 방법들로 request scope 빈의 생성을 지연할 수 있다. 하지만 Provider를 사용하는 방법은 각각 클래스(LogDemoController, LogDemoService)마다 따로 호출해도 HTTP 요청이 같으면 같은 스프링 빈이 반환되기 때문에 구분하기 위해 힘들 수 있다는 단점이 있다.

따라서 두 번째 방법으로 선택하면 MyLogger의 가짝 프록시 클래스를 만들어두고 HTTP request와 상관없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.

myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$b68b726d

CGLIB라는 라이브러리로 MyLogger 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다. ac.getBean("myLogger", MyLogger.class)로 조회해도 프록시 객체가 조회되는데 이 가짜 프록시 객체는 요청이 오면 그때 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다. 즉, 클라이언트가 myLogger.logic()을 호출하면 가짜 프록시 객체의 메서드를 호출하는 것이고 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic()을 호출한다.

이러한 방식이 가능한 이유는 다형성으로 가짜 프록시 객체는 원본 클래스를 상속받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있는 것이다. 또한, 이렇게 애노테이션을 사용하는 방법은 클라이언트 코드를 전혀 손대지 않는다는 점에서 어마어마한 장점을 지닌다.

 

LogDemoController

@Controller
@RequiredArgsConstructor
public class LogDemoController {

  private final LogDemoService logDemoService;
  private final MyLogger myLogger;

  @RequestMapping("log-demo")
  @ResponseBody
  public String logDemo(HttpServletRequest request) {
    String requestURL = request.getRequestURL().toString();
    myLogger.setRequestURL(requestURL);

    myLogger.log("controller test");
    logDemoService.logic("testId");
    return "OK";
  }
}

HttpServletRequest를 통해서 받은 요청 requestURL 값(http://localhost:8080/log-demo)을 myLogger에 저장해둔다. 그리고 컨트롤러에서 controller test라는 로그를 남긴다.

 

LogDemoService

@Service
@RequiredArgsConstructor
public class LogDemoService {

  private final MyLogger myLogger;

  public void logic(String id) {
    myLogger.log("service id = " + id);
  }
}

비즈니스 로직이 있는 서비스 계층에서도 로그를 출력하기 위해 다음과 같이 작성했다.

 

 

 

저작자표시

'Java > Spring' 카테고리의 다른 글

커넥션풀과 데이터소스 이해하기 with HikariCP  (1) 2023.10.03
JDBC의 Connection, PreparedStatement(vs Statement)  (1) 2023.10.03
스프링의 내부구조 파헤치기  (0) 2023.09.25
스프링 빈(BeanFactory, ApplicationContext, ComponentScan, 의존관계 주입 방법 등)  (0) 2023.07.02
좋은 객체 지향 설계의 5가지 원칙(SOLID)  (0) 2023.06.22

관련글

티스토리툴바