Spring 핵심 원리 기본편 - 9. 빈 스코프

빈 스코프란?

- 지금까지 우리는 스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어서 스프링 컨테이너가 종료될 때까지 유지된다고 학습했다.

- 이것은 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다. 스코프는 번역 그대로 빈이 존재할 수 있는 범위를 뜻한다.

 

* 스프링은 다음과 같은 다양한 스코프를 지원한다. *

- 싱글톤 : 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프이다

- 프로토타입 : 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는

                       매우 짧은 범위의 스코프이다.

- 웹 관련 스코프

    ㆍrequest : 웹요청이 들오고 나갈때까지 유지되는 스코프이다

    ㆍsession : 웹 세션이 생성되고 종료될 때까지 유지되는 스코프이다

    ㆍapplication : 웹의 서블릿 컨텍스와 같은 범위로 유지되는 스코프이다

 

---

프로토타입 스코프

- 싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환한다.

반면에 프로토타입 스코프는 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환한다.

 

* 싱글톤 빈 요청 *

1. 싱글톤 스코프의 빈을 스프링 컨테이너에 요청한다.

2. 스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환한다.

3. 이후에 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈을 반환한다.

 

* 프로토타입 빈 요청 *

1. 프로토타입 스코프의 빈을 스프링 컨테이너에 요청한다

2. 스프링 컨테이너는 이 시점에 프로토타입 빈을 생성하고, 필요한 의존관계를 주입한다.

3. 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환한다.

4. 이후에 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환한다.

 

* 정리 *

- 여기서 핵심은 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다는 것이다.

클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다.

프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다.

그래서 @PreDestory 같은 종료 메서드는 호출되지 않는다

 

 

- 싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드가 실행되지만,

   프로토타입 스코프의 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고, 초기화 메서드도 실행된다

- 프로토타입 빈을 2번 조회했으므로 완전히 다른 스프링 빈이 생성되고, 초기화도 2번 실행된 것을 확인할 수 있다

- 싱글톤 빈은 스프링 컨테이너가 관리하기 때문에 스프링 컨테이너가 종료될 때 빈의 종료 메서드가 실행되지만,

   프로토타입 빈은 스프링 컨테이너가 생성과 의존관계 주입 그리고 초기화까지만 관여하고, 더는 관리하지 않는다

   따라서 프로토타입 빈은 스프링 컨테이너가 종료될 때 @PreDestory 같은 종료 메서드가 전혀 실행되지 않는다

 

* 프로토타입 빈의 특징 정리 *

- 스프링 컨테이너에 요청할 때 마다 새로 생성된다

- 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입 그리고 초기화까지만 관여한다

- 종료 메서드가 호출되지 않는다

- 그래서 프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 한다. 종료 메서드에 대한 호출도 클라이언트가 직접 해야한다.

 

---

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

- 스프링 컨테이너에 프로토타입 스코프의 빈을 요청하면 항상 새로운 객체 인스턴스를 생성해서 반환한다.

 하지만 싱글톤 빈과 함께 사용할 때는 의도한 대로 잘 동작하지 않으므로 주의해야 한다.

 

프로토타입 빈 직접 요청

* 스프링 컨테이너에 프로토타입 빈 직접 요청 *

1. 클라이언트A는 스프링 컨테이너에 프로토타입 빈을 요청한다

2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환( *x01* )한다. 해당 빈의 count 필드 값은 0이다

3. 클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하면 count필드는 +1 한다.

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

 

- 클라이언트B 도 addCount() 호출 시 count는 1이 된다.

 

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

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

 

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

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

- 1. clientBean은 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.

- 2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환한다. 프로토타입 빈의 count값은 0이다.

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

 

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

- 3. 클라이언트 A는 clientBean.logic() 을 호출한다

- 4. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가한다. count값이 1이된다.

 

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

- * 여기서 중요한 점은 clientBean이 내부에 가지고 있는 프로토 타입 빈은 이미 과거에 주입이 끝난 빈이다. 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것이지, 사용할 때마다 새로 생성되는 것이 아니다! *

- 5. 클라이언트 B는 clientBean.logic() 을 호출한다

- 6. clientBean은 prototypeBean의 'addCount()' 를 호출해서 프로토타입 빈의 count를 증가한다. count값은 2가 된다.

 

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

 

---

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

- 가장 간단한 방법은 싱글톤 빈이 프로토타입을 사용할 때마다 스프링 컨테이너에 새로 요청하는 것이다.

 

- 의존관계를 외부에서 주입(DI) 받는게 아니라 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL) 의존관계 조회(탐색) 이라 한다.

- 그런데 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다

 

ObjectFactory, ObjectProvider

- 지정한 빈을 컨테이너에서 대신 찾아주는 DL서비스를 제공하는 것이 바로 ObjectProvider이다.

- 특징

    ㆍObjectFactory : 기능이 단순, 별도의 라이브러리 필요없음, 스프링에 의존

    ㆍObjectProvider : ObjectFactory 상속, 옵션, 스트림 처리 등 편의 기능이 많고,

                                   별도의 라이브러리 필요없음, 스프링에 의존

 

- ObjectProvider의 getObject()를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다 ( *DL* )

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

 

JSR-330 Provider

- gradle 추가

implementation 'org.springframework.boot:spring-boot-starter'

        @Autowired
        private Provider<PrototypeBean> prototypeBeanProvider;

        public int logic() {
            PrototypeBean prototypeBean = prototypeBeanProvider.get();
        }

- 실행해보면 provider.get() 을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다

- provider의 get()을 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. ( *DL* )

- 자바 표준이고, 기능이 단순하므로 단위테스트를 만들거나 mock코드를 만들기는 훨씬 쉬워진다

 

- 특징

    ㆍget( ) 메서드 하나로 기능이 매우 단순하다.

    ㆍ별도의 라이브러리가 필요하다

    ㆍ자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.

 

* 정리 *

- 그러면 프로토 타입 빈은 언제 사용할까?

  매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용하면 된다

  그런데 실무에서 웹 애플리케이션을 개발해보면, 싱글톤 빈으로 대부분의 문제를 해결할 수 있기 때문에

  프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다.

- ObjectProvider, JSR303 Provider 등은 프로토타입 뿐만 아니라 DL이 필요한 경우는 언제든지 사용할 수 있다.

 

- 참고 : 스프링에서 제공하는 메서드에 @Lookup 애노테이션을 사용하는 방법도 있지만, 이전 방법들로 충분하고, 고려해야할 내용도 많아서 생략

- 참고 :

ObjectProvider는 DL을 위한 편의 기능을 많이 제공해주고 스프링 외에 별도의 의존관계 추가가 필요없기 때문에 편리

만약( 정말 그럴 일은 없겠지만 ) 코드를 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 한다면 JSR-330 Provider를 사용해야한다.

대부분은 스프링이 더 다양하고 편리한 기능을 제공해주기 때문에 스프링이 제공하는 기능을 사용하면 된다.

 

---

웹 스코프

- 싱글톤은 스프링 컨테이너의 시작과 끝까지 함께하는 매우 긴 스코프이고,

  프로토타입은 생성과 의존관계 주입, 그리고 초기화까지만 진행하는 특별한 스코프이다.

 

- 웹 스코프의 특징

    ㆍ웹 스코프는 웹 환경에서만 동작한다

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

 

- 웹 스코프의 종류

    ㆍrequest : HTTP 요청 하나가 들어오고 나갈 때까지 유지되는 스코프, 각각의 HTTP 요청마다

                       별도의 빈 인스턴스가 생성되고, 관리된다.

    ㆍsession : HTTP Session과 동일한 생명주기를 가지는 스코프

    ㆍapplication : 서블릿 컨텍스트 ( ServletContext )와 동일한 생명주기를 가지는 스코프

    ㆍwebsocket : 웹 소켓과 동일한 생명주기를 가지는 스코프

 

- 참고 : 스프링 부트는 웹 라이브러리가 없으면 우리가 지금까지 학습한 'AnnotationConfigApplicationContext' 을 기반으로 애플리케이션을 구동한다. 웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요하므로 AnnotationConfigServletWebServerApplicationContext'를 기반으로 애플리케이션을 구동한다.

 

request 스코프 예제 개발

- 동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다

- 이럴떄 사용하기 좋은 것이 request 스코프

 

- 기대하는 공통 포맷 : [UUID][requestURL]{message}

- UUID를 사용해서 HTTP 요청을 구분하자

- requestURL 정보도 추가로 넣어서 어떤 URL을 요청해서 남은 로그인지 확인하자

 

→ request 스코프 빈은 실제 고객의 요청이 와야 생성할 수 있다!

 

- MyLogger

@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() {
        this.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);
    }
}

- controller

@Controller
@RequiredArgsConstructor
public class LogDemoController {

    private final LogDemoService logDemoService;
    private final ObjectProvider<MyLogger> myLoggerProvider;    // MyLooger를 DL해주는 provider가 주입

    @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

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final ObjectProvider<MyLogger> myLoggerProvider;

    public void logic(String id) {
        MyLogger myLogger = myLoggerProvider.getObject();
        myLogger.log("service id  = " + id);
    }
}

---

스코프와 Provider

- 첫번째 해결방안 Provider

// MyLooger를 DL해주는 provider가 주입
private final ObjectProvider<MyLogger> myLoggerProvider;

public void logic(String id) {
    MyLogger myLogger = myLoggerProvider.getObject();
    myLogger.log("service id  = " + id);
}

- ObjectProvider 덕분에 ObjectProvider.getObject( ) 를 호출하는 시점까지 request scope 빈의 생성을 지연 할 수 있다.

- 같은 HTTP 요청이면 같은 스프링 빈이 반환된다!

 

---

스코프와 프록시

- 프로시 방식 사용

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

- 적용대상이 인터페이스가 아닌 클래스면 TARGET_CLASS를 선택

- 적용대상이 인터페이스면  INTERFACES를 선택

- 이렇게하면 MyLogger에 가짜 프록시 클래스를 만들어두고 HTTP request와 상관없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.

 

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

- @Scope의 ' proxyMode = ScopedProxyMode.TARGET_CLASS ' 를 설정하면 스프링 컨테이너는 CGLIB라는 바이트 코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받은 가짜 프록시 객체를 생성한다

- 결과를 확인해보면 우리가 등록한 순수한 MyLogger클래스가 아니라 ' MyLooger$$EnhancerBySpringCGLIB ' 이라는 클래스로 만들어진 객체가 대신 등록되는 것을 확인할 수 있다

- 그리고 스프링 컨테이너에 myLogger라는 이름으로 진짜 대신 이 가짜 프록시 객체를 등록한다

- ac.getBean("myLogger", MyLogger.class) 로 조회해도 프록시 객체가 조회되는 것을 확인할 수 있다.

- 그래서 의존관계 주입도  이 가짜 프록시 객체가 주입된다.

 

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

- 가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있다

- 클라이언트가 myLogger.logic( ) 을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다

- 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic( ) 를 호출한다

- 가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게 동일하게 사용할 수 있다 ( 다형성 )

 

* 동작 정리 *

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

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

- 가짜 프록시 객체는 실제 request scope와는 관계가 없다. 그냥 가짜이고, 내부에 단순한 위임 로직만 있고, 싱글톤 처럼 동작한다.

 

* 특징 정리 *

- 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope를 사용할 수 있다

- 사실 Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 점이다.

- 단지 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다. 이것이 다형성과 DI 컨테이너가 가진 큰 강점이다. 

- 꼭 웹 스코프가 아니어도 프록시는 사용할 수 있다.

 

* 주의점 *

- 마치 싱글톤을  사용하는 것 같지만 다르게 동작하기 때문에 결국 주의해서 사용해야한다.

- 이런 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용하자, 무분별하게 사용하면 유지보수하기 어려워 진다.

 

 

 

출처 :

인프런 김영한님의 스프링 핵심 원리 - 기본편

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/