[20230122] 빈 스코프

[otakijae]

Bean Scope

• 스코프는 번역 그대로 빈이 존재할 수 있는 범위를 뜻한다.

  • 싱글톤: 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프이다.
  • 프로토타입: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프이다.
  • 웹 관련 스코프
  • request: 웹 요청이 들어오고 나갈때 까지 유지되는 스코프이다.
  • session: 웹 세션이 생성되고 종료될 때 까지 유지되는 스코프이다.
  • application: 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프이다.

• 싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환한다.

  반면에 프로토타입 스코프를 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환한다.

• 프로토타입 빈의 특징 정리

  • 스프링 컨테이너에 요청할 때 마다 새로 생성된다.
  • 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입 그리고 초기화까지만 관여한다.
  • 종료 메서드가 호출되지 않는다. 그래서 프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 한다. 종료 메서드에 대한 호출도 클라이언트가 직접 해야한다.
  • 싱글톤 빈은 스프링 컨테이너가 관리하기 때문에 스프링 컨테이너가 종료될 때 빈의 종료 메서드가 실행되지만, 프로토타입 빈은 스프링 컨테이너가 생성과 의존관계 주입 그리고 초기화 까지만 관여하고, 더는 관리하지 않는다.
  • 따라서 프로토타입 빈은 스프링 컨테이너가 종료될 때 @PreDestroy 같은 종료 메서드가 전혀 실행되지 않는다.

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

• 스프링 컨테이너에 프토토타입 스코프의 빈을 요청하면 항상 새로운 객체 인스턴스를 생성해서 반환한다.
• 하지만 싱글톤 빈과 함께 사용할 때는 의도한대로 잘 동작하지 않으므로 주의해야 한다.

싱글톤 빈에서 프로토타입 빈 사용

• clientBean 이라는 싱글톤 빈이 의존관계 주입을 통해서 프로토타입 빈을 주입받아서 사용하는 예
• 스프링은 일반적으로 싱글톤 빈을 사용하므로, 싱글톤 빈이 프로토타입 빈을 사용하게 된다.
• 그런데 싱글톤 빈은 생성 시점에만 의존관계 주입을 받기 때문에, 프로토타입 빈이 새로 생성되기는 하지만, 싱글톤 빈과 함께 계속 유지되는 것이 문제다.

프로토타입 스코프 - 싱글톤 빈과 함께 사용시 Provider로 문제 해결

• 스프링 컨테이너에 요청

  • 가장 간단한 방법은 싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청하는 것이다.

  static class ClientBean {
  @Autowired
  private ApplicationContext ac;
  
  public int logic() {
      PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
      prototypeBean.addCount();
      int count = prototypeBean.getCount();
      return count;
  } 
  }

  • 실행해보면 ac.getBean() 을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
  • 의존관계를 외부에서 주입(DI) 받는게 아니라 이렇게 직접 필요한 의존관계를 찾는 것을 Dependency Lookup (DL) 의존관계 조회(탐색) 이라고 한다.
  • 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다.

• ObjectFactory, ObjectProvider

  • ObjectProvider 의 getObject() 를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. (DL)

  @Scope("singleton")
  static class ClientBean {
      @Autowired
      private ObjectProvider<PrototypeBean> prototypeBeanProvider;
  
      public int logic() {
          PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
          prototypeBean.addCount();
          int count = prototypeBean.getCount();
          return count;
      }
  }

• JSR-330 Provider

  • 마지막 방법은 javax.inject.Provider 라는 JSR-330 자바 표준을 사용하는 방법이다.

  @Scope("singleton")
  static class ClientBean3 {
      @Autowired
      private Provider<PrototypeBean> prototypeBeanProvider;
  
      public int logic() {
          PrototypeBean prototypeBean = prototypeBeanProvider.get();
          prototypeBean.addCount();
          int count = prototypeBean.getCount();
          return count;
      }
  }

[LeeeeDain]

빈 스코프

빈 스코프

    @Scope("prototype")
    static class PrototypeBean {...}

• 빈이 존재할 수 있는 범위
• 스프링이 지원하는 스코프
  • 싱글톤: 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프
  • 프로토타입: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프
  • 웹 관련 스코프
  • request: 웹 요청이 들어오고 나갈 때 까지 유지되는 스코프
  • session: 웹 세션이 생성되고 종료될 때 까지 유지되는 스코프
  • application: 웹의 서블릿 컨텍스와 같은 범위로 유지되는 스코프

프로토타입 스코프

• 프로토타입 스코프를 스프링 컨테이너에 요청하면 항상 새로운 인스턴스를 생성해서 반환
• 스프링컨테이너는 프로토 타입 빈을 생성하고, 의존관게 주입, 초기화까지만 처리
• @PreDestroy 같은 종료 메서드가 호출되지 않는다.
• 프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 한다. 종료 메서드에 대한 호출도 클라이언트가 직접 해야한다.

프로토타입 스코프 - 싱클톤 빈과 함께 사용시

• 문제점

  • 싱글톤 빈이 프로토타입 빈을 사용하게 되면 생성 시점에만 의존관계 주입을 받기 때문에 프로토타입 빈이 싱글톤 빈과 함께 계속 싱글톤으로 유지되어 프로토타입 빈을 사용하는 의미가 없게 된다.

• 해결방안

  1. ObjectFactory, ObjectProvider

     • 지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공

     • ObjectFactory: 기능이 단순, 별도의 라이브러리 필요 없음, 스프링에 의존

     • ObjectProvider: ObjectFactory 상속. 옵션, 스트림 처리등 편의 기능이 많고, 별도의 라이브러리 필요 없음. 스프링에 의존

  2. JSR-330 Provider

     • get() 메서드를 통해 DL 서비스를 제공

     • 스프링에 의존하지 않음

     • javax.inject:javax.inject:1 을 gradle에 추가해줘야함

     • implementation 'javax.inject:javax.inject:1'

웹 스코프 특징

• 웹 환경에서만 동작
• 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다. 따라서 종료 메서드가 호출된다.

웹 스코프 종류

• request: HTTP 요청 하나가 들어오고 나갈 때까지 유지되는 스코프, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리된다.
• session: HTTP session과 동일한 생명주기를 가지는 스코프
• application: 서블릿 컨텍스트와 동일한 생명주기를 가지는 스코프

참고

• 스프링부트는 AnnotationConfigApplicationContext 기반으로 앱을 구동하다가 웹 라이브러리(spring-boot-starter-web)가 추가되면 AnnotationConfigServletWebServerApplicationContext 를 기반으로 애플리케이션을 구동한다.
• 인터셉터: HTTP request 요청이 Controller로 오기 전에 공통으로 처리하는 부분
• 웹과 관련된 부분은 비즈니스로직까지 끌고 오지 않고 컨트롤러에서 끝내는게 유지보수에 좋다.

스코프와 Provider

• request 스코프 빈 생성

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

• Provider 사용해서 request 요청이 들어왔을 때 주입된 각 reuqest 요청의 MyLogger 빈을 가져올 수 있음

  private final ObjectProvider<MyLogger> myLoggerProvider;
  ...
  MyLogger myLogger = myLoggerProvider.getObject();
  myLogger.setRequestURL(requestURL);

스코프와 Proxy

• request 스코프 빈 생성

  @Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
  public class MyLogger {...}

• CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.

• 이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.

• 가짜 프록시 객체는 실제 rerquest scope와는 관계가 없다. 그냥 가짜이고, 내부에 단순한 위임 로직만 있고, 싱글톤처럼 동작한다.

• 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope를 사용할 수 있다.

• 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다. 이것이 바로 다형성과 DI 컨테이너가 가진 큰 강저미앋.

• 꼭 웹 스코프가 아니어도 프록시는 사용할 수 있다.

Proxy 주의점

• 마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 결국 주의해서 사용해야 한다.
• 이런 특별한 scope는 꼭 필요한 곳에서만 최소화해서 사용하자. 무분별하게 사용하면 유지보수하기 어려워진다.