[스프링 핵심원리 기본편] 섹션9. 빈 스코프

jada·2024년 1월 5일
0

Spring 스터디

목록 보기
14/35

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

싱글톤 빈과 프로토타입 빈을 함께 사용할 때, 어떻게 하면 사용할 때 마다 항상 새로운 프로토타입 빈을 생성할 수 있을까?

스프링 컨테이너에 요청

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

public class PrototypeProviderTest {
   @Test
   void providerTest() {
     AnnotationConfigApplicationContext ac = new
    AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);
     ClientBean clientBean1 = ac.getBean(ClientBean.class);
     int count1 = clientBean1.logic();
     assertThat(count1).isEqualTo(1);
     ClientBean clientBean2 = ac.getBean(ClientBean.class);
     int count2 = clientBean2.logic();
     assertThat(count2).isEqualTo(1);
   }
   static class ClientBean {
     @Autowired
     private ApplicationContext ac;
     public int logic() {
     PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
     prototypeBean.addCount();
     int count = prototypeBean.getCount();
     return count;
     }
   }
   @Scope("prototype")
   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");
   	}
   }
}
  • 실행해보면 ac.getBean() 을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.

  • 의존관계를 외부에서 주입(DI) 받는게 아니라 이렇게 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL) 의존관계 조회(탐색) 이라한다.

  • 그런데 이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다.

  • 지금 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 딱! DL 정도의 기능만 제공하는 무언가가 있으면 된다.

스프링에는 이미 모든게 준비되어 있다.



ObjectProvider, ObjectFactory

지정한 빈을 컨테이너에서 대신 찾아주는 DL서비스를 제공하는 것이 바로 ObjectProvider이다. 과거의 ObjectFactory에 편의 기능을 추가해 만들어진 것이 ObjectProvider이다. 

// 주요 코드
@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanProvider;
public int logic() {
   PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
   prototypeBean.addCount();
   int count = prototypeBean.getCount();
   return count;
}


프로토타입 빈이 2개 생성된 것을 확인할 수 있다. 따라서 count값도 각각 1이다. (테스트 통과)

  • 실행해보면 prototypeBeanProvider.getObject() 을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.

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

  • 스프링이 제공하는 기능을 사용하지만, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다.

  • ObjectProvider 는 지금 딱 필요한 DL 정도의 기능만 제공한다.

    • 스프링 컨테이너에서 조회해주는 역할을 해주는 대리자.

  • getObject를 호출하면 그 때 스프링 컨테이너에서 프로토타입 빈을 찾아서 반환해준다. (스프링 컨테이너가 프로토타입 빈을 만들어서 반환해줌.)

    • applicationContext에서 직접 찾는 것이 아니라 찾아주는 기능만 제공해주는 것이다.
    • 필요할 때마다 스프링 컨테이너에 요청하는 기능을 사용할 수 있는 것이다!

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

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



JSR-330 Provider

스프링에 의존하지 않는 새로운 기술

마지막 방법은 javax.inject.Provider 라는 JSR-330 자바 표준을 사용하는 방법이다.
스프링 부트 3.0은 jakarta.inject.Provider 사용한다.

이 방법을 사용하려면 다음 라이브러리를 gradle에 추가해야 한다.

  • 스프링부트 3.0 미만

    • javax.inject:javax.inject:1 라이브러리를 gradle에 추가해야 한다.

  • 스프링부트 3.0 이상

    • jakarta.inject:jakarta.inject-api:2.0.1 라이브러리를 gradle에 추가해야 한다.

  • 실행해보면 provider.get() 을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.

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

  • 자바 표준이고, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다.

  • Provider 는 지금 딱 필요한 DL 정도의 기능만 제공한다.

특징

  • get() 메서드 하나로 기능이 매우 단순하다.
  • 별도의 라이브러리가 필요하다.
  • 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.

정리
✔ 그러면 프로토타입 빈을 언제 사용할까? 매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용하면 된다.
✔ 그런데 실무에서 웹 애플리케이션을 개발해보면, 싱글톤 빈으로 대부분의 문제를 해결할 수 있기 때문에 프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다.
✔ ObjectProvider , JSR330 Provider 등은 프로토타입 뿐만 아니라 DL이 필요한 경우는 언제든지 사용할 수 있다.

참고:
스프링이 제공하는 메서드에 @Lookup 애노테이션을 사용하는 방법도 있지만, 이전 방법들로 충분하고, 고려해야할 내용도 많아서 생략하겠다.


참고:

  • 실무에서 자바 표준인 JSR-330 Provider를 사용할 것인지, 아니면 스프링이 제공하는 ObjectProvider를 사용할 것인지 고민이 될 것이다.
  • ObjectProvider는 DL을 위한 편의 기능을 많이 제공해주고 스프링 외에 별도의 의존관계 추가가 필요 없기 때문에 편리하다.
    • 만약(정말 그럴일은 거의 없겠지만) 코드를 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 한다면 JSR-330 Provider를 사용해야한다.
  • 스프링을 사용하다 보면 이 기능 뿐만 아니라 다른 기능들도 자바 표준과 스프링이 제공하는 기능이 겹칠때가 많이 있다. 대부분 스프링이 더 다양하고 편리한 기능을 제공해주기 때문에, 특별히 다른 컨테이너를 사용할 일이 없다면, 스프링이 제공하는 기능을 사용하면 된다.



웹 스코프

지금까지 싱글톤과 프로토타입 스코프를 학습했다. 싱글톤은 스프링 컨테이너의 시작과 끝까지 함께하는 매우 긴 스코프이고, 프로토타입은 생성과 의존관계 주입, 그리고 초기화까지만 진행하는 특별한 스코프이다.
이번에는 웹 스코프에 대해서 알아보자

웹 스코프의 특징

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

웹 스코프의 종류

  • request: HTTP 요청 하나가 들어오고 나갈 때까지 유지되는 스코프로, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고, 관리된다.

  • session: 서블릿 컨텍스트('ServletContext')와 동일한 생명주기를 가지는 스코프

  • websocket: 웹 소켓과 동일한 생명주기를 가지는 스코프

    (request 스코프를 예제로 설명. 나머지도 범위만 다르지 동작 방식은 비슷하다.)

  • HTTP 요청에 맞춰서 별도의 빈 인스턴스가 각각 할당된다. HTTP request가 들어오고 나갈 때까지의 라이프 사이클동안은 무조건 같은 인스턴스가 관리된다.

  • 클라이언트 A가 요청을 하면, A 전용 스프링 빈이 만들어져 운영이 되다가, A 의 요청이 나가면 해당 빈이 destroy된다. (클라이언트 B도 마찬가지)

request 스코프 예제 만들기

웹 환경 추가
웹 스코프는 웹 환경에서만 동작하므로 web 환경이 동작하도록 라이브러리를 추가하자.
build.gradle에 추가 

//web 라이브러리 추가
implementation 'org.springframework.boot:spring-boot-starter-web'

이제 hello.core.CoreApplication 의 main 메서드를 실행하면 웹 애플리케이션이 실행되는 것을 확인할 수 있다.

Tomcat started on port(s): 8080 (http) with context path ''
Started CoreApplication in 0.914 seconds (JVM running for 1.528)

참고: spring-boot-starter-web 라이브러리를 추가하면 스프링 부트는 내장 톰켓 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.
참고: 스프링 부트는 웹 라이브러리가 없으면 우리가 지금까지 학습한
AnnotationConfigApplicationContext 을 기반으로 애플리케이션을 구동한다. 웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요하므로 AnnotationConfigServletWebServerApplicationContext 를 기반으로 애플리케이션을 구동한다.

request 스코프 예제 개발

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다.
이럴때 사용하기 딱 좋은것이 바로 request 스코프이다.
다음과 같이 로그가 남도록 request 스코프를 활용해서 추가 기능을 개발해보자. 

[d06b992f...] request scope bean create
[d06b992f...][http://localhost:8080/log-demo] controller test
[d06b992f...][http://localhost:8080/log-demo] service id = testId

  • 로그를 출력하기 위한 MyLogger 클래스이다.

  • @Scope(value = "request") 를 사용해서 request 스코프로 지정했다. 이제 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.

  • 이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다.

  • 이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.

  • 이 빈이 소멸되는 시점에 @PreDestroy 를 사용해서 종료 메시지를 남긴다.

  • requestURL 은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력받는다.

  • 로거가 잘 작동하는지 확인하는 테스트용 컨트롤러다.

  • 여기서 HttpServletRequest를 통해서 요청 URL을 받았다.

  • 이렇게 받은 requestURL 값을 myLogger에 저장해둔다. myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.

  • 컨트롤러에서 controller test라는 로그를 남긴다.


참고: requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다. 여기서는 예제를 단순화하고, 아직 스프링 인터셉터를 학습하지 않은 분들을 위해서 컨트롤러를 사용했다. 스프링 웹에 익숙하다면 인터셉터를 사용해서 구현해보자.

  • 비즈니스 로직이 있는 서비스 계층에서도 로그를 출력해보자.

  • 여기서 중요한점이 있다. request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면, 파라미터가 많아서 지저분해진다. 더 문제는 requestURL 같은 웹과 관련된 정보가 웹과 관련없는 서비스 계층까지 넘어가게 된다. 웹과 관련된 부분은 컨트롤러까지만 사용해야 한다. 서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋다.

  • request scope의 MyLogger 덕분에 이런 부분을 파라미터로 넘기지 않고, MyLogger의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.

    이제 실행을 해보자.

    기대하는 출력 

    [d06b992f...] request scope bean create
[d06b992f...][http://localhost:8080/log-demo] controller test
[d06b992f...][http://localhost:8080/log-demo] service id = testId
[d06b992f...] request scope bean close

실제는 기대와 다르게 애플리케이션 실행 시점에 오류 발생

❎😕 스프링 애플리케이션을 실행 시키면 오류가 발생한다. 메시지 마지막에 싱글톤이라는 단어가 나오고…
스프링 애플리케이션을 실행하는 시점에 싱글톤 빈은 생성해서 주입이 가능하지만, request 스코프 빈은 아직 생성되지 않는다.
↪✅ 이 빈은 실제 고객의 요청이 와야 생성할 수 있다!




해결 1) ✔ 스코프와 Provider

첫번째 해결방안은 앞서 배운 Provider를 사용하는 것이다.
간단히 ObjectProvider를 사용해보자

main() 메서드로 스프링을 실행하고, 웹 브라우저에 http://localhost:8080/log-demo 를 입력하자.

실행결과


마지막 네 줄을 보면 request scope 빈(MyLogger 객체)이 제대로 생성된 후 소멸된 것을 확인할 수 있다.

  • request 요청을 여러 번 보냈을 때, 각각의 요청에 대해 uuid가 다르게 할당된 것을 확인할 수 있다. (uuid로 request 요청 구분 가능)
    • 동시에 여러 요청이 온다 하더라도, 요청마다 객체를 각각 관리된다 !

  • ⭐ ObjectProvider 덕분에 ObjectProvider.getObject() 를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.

  • ⭐ ObjectProvider.getObject() 를 호출하시는 시점에는 HTTP 요청이 진행중이므로 request scope 빈의 생성이 정상 처리된다.

  • ObjectProvider.getObject() 를 LogDemoController , LogDemoService 에서 각각 한번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다! 내가 직접 이걸 구분하려면 얼마나 힘들까 ㅠㅠ…

이 정도에서 끝내도 될 것 같지만… 개발자들의 코드 몇자를 더 줄이려는 욕심은 끝이 없다. (따라서 해결 2로,, 😏)





해결 2) ✔ 스코프와 프록시

이번에는 프록시 방식을 사용해보자.

  • 여기가 핵심이다. proxyMode = ScopedProxyMode.TARGET_CLASS 를 추가해주자.
    • 적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS 를 선택
    • 적용 대상이 인터페이스면 INTERFACES 를 선택
  • 이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.

이제 나머지 코드를 Provider 사용 이전으로 돌려두자.

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

@Service
@RequiredArgsConstructor
public class LogDemoService {
  
   private final MyLogger myLogger;
  
   public void logic(String id) {
   		myLogger.log("service id = " + id);
   }
}

실행해보면 잘 동작하는 것을 확인할 수 있다.
코드를 잘 보면 LogDemoController , LogDemoService 는 Provider 사용 전과 완전히 동일하다. 어떻게 된 것일까?

웹 스코프와 프록시 동작 원리

출력 결과

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

  • @Scope 의 proxyMode = ScopedProxyMode.TARGET_CLASS) 를 설정하면 스프링 컨테이너는 CGLIB라는 바이트코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받은 가짜 프록시 객체를 생성한다.

  • 결과를 확인해보면 우리가 등록한 순수한 MyLogger 클래스가 아니라 MyLoggerEnhancerBySpringCGLIB 이라는 클래스로 만들어진 객체가 대신 등록된 것을 확인할 수 있다.

  • 그리고 스프링 컨테이너에 "myLogger"라는 이름으로 진짜 대신에 이 가짜 프록시 객체를 등록한다.

  • ac.getBean("myLogger", MyLogger.class) 로 조회해도 프록시 객체가 조회되는 것을 확인할 수 있다.

  • 그래서 의존관계 주입도 이 가짜 프록시 객체가 주입된다.

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

  • 가짜 프록시 객체는 내부에 진짜 myLogger 를 찾는 방법을 알고 있다.

  • 클라이언트가 myLogger.log() 을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.

  • 가짜 프록시 객체는 request 스코프의 진짜 myLogger.log() 를 호출한다.

  • 가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있다(다형성)


동작 정리

  • CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
    이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.

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


특징 정리

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

  • 사실 Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리한다는 점이다.

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

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


주의점

  • 마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 (싱글톤 X임, 사실은 요청마다 따로 생성됨) 결국 주의해서 사용해야 한다.

  • 이런 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용하자, 무분별하게 사용하면 유지보수하기 어려워진다! 😓

profile
jada
꾸준히 발전하는 개발자가 되자 !
이전 포스트

[스프링 핵심원리 기본편] 섹션8. 빈 생명주기 콜백, 섹션9. 빈 스코프

다음 포스트

[스프링 부트와 JPA 활용1] 섹션1. 프로젝트 환경설정

0개의 댓글