이번 섹션에서는 [빈 스코프]에 대해서 알아보자.
목차는 다음과 같다.
1) 빈 스코프란 ?
2) 프로토타입 스코프
3) 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 문제점
4) 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 Provider로 문제 해결
5) 웹 스코프
6) request 스코프 예제 만들기
7) 스코프와 Provider
8) 스코프와 프록시
지금까지 우리는 스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어서 스프링 컨테이너가 종료될 때 까지 유지된다고 학습했다. 이것은 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다. 스코프는 번역 그대로 빈이 존재할 수 있는 범위를 뜻한다.
스프링은 다음과 같은 다양한 스코프를 지원한다.
싱글톤 스코프
: 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프이다.프로토타입 스코프
: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프이다. (의존관계 주입 후 초기화 메서드까지만 호출해준다. 그 이후부터는 관여하지 않는다.)웹 관련 스코프
request
: 웹 요청이 들어오고 나갈때까지 유지되는 스코프이다.session
: 웹 세션이 생성되고 종료될 때 까지 유지되는 스코프이다.application
: 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프이다.빈 스코프는 다음과 같이 지정할 수 있다.
지금까지 싱글톤 스코프를 계속 사용해보았으니, 프로토타입 스코프부터 확인해보자.
싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환한다. 반면에 프로토타입 스코프를 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환한다.
✔️ 정리
👉 테스트 코드로 확인해보자.
1) 싱글톤 스코프 빈 테스트
2) 프로토타입 스코프 빈 테스트
@PreDestroy
같은 종료 메서드가 전혀 실행되지 않는다.✔️ 프로토타입 빈의 특징 정리
prototypeBean1.destroy();
, prototypeBean2.destroy();
)이번에는 프로토타입 스코프를 싱글톤 빈과 함께 사용할 때 어떤 문제점이 생기는지 알아보자.
스프링 컨테이너에 프로토타입 스코프의 빈을 요청하면 항상 새로운 객체 인스턴스를 생성해서 반환한다. 하지만 싱글톤 빈과 함께 사용할 때는 의도한 대로 잘 동작하지 않으므로 주의해야 한다. 그림과 코드로 확인해보자.
먼저 스프링 컨테이너에 프로토타입 빈을 직접 요청하는 예제를 보자.
프로토타입 빈 직접 요청
addCount()
를 호출하면서 count 필드를 +1 한다.addCount()
를 호출하면서 count 필드를 +1 한다.👉 테스트 코드로 확인해보자.
싱글톤 빈에서 프로토타입 빈 사용
이번에는 clientBean
이라는 싱글톤 빈이, 의존관계 주입을 통해서 프로토타입 빈을 주입받아서 사용하는 예를 보자. (의존관계 주입으로 프로토타입 빈이 필요한 경우.)
clientBean
은 싱글톤이므로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 발생한다.clientBean
은 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다clientBean
에 반환한다. 프로토타입 빈의 count 필드 값은 0이다. (이제 스프링 컨테이너는 해당 프로토타입 빈을 더이상 관리하지 않는다. 해당 프로토타입 빈은 이제 클라이언트가 관리하게 된다.)clientBean
은 프로토타입 빈을 내부 필드에 보관한다. (정확히는 참조값을 보관한다.)clientBean
을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean
이 반환된다.clientBean.logic()
을 호출한다.clientBean
은 prototypeBean의 addCount()
를 호출해서 프로토타입 빈의 count를 증가한다. count값이 1이 된다.clientBean
을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean
이 반환된다. ( 여기서 중요한 점이 있는데, clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다. 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것이지, 사용 할 때마다 새로 생성되는 것이 아니다! )clientBean.logic()
을 호출한다.clientBean
은 prototypeBean의 addCount()
를 호출해서 프로토타입 빈의 count를 증가한다. 원래 count 값이 1이었으므로 2가 된다.👉 테스트 코드로 확인해보자.
🤔 아마 원하는 것이 이런 것은 아닐 것이다. 프로토타입 빈을 주입 시점에만 새로 생성하는게 아니라, 사용할 때 마다 새로 생성해서 사용하는 것을 원할 것이다. 해결 방법을 다음 내용에서 알아보자.
✔️ 참고
🤔 싱글톤 빈과 프로토타입 빈을 함께 사용할 때, 어떻게 하면 사용할 때 마다 항상 새로운 프로토타입 빈을 생성할 수 있을까?
✔️ 스프링 컨테이너에 요청
: 가장 간단한 방법은 싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청하는 것이다.
✔️ ObjectFactory, ObjectProvider
: 지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하는 것이 바로 ObjectProvider
이다. 참고로 과거에는 ObjectFactory
가 있었는데, 여기에 편의 기능을 추가해서 ObjectProvider
가 만들어졌다.
👉 코드를 통해 확인해보자.
prototypeBeanProvider.getObject()
을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다. (프로토타입 빈이 2개 생성된 것을 확인할 수 있다.)ObjectProvider
의 getObject()
를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. (DL)ObjectProvider
는 지금 딱 필요한 DL 정도의 기능만 제공한다.ObjectProvider
를 ObjectFactory
로 바꿔도 동작한다. (ObjectProvider
가 ObjectFactory
를 상속받은 것이다. ObjectFactory
에는 getObject만 지원하지만, ObjectProvider
는 몇개의 편의 기능을 더 제공한다.)특징
✔️ JSR-330 Provider
: 마지막 방법은 javax.inject.Provider
라는 JSR-330 자바 표준을 사용하는 방법이다. 스프링 부트 3.0은 jakarta.inject.Provider
사용한다.
javax.inject:javax.inject:1
라이브러리를 gradle에 추가해야 한다.implementation 'javax.inject:javax.inject:1'
)jakarta.inject:jakarta.inject-api:2.0.1
라이브러리를 gradle에 추가해야 한다.👉 테스트 해보자.
provider.get()
을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.provider
의 get() 을 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. (DL)Provider
는 지금 딱 필요한 DL 정도의 기능만 제공한다.특징
✔️ 정리
ObjectProvider
, JSR330 Provider
등은 프로토타입 뿐만 아니라 DL이 필요한 경우는 언제든지 사용 할 수 있다.✔️ 참고
스프링이 제공하는 메서드에 @Lookup
애노테이션을 사용하는 방법도 있지만, 이전 방법들로 충분하고, 고려해야할 내용도 많아서 생략하겠다.
실무에서 자바 표준인 JSR-330 Provider를 사용할 것인지, 아니면 스프링이 제공하는 ObjectProvider를 사용할 것인지 고민이 될 것이다. ObjectProvider는 DL을 위한 편의 기능을 많이 제공해주고 스프링 외에 별도의 의존관계 추가가 필요 없기 때문에 편리하다. 만약(정말 그럴일은 거의 없겠지만) 코드를 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 한다면 JSR-330 Provider를 사용해야 한다.
스프링을 사용하다 보면 이 기능 뿐만 아니라 다른 기능들도 자바 표준과 스프링이 제공하는 기능이 겹칠때가 많이 있다. 대부분 스프링이 더 다양하고 편리한 기능을 제공해주기 때문에, 특별히 다른 컨테이너를 사용할 일이 없다면, 스프링이 제공하는 기능을 사용하면 된다.
지금까지 싱글톤과 프로토타입 스코프를 학습했다. 싱글톤은 스프링 컨테이너의 시작과 끝까지 함께하는 매우 긴 스코프이고, 프로토타입은 생성과 의존관계 주입, 그리고 초기화까지만 진행하는 특별한 스코프이다.
이번에는 웹 스코프에 대해서 알아보자.
웹 스코프의 특징
웹 스코프 종류
request
: HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고, 관리된다.session
: HTTP Session과 동일한 생명주기를 가지는 스코프.application
: 서블릿 컨텍스트( ServletContext
)와 동일한 생명주기를 가지는 스코프.websocket
: 웹 소켓과 동일한 생명주기를 가지는 스코프.사실 세션이나, 서블릿 컨텍스트, 웹 소켓 같은 용어를 잘 모르는 분들도 있을 것이다. 여기서는 request 스코프를 예제로 설명하겠다. 나머지도 범위만 다르지 동작 방식은 비슷하다.
✔️ HTTP request 요청 당 각각 할당되는 request 스코프
웹 스코프는 웹 환경에서만 동작하므로 web 환경이 동작하도록 라이브러리를 추가하자.
hello.core.CoreApplication
의 main 메서드를 실행하면 웹 애플리케이션이 실행되는 것을 확인 할 수 있다.spring-boot-starter-web
라이브러리를 추가하면 스프링 부트는 내장 톰켓 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.AnnotationConfigApplicationContext
을 기반으로 애플리케이션을 구동한다. 웹 라이브러리가 추가 되면 웹과 관련된 추가 설정과 환경들이 필요하므로 AnnotationConfigServletWebServerApplicationContext
를 기반으로 애플리케이션을 구동한다.main/resources/application.properties
아래에 추가.
👉 이제 request 스코프 예제를 만들어보자.
동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다. 이럴때 사용하기 딱 좋은것이 바로 request 스코프이다.
다음과 같이 로그가 남도록 request 스코프를 활용해서 추가 기능을 개발해보자.
코드로 만들어보자.
MyLogger
클래스이다.@Scope(value = "request")
를 사용해서 request 스코프로 지정했다. 이제 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.@PostConstruct
초기화 메서드를 사용해서 uuid를 생성해서 저장해 둔다. 이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.@PreDestroy
를 사용해서 종료 메시지를 남긴다.requestURL
은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력 받는다.http://localhost:8080/log-demo
)첫번째 해결방안은 앞서 배운 Provider를 사용하는 것이다. 간단히 ObjectProvider를 사용해보자.
CoreApplication
의 main()
메서드로 스프링을 실행하고, 웹 브라우저에 http://localhost:8080/log-demo
를 입력하자.ObjectProvider
덕분에 ObjectProvider.getObject()
를 호출하는 시점까지 request scope 빈의 생성을 지연(스프링 컨테이너에게 요청을 지연)할 수 있다.ObjectProvider.getObject()
를 호출하는 시점에는 HTTP 요청이 진행중이므로 request scope 빈의 생성이 정상 처리된다.ObjectProvider.getObject()
를 LogDemoController
, LogDemoService
에서 각각 한번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다!이번에는 프록시 방식을 사용해보자.
proxyMode = ScopedProxyMode.TARGET_CLASS
를 추가해주자.TARGET_CLASS
를 선택.INTERFACES
를 선택.
🤔 코드를 잘 보면 LogDemoController , LogDemoService 는 Provider 사용 전과 완전히 동일하다. 어떻게 된 것일까?
웹 스코프와 프록시 동작 원리
CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
@Scope
의 proxyMode = ScopedProxyMode.TARGET_CLASS
를 설정하면 스프링 컨테이너는 CGLIB 라는 바이트코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받은 가짜 프록시 객체를 생성한다.MyLogger$ $EnhancerBySpringCGLIB
이라는 클래스로 만들어진 객체가 대신 등록된 것을 확인할 수 있다.ac.getBean("myLogger", MyLogger.class)
로 조회해도 프록시 객체가 조회되는 것을 확인할 수 있다.가짜 프록시 객체는 요청이 오면 그때 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다.
myLogger.logic()
을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.동작 정리
특징 정리
주의점
강의를 듣고 정리한 글입니다. 코드와 그림 등의 출처는 김영한 강사님께 있습니다.