[스프링 핵심 원리 - 기본편] #9. 빈 스코프 (2) #147

YuDeokRin · 2024-04-05T13:44:38Z

YuDeokRin
Apr 5, 2024
Maintainer

3️⃣프로토타입 스코프 - 싱글톤 빈과 함께 사용시 문제점

클라이언트A는 스프링 컨테이너에 프로토타입 빈을 요청한다.
스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x01)한다. 해당 빈의 count 필드 값 0이다.
클라이언트는 조회한 프로토타입 빈에 addCount() 를 호출하면서 count필트를 + 1한다.

결과적으로 프로토타입 빈(x01)의 count는 1이 된다.

클라이언트B는 스프링 컨테이너에 프로토타입 빈을 요청한다.
스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x02)한다. 해당 빈의 count 필드 값은 0이다.
클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하면서 count 필드를 +1 한다.

결과적으로 프로토타입 빈(x02)의 count는 1이 된다.

public class SingletonWithPrototypeTest1 {
     @Test
     void prototypeFind() {
         AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);
         PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
         prototypeBean1.addCount();
         assertThat(prototypeBean1.getCount()).isEqualTo(1);
         PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);
         prototypeBean2.addCount();
         assertThat(prototypeBean2.getCount()).isEqualTo(1);
     }
     @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");
     }
	} 
}

✅싱글톤 빈에서 프로토타입 빈 사용

이번에는 clientBean 이라는 싱글톤 빈이 의존관계 주입을 통해서 프로토타입 빈을 주입받아서 사용하는 예를 보자.

clientBean은 싱글톤이므로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고 의존관계 주입도 발생한다.

clientBean은 의존관계 자동 주입을 사용한다. 주입시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.
스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환한다. 프르토타입 빈의 count 필드 값은 0이다.

이제 clientBean은 프로토타입 빈을 내부 필드에 보관한다 (정확히는 참조값을 보관한다.)

✅싱글톤에서 프로토타입 빈 사용 2

클라이언트 A는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean이 반환된다.

클라이언트 A는 clientBean.logic()을 호출한다.
clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가한다. count값이 1이된다.

✅싱글톤에서 프로토타입 빈 사용 3

클라이언트 B는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean이 반환된다.
여기서 중요한 점이 있는데, clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다. 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것이지, 사용 할 때마다 새로 생성되는 것이 아니다.

클라이언트 B는 clientBean.logic() 을 호출한다.
clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가한다. 원래 count값이 1이있으므로 2가 된다.

public class SingletonWithPrototypeTest1 {
     @Test
     void singletonClientUsePrototype() {
         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(2);
     }
     
     static class ClientBean {
         private final PrototypeBean prototypeBean;
         @Autowired
         public ClientBean(PrototypeBean prototypeBean) {
           this.prototypeBean = prototypeBean;
      }
         
			public int logic() {
             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");
         }
		  } 

}

스프링은 일반적으로 싱글톤 빈을 사용, 그러므로 싱글톤 빈이 프로토타입 빈을 사용하게 된다.

그런데 싱글톤 빈은 생성시점에만 의존관계 주입을 받기 떄문에, 프로토타입 빈이 새로 생성되기는 하지만, 싱글톤 빈과 함께 계속 유지되는 것이 문제다….

원하는 것은 프로토타입 빈을 주입 시점에만 새로 생성하는게 아니라, 사용할 때 마다 새로 생성해서 사용하는 것을 원할 것이다.

💈참고
여러 빈에서 같은 프로토타입 빈을 주입 받으면, 주입 받는 시점에 각각 새로운 프로토타입 빈이 생성된다.

예시)
clientA, clientB가 각각 의존관계 주입을 받으면 각각 다른 인스턴스의 프로토타입 빈을 주입 받는다.
clientA → prototypeBean@x01
clientB → prototypeBean@x02

4️⃣프로토타입 스코프 - 싱글톤 빈과 함께 사용시 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");
         }
} }

핵심 코드

@Autowired
private ApplicationContext ac;
public int logic() {
			PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
			prototypeBean.addCount();
			int count = prototypeBean.getCount();
			return count;
}

실행해보면 ac.getBean()을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
의존관계를 외부에서 주입(DI)받는 것이 아니라, 직접 필요한 의존관계를 찾는 것을 Dependenct Lookup(DL) 의존관계 조회(탐색)이라 한다.
그런데 이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다.
지금 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 딱! DL 정도의 기능만 제공하는 무언가 있으면 된다.

✅ObjectFactory, ObjectProvider

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

@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanProvider;

public int logic() {
    PrototypeBean prototypeBean = prototypeProvider.getObject();
    prototypeBean.addCount();
    int count = prototypeBean.getCount();
    return count;
}

실행할 경우 : prototypeBeanProvider.get()을 통해서 프로토타입 빈이 생성되는 것을 확인할 수 있다.
ObjectProvider의 getObject()를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다.(DL)
ObjectProvider는 지금 딱 필요한 DL정도의 기능만 제공

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

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

✅JSR-330 Provider

마지막 방법 : javax.inject.Provider라는 JSR-330 자바 표준을 사용하는 방법
스프링 부트 3.0이상은 jakarta.inject.Provider 사용한다.
스프링 부트 3.0미만
- javax.inject:javax:inject:1 라이브러리를 gradle에 추가해서 사용
스프링 부트 3.0이상
- jakarta.inject:jakarta.inject-api:2.0.1 라이브러리를 gradle에 추가해서 사용
특징
- get() 메서드 하나로 기능이 매우 단순하다.
- 별도의 라이브러리가 필요하다.
- 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.

5️⃣웹 스코프

✅웹 스코프의 특징

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

✅웹 스코프 종류

request : HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프, 각각의 HTTP요청마다 별도의 빈 인스턴스가 생성되고, 관리된다.
session : HTTP Session과 동일한 생명주기를 가지는 스코프
applicaiton : 서블릿 컨텍스트(ServletContext)와 동일한 생명주기를 가지는 스코프
websocket: 웹 소켓과 동일한 생명주기를 갖는 스코프

6️⃣request 스코프 예제 만들기

✅웹 스코프 전제조건

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

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

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 라이브러리를 추가하면 스프링 부트는 내장 톰켓 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.

✅request 스코프 예제 개발

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다.
이럴 때 사용하기 딱 좋은 것이 바로 request 스코프이다.
MyLogger
- 로그 출력하기 위한 MyLogger 클래스
- @scope(value = “request”)를 사용해서 request 스코프로 지정했다. 이제 이 빈은 HTTP 요청 당하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.
- 이 빈이 생성되는 시점에 자동으로 @PostConstrut 초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다.
- 이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.
- @PreDestroy 를 통해서 빈이 소멸되는 시점에 메시지를 남긴다.
- requestURL은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력 받는다.

import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.util.UUID;
 
@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);
    }
}

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.getRequestURL().toString();
        myLogger.setRequestURL(requestURL);
        
        myLogger.log("controller test");
        logDemoService.logic("testId");
        return "OK";
    } 
}

LogDemoService 추가

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
 
 
@Service
@RequiredArgsConstructor
public class LogDemoService {
 
  private final MyLogger myLogger;
     
  public void logic(String id) {
       myLogger.log("service id = " + id);
  } 
}

기대 출력

[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 스코프 빈은 아직 생성되지 않는다. 이 빈은 실제 고객의 요청이 와야 생성할 수 있다.

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;

7️⃣스코프와 Provider

import hello.core.common.MyLogger;
import hello.core.logdemo.LogDemoService;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
@Controller
@RequiredArgsConstructor
public class LogDemoController {
     
     private final LogDemoService logDemoService;
     private final ObjectProvider<MyLogger> myLoggerProvider;
     
     @RequestMapping("log-demo")
     @ResponseBody
     public String logDemo(HttpServletRequest request) {
         String requestURL = request.getRequestURL().toString();
         MyLogger myLogger = myLoggerProvider.getObject();
         myLogger.setRequestURL(requestURL);
         myLogger.log("controller test");
         logDemoService.logic("testId");
         return "OK";
     } 
}

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

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

결과

[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```

8️⃣스코프와 프록시

✅프록시 방법 사용하기

@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {}

proxtMode = ScopedProxyMode.TARGET_CLASS를 추가해주자.
- 적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS를 선택
- 적용 대상이 인터페이스이면 INTERFACES를 선택
이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.
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.getRequestURL().toString();
         myLogger.setRequestURL(requestURL);
         myLogger.log("controller test");
         logDemoService.logic("testId");
         return "OK";
     } 
}

LogDemoService

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
@Service
@RequiredArgsConstructor
public class LogDemoService {
     private final MyLogger myLogger;
     
     public void logic(String id) {
         myLogger.log("service id = " + id);
     } 
}

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

myLogger확인

System.out.println("myLogger = " + myLogger.getClass());

출력

myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$b68b726d

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

@scope의 proxyMode = ScopedProxyMode.TARGET_CLASS 를 설정하면 스프링 컨테이너는 CGLIB라는 바이트코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받은 가짜 프록시 객체를 생성한다.
결과를 확인해보면 우리가 등록한 순수한 MyLogger 클래스가 아니라 MyLogger$

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

✅동작원리

CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.
가짜 프록시 객체는 실제 request scope와는 관계가 없다. 그냥 가짜이고, 내부에 단순한 위임 로직만 있고, 싱글톤 처럼 동작한다.

✅특징 정리

프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope를 사용할 수 있다.
사실 Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 점이다.
단지 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다. 이것이 바로 다형성과 DI 컨테이너가 가진 큰 강점이다.
꼭 웹 스코프가 아니어도 프록시는 사용할 수 있다.

✅주의점

마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 결국 주의해서 사용해야 한다.
이런 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용하자, 무분별하게 사용하면 유지보수하기 어려워진다.

Navigation Menu

Uh oh!

[스프링 핵심 원리 - 기본편] #9. 빈 스코프 (2) #147

Uh oh!

{{title}}

Uh oh!

Replies: 0 comments

Select a reply

Uh oh!

Uh oh!

[스프링 핵심 원리 - 기본편] #9. 빈 스코프 (2) #147

Uh oh!

YuDeokRin Apr 5, 2024 Maintainer

3️⃣프로토타입 스코프 - 싱글톤 빈과 함께 사용시 문제점

✅싱글톤 빈에서 프로토타입 빈 사용

✅싱글톤에서 프로토타입 빈 사용 2

✅싱글톤에서 프로토타입 빈 사용 3

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

✅스프링 컨테이너에 요청

✅ObjectFactory, ObjectProvider

✅JSR-330 Provider

5️⃣웹 스코프

✅웹 스코프의 특징

✅웹 스코프 종류

6️⃣request 스코프 예제 만들기

✅웹 스코프 전제조건

✅request 스코프 예제 개발

7️⃣스코프와 Provider

8️⃣스코프와 프록시

✅프록시 방법 사용하기

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

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

✅동작원리

✅특징 정리

✅주의점

Replies: 0 comments

YuDeokRin
Apr 5, 2024
Maintainer