[ 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 Provider로 문제 해결 ]
지난 시간에 싱글톤 빈과 프로토타입 빈을 함께 사용하면 우리가 원하는 결과를 얻을 수 없는 것을 확인했다.
이번에는 싱글톤 빈과 혼용하더라도 프로토타입 빈을 새롭게 생성해서 사용하는 방법에 대해 알아보자!
1. 스프링 컨테이너에 요청
가장 간단한 방법은 싱글톤 빈이 프로토타입을 사용할 때마다 스프링 컨테이너에 새로 요청하는 것이다.
핵심 코드
@Autowired
private ApplicationContext ac;
public int logic() {
PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}- 실행 결과,
ac.getBean()을 통해서 항상 새로운 프로토타입 빈이 생성된다. - 이렇게 직접 필요한 의존관계를 찾는 것을
DL(Dependency Lookup)의존관계 조회(탐색)이라고 한다.
→ 하지만 이렇게 스프링 애플리케이션 컨텍스트 전체를 주입받게 되면 스프링 컨테이너와 종속성이 생기고, 테스트도 어려워진다.
→ 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는, DL 정도의 기능만 제공하는 무언가가 있으면 된다!
2. ObjectFactory, ObjectProvider
지정한 빈을 컨테이너에서 대신 찾아주는
DL서비스를 제공하는ObjectFactory를 이용하는 방법
@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanProvider;
public int logic() {
PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}- 실행 결과,
prototypeBeanProvider.getObject()을 통해서 항상 새로운 프로토타입 빈이 생성된다. ObjectProvider의getObject()를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. (DL)
→ 여전히 스프링에 종속적이지만, 기능이 단순해서 단위테스트나 mock 코드를 만들기는 훨씬 쉬워진다.
✔
mock: 실제 객체를 직접 사용하기 어려워서 (높은 비용/시간, 객체 간의 강한 의존성 등), 가짜 객체를 만들어 사용하는 방법
📌 정리
ObjectFactory: 기능이 단순, 별도의 라이브러리 필요 없음, 스프링에 의존ObjectProvider:ObjectFactory상속, 옵션, 스트림 처리 등 편의 기능이 많고, 별도의 라이브러리 필요 없음, 스프링에 의존
🔗 코드 확인하기
3. JSR-330 Provider
javax.inject.Provider라는JSR-330자바 표준을 사용하는 방법
build.gradle에javax.inject:javax.inject:1라이브러리를 추가
...
dependencies {
...
implementation 'javax.inject:javax.inject:1'
...
}- 테스트 코드 변경
import javax.inject.Provider;
...
static class ClientBean{
@Autowired
private Provider<PrototypeBean> prototypeBeanProvider;
public int logic() {
PrototypeBean prototypeBean = prototypeBeanProvider.get();
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}
}- 실행 결과,
provider.get()을 통해 항상 새로운 프로토타입 빈이 생성된다. provider.get()을 호출하면 내부에서 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. (DL(Dependency Lookup))- 자바 표준이고, 기능이 단순하기에 단위테스트나
mock코드를 만들기 훨씬 쉬워진다. Provider는 지금 딱 필요한DL정도의 기능만 제공한다!
📌 자바 표준 JSR-330 Provider vs 스프링이 제공하는 ObjectProvider
ObjectProvider는 DL을 위한 편의 기능을 많이 제공하고, 스프링 이외 별도 의존관계 추가할 필요 없어서 편리하므로 이것을 사용하자!
만약 코드를 스프링 아닌 다른 컨테이너에서도 사용할 수 있어야 한다면 JSR-330 Provider를 사용하자!
[ 웹 스코프 ]
이번에는 지난 시간에 살짝 언급했던 웹 스코프에 대해 알아보자!
💡 웹 스코프
웹 스코프는 웹 환경에서만 동작하며,
(프로토타입과는 달리) 해당 스코프의 종료 시점까지 관리하기 때문에 종료 메서드도 호출된다.
웹 스코프 종류
request:HTTP요청 하나가 들어오고 나갈 때 까지 유지되는 스코프. 각각의HTTP요청마다 별도의 빈
인스턴스가 생성되고, 관리된다.session:HTTP Session과 동일한 생명주기를 가지는 스코프application: 서블릿 컨텍스트(ServletContext)와 동일한 생명주기를 가지는 스코프websocket: 웹 소켓과 동일한 생명주기를 가지는 스코프
네 종류 모두 범위는 다르지만 동작 방식은 비슷하기 때문에 대표적으로 request를 살펴볼 것이다.
[ request 스코프 예제 만들기 ]
웹 환경 추가
build.gradle에 web 환경이 동작하도록 라이브러리 추가
//web 라이브러리 추가
implementation 'org.springframework.boot:spring-boot-starter-web'이제 CoreApplication.java 의 main메서드를 실행하면 웹 애플리케이션이 실행되는 것을 확인할 수 있다.
localhost:8080으로 접속하면 웹 애플리케이션이 실행된다!
아직은 오류 페이지가 나온다.
request 스코프 예제 개발
동시에 여러 HTTP 요청이 들어오면 어떤 요청이 남긴 로그인지 구분하기 어려울 때 사용하는 것이 바로 request 스코프이다!
다음과 같은 형태로 로그가 남도록 request 스코프를 활용해서 개발해보자.
[UUID][requestURL]{message}
UUID를 사용해서 HTTP 요청을 구분하자.requestURL정보로 추가로 넣어서 어떤 URL을 요청해서 남은 로그인지 확인하자.
🔗 코드 확인하기
MyLogger - 로그 출력
@Scope(value = "request")를 사용해서request스코프로 지정했다. 이제 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.- 이 빈이 생성되는 시점에 자동으로
@PostConstruct초기화 메서드를 사용해서uuid를 생성해서 저장해둔다. 이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다. - 이 빈이 소멸되는 시점에
@PreDestroy를 사용해서 종료 메시지를 남긴다. requestURL은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서setter로 입력 받는다.
LogDemoController - 로거 작동 확인
HttpServletRequest를 통해서 요청 URL을 받았다. (localhost:8080/log-demo)- 이렇게 받은
requestURL값을myLogger에 저장해둔다.myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다. - 컨트롤러에서 'controller test'라는 로그를 남긴다.
LogDeomService - 비즈니스 로직이 있는 서비스 계층에서도 로그 출력
request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면, 파라미터가 많아서 지저분해진다.- 더 큰 문제는
requestURL같은 웹과 관련된 정보가 웹과 관련없는 서비스 계층까지 넘어가게 된다.
⭐ 웹과 관련된 부분은 컨트롤러까지만 사용해야 한다.
서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋다.
request scope의MyLogger덕분에 이런 부분을 파라미터로 넘기지 않고,MyLogger의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다!
위와 같이 코드를 수정하고 실행을 해보면~
여전히 오류가 난다,,
Error creating bean with name 'myLogger': Scope 'request' is not active for the current
thread; consider defining a scoped proxy for this bean if you intend to refer to it
from a singleton;스프링 어플리케이션을 실행하는 시점에 싱글톤 빈은 생성해서 주입이 가능하지만, request 스코프 빈은 아직 생성되지 않는다! 이 빈은 실제 고객의 요청이 와야 생성할 수 있다.
이를 해결하기 위한 방법을 아래에서 알아보자!
[ 스코프와 Provider ]
첫 번째 방법은 앞에서 배운 Provider를 활용하는 것이다.
🔗 코드 확인하기
코드를 수정하고 localhost:8080/log-demo로 접속하면 다음과 같이 잘 동작한다!
ObjectProvider 덕분에 getObject() 를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.
→ getObject()를 호출하는 시점에는 HTTP 요청이 진행중이므로 request scope 빈의 생성이 정상 처리된다.
→ getObject() 를 LogDemoController, LogDemoService에서 각각 한번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다!
[ 스코프와 프록시 ]
이번에는 프록시 방식을 사용해보자!
@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger { }proxyMode = ScopedProxyMode.TARGET_CLASS속성- 적용 대상이 인터페이스가 아닌 클래스면
TARGET_CLASS선택 - 적용 대상이 인터페이스면
INTERFACES선택
- 적용 대상이 인터페이스가 아닌 클래스면
→ 이제 MyLogger는 가짜 프록시를 만들어두고 HTTP Method에 관계없이 가짜 프록시 클래스를 다른 빈에 미리 주입해둘 수 있다.
🔗 코드 확인하기
웹 스코프와 프록시 동작 원리
System.out.println("myLogger = " + myLogger.getClass());주입된 myLogger의 클래스를 출력해보면 다음과 같다.
myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$904ca405순수한 MyLogger 클래스가 아니라 가짜 프록시 객체가 조회된다.
💡
CGLIB라는 라이브러리로 내 클래스를 상속받은 가짜 프록시 객체를 만들어서 주입한다.
그래서 의존관계 주입 시에도 가짜 프록시 객체가 주입된다.
💡 가짜 프록시 객체는 요청이 오면 그때 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다.
클라이언트가 myLogger.logic()을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.
→ 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic()를 호출한다.
가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에
이 객체를 사용하는 클라이언트는 구별 못하고 동일하게 사용할 수 있다. (다형성)
✔ 동작 정리
CGLIB라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.- 이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.
- 가짜 프록시 객체는 실제
request scope와는 관계가 없다.
그냥 가짜이고, 내부에 단순한 위임 로직만 있고, 싱글톤처럼 동작한다.
✔ 특징 정리
- 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게
request scope를 사용할 수
있다. - 사실
Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지
지연처리를 하는 것이다. - 단지 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다. → 다형성과
DI컨테이너가 가진 큰 강점! - 꼭 웹 스코프가 아니어도 프록시는 사용할 수 있다.
✔ 주의점
- 마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 결국 주의해서 사용해야 한다.
- 이런 특별한
scope는 꼭 필요한 곳에만 최소화해서 사용하자. 무분별하게 사용하면 유지보수하기 어려워진다.
[ 📚 Reference ]
[ 📘 오늘의 TIL ]
드디어 길고 길었던 스프링 핵심 원리 강의를 완강했다 ㅠㅠ 이제부터 열심히 달려보자!🤸🏻♀️
