빈 스코프 - 2 (싱글톤 + 프로토타입 함께 사용 시 문제 해결 방법, 웹 스코프 - request scope, ObjectProvider, 프록시)
빈 스코프 - 1 (싱글톤 스코프, 프로토타입 스코프, 사용 + 문제점)
빈 스코프 - 1 (싱글톤 스코프, 프로토타입 스코프, 사용 + 문제점)
빈 생명 주기 콜백 (InitializingBean, DisposableBean, @Bean, @PostConstruct, @PreDestroy) 빈 생명 주기 콜백 (InitializingBean, DisposableBean, @Bean, @PostConstruct, @PreDestroy) 의존 관계 자동 주입 - 2 (@Autowired, @Qualifier, @Primar
soohykeee.tistory.com
앞서 싱글톤 빈과 프로토타입 빈을 함께 사용할 때 발생할만한 문제들과, 둘을 함께 사용 시에 프로토타입을 프로토타입의 역할로 제대로 사용하지 못하는 것을 확인할 수 있었다. 이번에는 Provider를 사용하여 문제를 해결해보겠다.
프로토타입 스코프 + 싱글톤 빈 함께 사용 시 Provider로 문제 해결
앞서 말했듯이 프로토타입과 싱글톤타입 둘을 함께 사용시, 어떻게 하면 사용할 때 마다 프로토타입을 생성하는 방법으로 적용할 수 있을지 알아보겠다. 주로 다음과 같은 방법들을 사용한다.
- 스프링 컨테이너에 요청
- ObjectFactory, ObjectProvider
- JSR-330 Provider
스프링 컨테이너에 요청
가장 간단한 방법은 싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청하는 것이다.
public class PrototypeProviderTest {
@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");
}
}
static class ClientBean {
@Autowired
private ApplicationContext ac;
public int logic() {
PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}
}
@Test
void providerTest() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);
ClientBean clientBean1 = ac.getBean(ClientBean.class);
int count1 = clientBean1.logic();
Assertions.assertThat(count1).isEqualTo(1);
ClientBean clientBean2 = ac.getBean(ClientBean.class);
int count2 = clientBean2.logic();
Assertions.assertThat(count2).isEqualTo(1);
}
}
위의 테스트코드에서 핵심적인 부분이 ClientBean 에 작성해준 코드이다. 위의 테스트를 실행해보면, ac.getBean()을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
의존관계를 외부에서 주입(DI) 받는게 아니라, 이렇게 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL) 의존관계 조회(탐색)이라 한다. 하지만 이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 된다면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트 또한 어려워지게 된다.
위에 작성한 테스트에서 필요한 기능은, 지정한 프로토타입 빈을 컨테인어에서 대신 찾아주는 DL 정도의 기능만 제공하는 무엇인가가 존재하면 된다. 앞서 말한 이러한 기능은 스프링에 준비가 되어있는 기능이다.
ObjectFactory, ObjectProvider
위의 코드에서 말했듯이 지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하는 것이 바로 이번에 보여주는 ObjectProvider이다. ObjectFactory에서 추가적인 편의 기능을 추가해준 것이 ObjectProvider이다.
static class ClientBean {
/*@Autowired
private ApplicationContext ac;*/
@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanObjectProvider;
public int logic() {
PrototypeBean prototypeBean = prototypeBeanObjectProvider.getObject();
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}
}
테스트코드를 위와 같이 수정해주고, 실행해보면 prototypeBeanObjectProvider.getObject()를 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
ObjectProvider의 getObject()를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. (DL)
ObjectProvider는 위에서 설명했던 부족한 부분인 DL 정도의 기능을 제공해준다. 또한 기능이 단순하기에 단위테스트나 mock 코드를 만들기도 간편해진다.
특징
- ObjectFactory : 기능이 단순, 별도의 라이브러리가 필요없음, 스프링에 의존
- ObjectProvider : ObjectFactory 상속, 옵션, 스트림 처리 등 편의 기능이 많고, 별도의 라이브러리가 필요없고, 스프링에 의존한다.
JSR-330 Provider
말했던 3가지 방법중 마지막 방법은 javax.inject.Provider 라는 JSR-330 자바 표준을 사용하는 방법이다. 스프링 부트 3.0은 jakarta.inject.Provider를 사용한다. 해당 기능을 사용해주기 위해서는 gradle에 의존성을 추가해줘야 한다.
implementation 'javax.inject:javax.inject:1'만일 스프링부트 3.0이상을 사용한다면 아래처럼 작성해줘야 한다.
implementation 'jakarta.inject:jakarta.inject-api:2.0.1'
static class ClientBean {
/*@Autowired
private ApplicationContext ac;*/
/*@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanObjectProvider;*/
@Autowired
private Provider<PrototypeBean> provider;
public int logic() {
PrototypeBean prototypeBean = provider.get();
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}
}
의존성을 추가해준 후, 해당 테스트 코드를 실행해보면 provider.get()을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다. provider의 get() 메서드를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환해준다. (DL), 또한 마찬가지로 DL 정도의 기능을 제공하고, 기능이 단순하므로 단위테스트나 mock 코드를 만들기 간편하다.
특징
- get() 메서드 하나로 기능이 매우 단순
- 별도의 라이브러리가 필요
- 자바 표준이므로, 스프링이 아닌 다른 컨테이너에서도 사용 가능
정리
프로토타입 빈을 언제 사용하면 좋을까?
매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용하면 된다. 하지만 실무에서 웹 어플리케이션을 개발하다보면, 싱글톤 빈을 사용하여 대부분의 문제를 해결할 수 있기에 프로토타입 빈을 직접적으로 사용하는 일은 드물다.
ObjectProvider, JSR-330 Provider 등은 프로토타입 뿐 아니라 DL이 필요한 경우는 언제든지 사용할 수 있다.
여태 우리는 싱글톤과 프로토타입 스코프를 알아보았다. 다시한번 정리하자면 다음과 같다.
싱글톤은 스프링 컨테이너의 시작과 끝까지 함께하는 긴 스코프이고, 프로토타입은 생성과 의존관계 주입, 초기화까지만 진행하는 스코프이다.
웹 스코프
이제는 웹 스코프에 대해 알아보겠다.
특징
- 웹 스코프는 웹 환경에서만 동작
- 웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다. 따라서 종료 메서드가 호출
종류
- request : HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프로, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리된다.
- session : HTTP Session과 동일한 생명주기를 갖는 스코프
- application : ServletContext(서블릿 컨텍스트)와 동일한 생명주기를 갖는 스코프
- websocket : 웹 소켓과 동일한 생명주기를 갖는 스코프
해당 예제에서는 request 스코프를 설명할 것이다. 다른 종류들도 범위만 다르고 동작 방식은 비슷하다.
HTTP 요청이 각자 다른 클라이언트에서 오면, 각각의 request scope가 할당된다. 즉, 클라이언트 A나 B가 요청했을 시 해당 요청이 끝날때까지만 스코프가 할당된다.
request 스코프 예제
웹 스코프는 앞서 설명했듯이 웹 환경에서만 동작하므로, gradle에 web 환경이 동작하도록 의존성을 추가해준다.
이렇게 웹 환경을 추가해주면, 내장 tomcat 서버를 활용해서 웹 서버와 스프링을 함께 실행한다.
implementation 'org.springframework.boot:spring-boot-starter-web'
만약 동시에 여러 HTTP 요청이 오게 되면, 어떤 요청이 남긴 로그인지 구분하기 어렵다. 이럴때 사용하기 좋은 것이 request 스코프이다. 하단과 같은 로그가 남을 수 있도록 request scope 예제를 작성해 줄 것이다.
- 기대하는 공통 포맷 : [UUID] [requestURL] {message}
- UUID를 사용해서 HTTP 요청을 구분
- requestURL 정보도 추가로 넣어서 어떤 URL을 요청해서 남은 로그인지 확인
@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 bean create: " + this);
}
@PreDestroy
public void close() {
System.out.println("[" + uuid + "] request scope bean close: " + this);
}
}
위의 클래스는 로그를 출력하기 위한 MyLogger 클래스이다.
해당 클래스에 @Scope(value="request") 어노테이션을 사용해서 request 스코프로 지정해줬다. 이제 해당 빈은 request 웹 스코프로, HTTP 요청 당 하나씩 생성이 되고, HTTP 요청이 끝나는 시점에서 소멸된다.
코드를 살펴보면, 빈이 생성되는 시점에 자동으로 @PostConstruct, init 메소드를 사용해서 uuid를 생성해 저장해두는 것을 볼 수 있다. 말했듯 해당 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.
또한 빈이 소멸되는 시점에 @PreDestroy 어노테이션을 사용해서 종료 메시지를 남긴다.
requestURL은 빈이 생성되는 시점에 알 수 없으므로, 외부에서 setter를 통해 주입받도록 코드를 작성해줬다.
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.getRequestURI().toString();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}
LogDemoController 클래스는 MyLogger가 제대로 작동하는지 확인해보기 위한 테스트용 컨트롤러이다. 여기서 HttpServletRequest를 통해서 요청 URL을 받았다. 이렇게 getRequestURL()을 받으면, http://localhost:8080/log-demo 가 requestURL의 값으로 들어가게 된다.
이렇게 가져온 requestURL 의 값을 myLogger에 저장해둔다. 앞서 말했지만 다시한번 말하자면, myLogger는 request 웹 스코프이기에 HTTP 요청 당 각각 구분되어 생성되므로, HTTP 요청 값이 섞이지 않는다.
참고
: requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다. 여기서는 예제를 단순화하고, 아직 스프링 인터셉터를 학습하지 않은 분들을 위해서 컨트롤러를 사용했다. 스프링 웹에 익숙하다면 인터셉터를 사용해서 구현해보자.
LogDemoService
@Service
@RequiredArgsConstructor
public class LogDemoService {
private final MyLogger myLogger;
public void logic(String id) {
myLogger.log("service id = " + id);
}
}
만약 해당 서비스 계층에 request scope를 사용하지 않고, 파라미터로 정보를 넘긴다면, 파라미터가 많아져 코드가 지저분해져 가독성이 떨어질 수 있다. 더더욱 문제가 되는 것은 requestURL 같은 웹과 관련된 정보가 웹과 관련없는 서비스 계층까지 넘어가게 된다. 웹과 관련된 부분은 컨트롤러까지만 사용하는 것이 좋다.
즉, 서비스 계층은 웹 기술에 종속되지 않고, 순수하게 유지하는 것이 유지보수 측면에서 효율적이다.
위의 코드를 보게되면 request scope를 사용하는 MyLogger 덕분에 앞서 말한 것처럼 파라미터로 정보를 넘기지 않아도 MyLogger에 저장해서 넘겨주기에 코드와 계층을 깔끔하게 유지할 수 있다.
위 처럼 콘솔창에 예상대로 출력이 될 줄 알았지만, 오류가 발생하게 된다.
이러한 오류가 발생하는 이유는 스프링 애플리케이션을 실행하는 시점에 싱글톤 빈은 생성해서 주입이 가능하지만, request 스코프 빈은 아직 생성되지 않는다. 이 빈은 실제 고객의 요청이 와야 생성할 수 있다.
다시 말하면 스프링 컨테이너가 뜰 때, LogDemoController에서 @RequiredArgsConstructor 어노테이션에 의해 MyLogger, LogDemoService 를 생성자로 주입받는다. 하지만, myLogger에 현재 고객 요청이 들어오지 않아 request scope가 비어있다. 다시 말해, 비어있는 myLogger가 주입받게 되어 오류가 발생하는 것이다.
이를 해결해주기 위해서 여러 방안이 존재하는데 아래에서 알아보겠다.
스코프와 Provider
위와 같은 문제의 해결방안은 앞서 배운 Provider를 사용하는 것이다. ObjectProvider를 적용시킬 것이다.
@Controller
@RequiredArgsConstructor
public class LogDemoController {
private final LogDemoService logDemoService;
private final ObjectProvider<MyLogger> myLoggerObjectProvider;
@RequestMapping("log-demo")
@ResponseBody
public String logDemo(HttpServletRequest request) {
String requestURL = request.getRequestURI().toString();
MyLogger myLogger = myLoggerObjectProvider.getObject();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}
@Service
@RequiredArgsConstructor
public class LogDemoService {
private final ObjectProvider<MyLogger> myLoggerObjectProvider;
public void logic(String id) {
MyLogger myLogger = myLoggerObjectProvider.getObject();
myLogger.log("service id = " + id);
}
}
위처럼 ObjectProvider를 적용시킨 후, 다시 CoreApplication 실행 후, http://localhost:8080/log-demo 입력을 해보면 다음처럼 정상적으로 출력이 되는 것을 확인할 수 있다.
ObjectProvider를 적용시킨 덕분에, ObjectProvider.getObject() 를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.
ObjectProvider.getObject()를 호출하는 시점에는 HTTP 요청이 진행중이므로 request scope 빈의 생성이 정상 처리된다. ObjectProvider.getObject() 를 LogDemoController , LogDemoService 에서 각각 한번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다.
스코프와 프록시
@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {
// ... 생략
}
MyLogger 클래스에 @Scope 어노테이션에 proxyMode = ScopedProxyMode.TARGET_CLASS 를 추가해줬다.
- 적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS
- 적용 대상이 인터페이스면 INTERFACES
위처럼 작성해주면, MyLogger의 가짜 프록시 클래스를 만들어두고, HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해둘 수 있다.
위의 코드가 잘 실행되는지 확인해보기 위해서 앞서 LogDemoController와 LogDemoService 클래스들을 Provider 사용 전으로 코드를 수정해줘야 한다. 수정해주면, 정상적으로 실행이 되는 것을 확인할 수 있다.
CGLIB이라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
- @Scope의 'proxyMode = ScopedProxyMode.TARGET_CLASS' 를 설정하면, 스프링 컨테이너는 CGLIB이라는 바이트코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받은 가짜 프록시 객체를 생성
- MyLogger 를 System.out.print 로 찍어서 로그를 확인해보면, 우리가 등록한 순수한 MyLogger 클래스가 아니라 MyLogger$$EnhancerBySpringCGLIB이라는 클래스로 만들어진 객체가 대신 등록된 것을 확인할 수 있다. 또한 스프링 컨테이너에도 "myLogger" 라는 이름으로 이 가짜 프록시 객체를 등록한다.
- ac.getBean("myLogger", MyLogger.class)로 조회하여도, 프록시 객체가 조회되는 것을 확인할 수 있다.
- 의존관계 주입도 이 가짜 프록시 객체가 주입된다.
가짜 프록시 객체는 요청이 오면, 그때 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다.
- 가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있다.
- 클라이언트가 myLogger.logic()을 호출하면, 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.
가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic()을 호출한다. - 가짜 프록시 객체는 원본 클래스를 상속 받아 만들어졌기에, 이 객체를 사용하는 클라이언트 입장에서는 원본인지 아닌지 모르게, 동일하게 사용할 수 있다. (다형성)
동작 정리
- CGLIB이라는 라이브러리로 내 클래스를 상속받은 가짜 프록시 객체를 만들어서 주입.
- 이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.
- 가짜 프록시 객체는 실제 request scope와는 관계가 없다. 가짜이고, 내부에 단순한 위임 로직만 존재하고, 싱글톤처럼 동작한다.
특징 정리
- 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯, 편리하게 request scope를 사용할 수 있다.
- Provider나 프록시나 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 것이다.
- 어노테이션 설정 변경만으로, 원본 객체를 프록시 객체로 대처할 수 있다. 이것이 다형성과 DI 컨테이너가 가진 강점이다.
- 웹 스코프가 아니어도 프록시는 사용할 수 있다.
주의점
- 싱글톤을 사용하는 것 같지만, 다르게 동작하기에 주의해서 사용해야 한다.
- 이처럼 특별한 scope는 필요한 곳에만 최소화해서 사용하는 것이 좋다. 그것이 유지보수에 편하기 때문이다.