mojo's Blog
빈 스코프 본문
※ 빈 스코프란?
스프링 빈은 스프링 컨테이너의 시작과 함께 생성되어서 컨테이너가 종료될 때까지 유지된다.
이것은 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다.
(스코프 : 빈이 존재할 수 있는 범위)
스프링은 다음과 같은 다양한 스코프를 지원한다.
- 싱글톤 : 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프
- 프로토타입 : 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않음
- 웹 관련 스코프
- request : 웹 요청이 들어오고 나갈때 까지 유지되는 스코프
- session : 웹 세션이 생성되고 종료될 때까지 유지되는 스코프
- application : 웹의 서블릿 컨텍스와 같은 범위로 유지되는 스코프
컴포넌트 스캔을 자동으로 등록하는 방법
@Scope("prototype")
@ComponentScan(
basePackages = "hello.core",
excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
)
public class AutoAppConfig {
}
컴포넌트 스캔을 수동으로 등록하는 방법
@Scope("prototype")
@Bean
public MemberService memberService(){
System.out.println("call AppConfig.memberService");
return new MemberServiceImpl(memberRepository());
}
※ 프로토타입 스코프
싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환한다.
반면에 프로토타입 스코프를 스프링 컨테이너에 조회하면 항상 새로운 인스턴스를 생성하여 반환한다.
1. 싱글톤 스코프의 빈을 스프링 컨테이너에 요청
2. 스프링 컨테이너는 본인이 관리하는 스프링 빈 반환
3. 이후 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈 반환
1. 프로토타입 스코프의 빈을 스프링 컨테이너에 요청
2. 스프링 컨테이너는 이 시점에 프로토타입 빈을 생성하고 필요에 따라 의존관계가 주입
3. 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환
4. 이후 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성하여 반환
★ 핵심
스프링 컨테이너는 프로토타입 빈을 생성하고 의존관계 주입, 초기화까지만 처리한다.
클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다.
프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다.
그래서 "@PreDestroy" 와 같은 종료 메서드가 호출이 되지 않는다.
public class SingletonTest {
@Test
void singletonBeanFind() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SingletonBean.class);
SingletonBean singletonBean1 = ac.getBean(SingletonBean.class);
SingletonBean singletonBean2 = ac.getBean(SingletonBean.class);
System.out.println("singletonBean1 = " + singletonBean1);
System.out.println("singletonBean2 = " + singletonBean2);
Assertions.assertEquals(singletonBean1, singletonBean2);
ac.close();
}
@Scope("singleton")
static class SingletonBean {
@PostConstruct
public void init(){
System.out.println("SingletonBean.init");
}
@PreDestroy
public void destroy() {
System.out.println("SingletonBean.destroy");
}
}
}
싱글톤패턴을 적용한 클래스 SingletonBean 이다.
그러면 단 하나의 객체에 대해서 반환을 하기 때문에 두 객체의 주소값이 서로 같게 된다.
SingletonBean 클래스 위에 @Component 를 안붙였는데도 bean 이 생성되는 이유?
=> new AnnotationConfigApplicationContext(SingletonBean.class) 을 하게 되면
자동으로 SingletonBean 클래스에 대한 빈이 생성되도록 지정된다!
public class PrototypeTest {
@Test
void prototypeBeanFind() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);
System.out.println("find prototypeBean1");
PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
System.out.println("find prototypeBean2");
PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);
System.out.println("prototypeBean1 = " + prototypeBean1);
System.out.println("prototypeBean2 = " + prototypeBean2);
Assertions.assertNotEquals(prototypeBean1, prototypeBean2);
ac.close();
}
@Scope("prototype")
static class PrototypeBean {
@PostConstruct
public void init(){
System.out.println("PrototypeBean.init");
}
@PreDestroy
public void destroy() {
System.out.println("PrototypeBean.destroy");
}
}
}
★ 싱글톤패턴과 다른점
1. 프로토타입 빈 요청을 할 때 그 때 빈이 생성된다는 점이다.
즉, 스프링 컨테이너가 생성되면서 빈이 바로 생성이 되지 않는다.
반대로 싱글톤타입 빈은 스프링 컨테이너가 생성되면서 동시에 빈이 생성이 되며,
싱글톤타입 빈 요청시 미리 만들어진 하나의 인스턴스를 반환한다는 점이다.
2. @PostConstruct 에 대한 메서드는 실행되었지만, @PreDestroy 에 대한 메서드는 실행되지 않았다.
반대로 싱글톤타입은 두 애너테이션에 해당하는 메서드 모두가 실행되었다.
프로토타입 빈의 특징
- 스프링 컨테이너에 요청할 때 마다 새로 생성된다.
- 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입 그리고 초기화까지만 관여한다.
- 종료 메서드가 호출되지 않는다. (@PreDestroy)
- 프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 한다.
- 종료 메서드에 대한 호출도 클라이언트가 직접 해야 한다.
※ 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 문제점
스프링 컨테이너에 프로토타입 스코프의 빈을 요청하면 항상 새로운 객체를 생성해서 반환한다.
하지만 싱글톤 빈과 함께 사용할 때는 의도한 대로 동작되지 않으므로 주의해야 한다.
프로토타입 빈을 직접 요청하는 플로우를 생각해보자.
1. client A 는 스프링 컨테이너에 프로토타입 빈을 요청
2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환 (해당 빈의 price = 0)
3. 클라이언트는 조회한 프로토타입 빈에 addPrice() 를 호출하면서 price 필드에 +1000
결과적으로 프로토타입 빈의 price 는 1000 이다.
1. 클라이언트 B는 스프링 컨테이너에 프로토타입 빈을 요청
2. 스프링 컨테이너는 프로토타입 빈을 새로 생성하여 반환 (해당 빈의 price 필드 값은 0)
3. 클라이언트는 조회한 프로토타입 빈에 addPrice() 를 호출하면서 price 필드를 +1000
결과적으로 프로토타입 빈의 price 는 1000 이다.
위 플로우에 대한 코드는 아래와 같다.
public class SingletoneWithPrototypeTest1 {
@Test
void prototypeFind() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);
PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
prototypeBean1.addPrice();
Assertions.assertEquals(1000, prototypeBean1.getPrice());
PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);
prototypeBean2.addPrice();
Assertions.assertEquals(1000, prototypeBean2.getPrice());
ac.close();
}
@Scope("prototype")
static class PrototypeBean {
private int price = 0;
public void addPrice() {
price += 1000;
}
public int getPrice() {
return price;
}
@PostConstruct
public void init() {
System.out.println("PrototypeBean.init " + this);
}
@PreDestroy
public void clear() {
System.out.println("PrototypeBean.clear " + this);
}
}
}
프로토타입 빈이므로 @PreDestory 애너테이션에 해당하는 메서드는 실행되지 않는다.
그리고 동일하게 1000 씩 증가가 되었다.
이번에는 싱글톤에서 프로토타입 빈을 사용하는 플로우를 생각해보자.
clientBean 은 싱글톤이므로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 발생한다.
1. clientBean 은 의존관계 자동 주입을 사용하므로 프로토타입 빈을 요청
2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean 에 반환 (프로토타입 빈의 price 필드 값 = 0)
이제 clientBean 은 프로토타입 빈을 내부 필드에 보관 (정확히는 참조값을 보관)
클라이언트 A는 clientBean 을 스프링 컨테이너에 요청해서 받는다.
싱글톤이므로 항상 같은 clientBean 이 반환된다.
3. 클라이언트 A는 clientBean.logic() 호출
4. clientBean 은 prototypeBean 의 addPrice() 를 호출하여 프로토타입 빈의 price 를 증가
(price 값은 1000)
클라이언트 B는 clientBean 을 스프링 컨테이너에 요청해서 받는다.
싱글톤이므로 항상 같은 clientBean 이 반환된다.
clientBean 이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다.
주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성 된 것이며,
사용할 때마다 새로 생성되는 것이 아님을 주의해야 한다.
5. 클라이언트 B는 clientBean.logic() 을 호출
6. clientBean 은 prototypeBean 의 addPrice() 를 호출해서 프로토타입 빈의 price 를 증가
(price 는 1000 에서 2000 으로 증가)
위 플로우에 대한 코드는 아래와 같다.
@Test
void singletonClientUserPrototype() {
AnnotationConfigApplicationContext ac =
new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);
ClientBean clientBean1 = ac.getBean(ClientBean.class);
int price1 = clientBean1.logic();
Assertions.assertEquals(1000, price1);
ClientBean clientBean2 = ac.getBean(ClientBean.class);
int price2 = clientBean2.logic();
Assertions.assertEquals(2000, price2);
}
@Scope("singleton")
@RequiredArgsConstructor
static class ClientBean {
private final PrototypeBean prototypeBean;
public int logic() {
prototypeBean.addPrice();
return prototypeBean.getPrice();
}
}
@Scope("prototype")
static class PrototypeBean {
private int price = 0;
public void addPrice() {
price += 1000;
}
public int getPrice() {
return price;
}
@PostConstruct
public void init() {
System.out.println("PrototypeBean.init " + this);
}
@PreDestroy
public void clear() {
System.out.println("PrototypeBean.clear " + this);
}
}
스프링은 일반적으로 싱글톤 빈을 사용하므로 싱글톤 빈이 프로토타입 빈을 사용하게 된다.
그런데 싱글톤 빈을 생성 시점에만 의존관계 주입을 받기 때문에, 프로토타입 빈이 새로 생성되기는 하지만,
싱글톤 빈과 함께 계속 유지되는 것은 문제다.
프로토타입 빈을 주입 시점에서만 새로 생성하는게 아니라, 새로 생성해서 사용하는 것을 원할 수 있다.
※ 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 Provider 로 문제 해결
싱글톤 빈과 프로토타입 빈을 함께 사용할 때, 어떻게 하면 사용할 때마다 항상 새로운 프로토타입 빈을
생성할 수 있을까?
방법은 여러가지가 있는데 하나하나 살펴보도록 한다.
① 스프링 컨테이너에 요청
가장 간단한 방법은 싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청한다.
@Scope("singleton")
static class ClientBean {
private AnnotationConfigApplicationContext ac;
public ClientBean() {
ac = new AnnotationConfigApplicationContext(PrototypeBean.class);
}
public int logic() {
PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
prototypeBean.addPrice();
return prototypeBean.getPrice();
}
}
실행해보면 ac.getBean() 을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
의존관계를 외부에서 DI(주입) 받는게 아니라, 직접 필요한 의존관계를 찾는 것을
Dependency Lookup(DL) 의존관계 조회(탐색) 이라고 한다.
그런데 이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면 스프링 컨테이너에 종속적인 코드가
되고, 단위 테스트도 어려워지는 문제가 있다.
지금 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 DL 정도의 기능만 제공하는
무언가가 있으면 된다.
하지만 스프링은 이미 모든게 준비가 되어있다!
② ObjectFactory, ObjectProvider
지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하는 것이 바로 ObjectProvider 이다.
과거에는 ObjectFactory 가 있었는데 여기에 편의 기능이 추가되서 ObjectProvider 가 만들어졌다.
@Scope("singleton")
static class ClientBean {
@Autowired ObjectProvider<PrototypeBean> prototypeBeanProvider;
public int logic() {
PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
prototypeBean.addPrice();
return prototypeBean.getPrice();
}
}
실행해보면 prototypeBeanProvider.getObject() 을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을
확인할 수 있다.
ObjectProvider 의 getObject() 를 호출하면 내부에서 스프링 컨테이너를 통한 해당 빈을 찾아서 반환한다. (DL)
그런데, "프로토타입 빈" 이므로 찾아서 반환하는 과정에서 빈을 알아서 생성하고 반환하는 과정을 거친다.
스프링이 제공하는 기능을 사용하지만, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기 쉽다.
ObjectProvider 는 지금 딱 필요한 DL 정도의 기능만 제공한다.
특징
- ObjectFactory : 기능이 단순하며 별도의 라이브러리가 필요 없다. (스프링 의존)
- ObjectProvider : ObjectFactory 를 상속하며 옵션, 스트림 처리등 편의 기능이 많고 별도의 라이브러리가
필요 없다. (스프링 의존)
③ JSR·330 Provider
마지막 방법으로 javax.inject.Provider 라는 JSR·330 자바 표준을 사용하는 방법이다.
이 방법을 사용하려면 javax.inect:javax.inject:1 라이브러리를 gradle 에 추가해야 한다.
package javax.inject;
public interface Provider<T> {
/**
* Provides a fully-constructed and injected instance of {@code T}.
*
* @throws RuntimeException if the injector encounters an error while
* providing an instance. For example, if an injectable member on
* {@code T} throws an exception, the injector may wrap the exception
* and throw it to the caller of {@code get()}. Callers should not try
* to handle such exceptions as the behavior may vary across injector
* implementations and even different configurations of the same injector.
*/
T get();
}
이제 인터페이스 Provider 를 직접 사용한 코드는 아래와 같다.
import javax.inject.Provider;
...
@Scope("singleton")
static class ClientBean {
@Autowired
private Provider<PrototypeBean> prototypeBeanProvider;
public int logic() {
PrototypeBean prototypeBean = prototypeBeanProvider.get();
prototypeBean.addPrice();
return prototypeBean.getPrice();
}
}
실행해보면 provider.get() 을 통해서 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
provider 의 get() 을 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다 (DL)
자바 표준이고, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기 훨씬 쉽다.
Provider 는 지금 딱 필요한 DL 기능만 제공한다.
특징
- get() 메서드 하나로 기능이 매우 단순하다.
- 별도의 라이브러리가 필요하다.
- 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.
★ 정리
프로토타입 빈은 매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용하면 된다.
프로토타입 빈을 언제 사용할지에 따라 Provider 를 사용하거나 사용하지 않을 수 있다.
그런데 실무에서 웹 애플리케이션을 개발할 때 싱글톤 빈으로 대부분 문제 해결이 가능하다고 한다.
즉, 프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다고 한다.
ObjectProvider, JSR303 Provider 등은 프로토타입 뿐만 아니라 DL 이 필요할 경우 사용 가능하다.
※ 웹 스코프
위에서 싱글톤, 프로토타입 스코프를 학습했다.
싱글톤은 스프링 컨테이너의 시작과 끝까지 함께하는 매우 긴 스코프이고,
프로토타입은 생성과 의존관계 주입, 그리고 초기화까지만 진행하는 특별한 스코프이다.
웹 스코프 특징
- 웹 스코프는 웹 환경에서만 동작한다.
- 웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다.
따라서 종료 메서드가 호출된다.
웹 스코프 종류
- request : HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프이며,
각각의 HTTP 요청마다 별도의 빈 객체가 생성되고 관리된다.
- session : HTTP Session 과 동일한 생명주기를 가지는 스코프
- application : 서블릿 컨텍스트(ServletContext) 와 동일한 생명주기를 가지는 스코프
- websocket : 웹 소켓과 동일한 생명주기를 가지는 스코프
HTTP request 요청 당 각각 할당되는 request 스코프는 아래 사진과 같다.
※ request 스코프 예제 만들기
웹 스코프는 웹 환경에서만 동작하므로 web 환경이 동작하도록 라이브러리를 추가해야 한다.
이제 이전에 생성해뒀던 CoreApplication 의 main 메서드를 실행하면 웹 애플리케이션이 실행되는 것을
확인할 수 있다.
@SpringBootApplication
public class CoreApplication {
public static void main(String[] args) {
SpringApplication.run(CoreApplication.class, args);
}
}
위와 같이 문구가 추가되는 것을 확인할 수 있다.
만약 기본 포트인 8080 포트를 다른곳에서 사용중이어서 오류가 발생하게 될 경우 포트를 변경해야 한다.
9090 포트로 변경하려면 다음과 같이 설정을 추가할 수 있다.
main/resources/application.properties 으로 가서 server.port 를 변경해주자.
이번엔 request 스코프 예제를 개발해보도록 한다.
동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기가 어렵다.
이럴때 사용하기 좋은 것은 바로 request 스코프이다
@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 + "]");
}
@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 스코프로 지정했다.
빈은 HTTP 요청 당 하나씩 생성되며, HTTP 요청이 끝나는 시점에 소멸된다.
빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid 를 생성해서 저장한다.
이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid 를 저장해두면 다른 HTTP 요청과 구분할 수 있다!
이 빈이 소멸되는 시점에 @PreDestroy 를 사용해서 종료 메시지를 남긴다.
requestURL 은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter 로 입력받는다.
이번엔 아래와 같은 구조로 Controller 및 Service 를 구현해보도록 한다.
@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";
}
}
로거가 잘 작동하는지 확인하는 테스트용 컨트롤러이다.
여기서 HttpServletRequest 를 통해서 요청 URL 을 받을 수 있다.
(requestURL 값 = http://localhost:8080/log-demo)
이렇게 받은 requestURL 값을 myLogger 에 저장해둔다.
myLogger 는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.
컨트롤러에서 controller test 라는 로그를 남긴다.
@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 의 멤버변수에 저장해서
코드와 계층을 깔끔하게 유지할 수 있다.
이제 실행을 하면 다음과 같다.
실행 결과 위와 같은 에러가 나타나게 되었다.
myLogger 의 스코프는 "request" 이다.
즉, 빈을 생성할 때 싱글톤 빈과 같이 즉석으로 생성되는 것이 아니라 HTTP 요청이 올 때 생성이 되기 때문에
의존관계 주입 과정에서 에러가 발생하게 된 것이다.
이를 해결하기 위해 이전에 학습했던 "Provider" 를 쓰면 해결이 가능하다!
※ 스코프와 Provider
첫번째 해결방안은 앞서 배운 Provider 를 사용하는 것이다.
우선 ObjectProvider 를 사용해보도록 한다.
Controller 코드
@Controller
@RequiredArgsConstructor
public class LogDemoController {
private final LogDemoService logDemoService;
private final ObjectProvider<MyLogger> myLoggerProvider;
@RequestMapping("log-demo")
@ResponseBody
public String logDemo(HttpServletRequest request) {
MyLogger myLogger = myLoggerProvider.getObject();
String requestURL = request.getRequestURL().toString();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}
Service 코드
@Service
@RequiredArgsConstructor
public class LogDemoService {
private final ObjectProvider<MyLogger> myLoggerProvider;
public void logic(String id) {
MyLogger myLogger = myLoggerProvider.getObject();
myLogger.log("service id = " + id);
}
}
Controller, Service 둘 다 스코프가 request 인 빈을 참조하기 때문에 둘 다 적용해야 한다.
DL 방식을 적용하여 Controller 에서 HTTP 요청이 확실하게 올 때 빈을 가져오게 된다면,
에러 없이 실행이 잘 되는 것을 볼 수 있다.
이번엔 요청을 여러번 해서 UUID 가 어떻게 되는지를 살펴보도록 하자.
위와 같이 UUID 가 서로 다르다는 것을 알 수 있다.
따라서 특정 요청에 대한 필터링을 하고 싶을 때 고유한 UUID 를 가지고 trace 작업을 진행할 수 있다.
ObjectProvider 덕분에 ObjectProvider.getObject() 를 호출하는 시점까지 request scope 빈의
생성을 지연할 수 있다.
ObjectProvider.getObject() 를 호출하는 시점에는 HTTP 요청이 진행중이므로, request scope 빈의
생성이 정상적으로 처리된다.
ObjectProvider.getObject() 를 LogDemoController, LogDemoService 에서 각각 한번씩 따로 호출해도
같은 HTTP 요청이면 같은 스프링 빈이 반환된다!
※ 스코프와 프록시
이번에는 프록시 방식을 써서 해결해본다.
우선, MyLogger 에 스코프에 proxyMode 를 추가한다.
@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {
...
}
proxMode 에 ScopedProxyMode.TARGET_CLASS 를 추가하였다.
- 적용 대상이 인터페이스가 아닌 클래스인 경우 : TARGET_CLASS
- 적용 대상이 인터페이스인 경우 : INTERFACES 선택
이렇게 하면 MyLogger 의 가짜 프록시 클래스를 만들어두고 HTTP request 와 상관 없이 가짜 프록시
클래스를 다른 빈에 미리 주입해 둘 수 있다.
나머지 Controller, Service 는 이전으로 돌려서 실행해보도록 한다.
@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();
System.out.println("myLogger = " + myLogger.getClass());
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);
}
}
정상적으로 실행되는 것을 알 수 있다.
그러나 myLogger 는 이전에 AppConfig 처럼 Spring container 가 bean 이 저장될 때 CGLIB 가 붙었었는데
동일하게 CGLIB 가 붙어진 상태이다.
즉, CGLIB 라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
@Scope 의 proxyMode = ScopedProxyMode.TARGET_CLASS 를 설정하면, 스프링 컨테이너는
CGLIB 라는 바이트 코드를 조작하는 라이브러리를 사용하여 MyLogger 를 상속받은 가짜 프록시 객체를 생성한다.
위 결과를 보면 MyLogger$$EnhancerBySpringCGLIB 라는 클래스로 만들어진 객체가 대신 등록되는 것을
확인할 수 있으며 스프링 컨테이너에 "myLogger" 라는 이름으로 진짜 대신에 가짜 프록시 객체를 등록한다.
ac.getBean("myLogger", MyLogger.class) 로 조회해도 프록시 객체가 조회되는 것을 확인할 수 있다.
그래서 의존관계 주입도 이 가짜 프록시 객체가 주입된다.
가짜 프록시 객체는 요청이 오면 그때 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다.
이 가짜 프록시 빈은 내부에 실제 MyLogger 의 참조를 가지고 있다.
클라이언트가 myLogger.logic() 을 호출하면, 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.
가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic() 을 호출한다.
가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에, 이 객체를 사용하는 클라이언트 입장은
사실 원본인지 아닌지도 모르게 동일하게 사용할 수 있다! (다형성)
★ 동작 정리
- CGLIB 라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
- 이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.
- 가짜 프록시 객체는 실제 request scope 와는 관계가 없다.
그냥 가짜이고, 내부에 단순한 위임 로직만 있으며 싱글톤처럼 동작한다.
★ 특징 정리
- 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope 를 사용할 수 있다.
- 사실 Provider 를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리
를 한다는 점에 있다.
- 단지 애너테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다.
이것이 바로 다형성, DI 컨테이너가 가진 큰 강점이다.
- 꼭 웹 스코프가 아니여도 프록시를 사용할 수 있다.
★ 주의점
- 마치 싱글톤을 사용하는 것 같지만, 다르게 동작하기 때문에 주의해서 사용해야 한다.
- 이런 특별한 scope 는 꼭 필요한 곳에서만 최소화해서 사용해야 한다.
무분별하게 사용하게 될 경우 유지보수가 어려워진다.
'Spring' 카테고리의 다른 글
| 애플리케이션 구현 준비 (2) | 2022.09.02 |
|---|---|
| 도메인 분석 설계 (0) | 2022.08.08 |
| 빈 생명주기 콜백 (0) | 2022.03.14 |
| 애너테이션 및 List, Map (0) | 2022.03.10 |
| 의존관계 자동 주입 (0) | 2022.03.07 |
