Bean Scope가 뭘까?

1. Bean scope란?

• 빈이 존재할 수 있는 범위를 뜻한다. 스프링 빈은 기본적으로 싱글톤 scope로 생성된다.

2. 스프링이 지원하는 스코프 종류

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

(2) 프로토타입: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더이상 관리하지 않는 짧은 범위의 scope

(3) 웹 

 

싱글톤 스코프를 제외한 스코프는 진짜 필요한 곳에서만 사용해야 유지보수가 편하다 라는 말을 시작으로 한번 정리해보자!

---

3-1. Prototype Scope

• 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환한다.
• 클라이언트가 prototype scope의 빈을 요청하면 그때서야 새로운 빈을 생성하고 필요한 의존관계를 주입하여 빈을 반환해준다. 그 후에는 관리를 해주지 않는다.
• 클라이언트마다 서로 다른 새로운 빈을 만들어서 준다.

스프링 컨테이너는 Prototype Bean을 생성하고, DI하고, 초기화까지만 처리한다.

 

클라이언트에 Bean을 반환하고나서 스프링 컨테이너는 더이상 Prototype Bean에 대해서 관리를 하지 않기 때문에 관리 책임은 이제 빈을 받은 클라이언트에 있다.

 

따라서  @PreDestroy같은 종료 메서드는 호출되지 않는다.

 

3-2. Singleton Bean에서 Prototype Bean을 주입받는경우 문제

 

가정 상황

만약 singletonBean이라는 싱글톤 빈이 내부에 prototypeBean을 멤버로 가지고 있을 때 스프링 컨테이너 생성 시점에 함께 생성되고 의존관계 주입이 발생한다.

1. DI 자동 주입 시점에 스프링 컨테이너에 prototypeBean을 요청한다.

 

2. 스프링 컨테이너는 prototypeBean을 생성해서 singletonBean에 반환한다.

 

그리고 prototypeBean에 count라는 멤버가 있고 기본 값이 0이다.

이제 singletonBean은 prototypeBean을 내부 필드에 보관한다. (정확히는 참조값을 보관)

 

3. 클라이언트 A는 singletonBean을 스프링 컨테이너에 요청해서 받는다. 그리고 singletonBean의 로직중 하나인 prototypeBean의 count를 증가시키는 addCount()를 내부에서 호출하는 singletonBean.logic()을 호출한다.

 

4. singletonBean은 prototypeBean의 addCount()를  호출해서 prototypeBean의 count를 증가시켜 count는 1이 된다.

 

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

singletonBean이 내부에 가지고 있는 prototypeBean은 이미 이전에 주입이 끝난 빈이다. singletonBean의 의존관계 주입 시점에 스프링 컨테이너에 요청해서 prototypeBean이 새로 생성이 된 것이지, 사용 할 때마다 새로 생성되는게 아님!

따라서 싱글톤 빈에 프로토타입 빈이 내부 필드로 가지고 있다고 해서 싱글톤 빈이 호출될 때마다 프로토타입빈이 새로 생성되는게 아님.

 

6. 클라이언트 B는 singletonBean.logic()을 호출한다.

 

7. singletonBean.logic()의 내부에서 prototypeBean의 addCount()를 호출해서 prototypeBean의 count를 증가시킨다. 따라서 count는 2가 된다.

 

문제

프로토타입 빈을 쓴다면 이런 상황을 기대하고 쓰는게 아닐 것이다. 이럴거면 싱글톤을 쓰지 왜 프로토타입을 쓰겠나?

 

스프링은 일반적으로 싱글톤 빈을 사용한다.

싱글톤 빈이 프로토타입 빈을 사용하면 싱글톤 빈은 생성 시점에만 DI를 하기 때문에 프로토타입 빈의 새로 생성되기는 하지만 계속 싱글톤 빈과 함께 유지가 된다. 

 

프로토타입 빈을 주입 시점에만 새로 생성하는게 아니라 사용할 때마다 새로 생성해서 사용하기를 원해서 프로토타입 빈을 사용하는 경우가 많다.

 

해결법

 

1. Singletone Bean이 Prototype을 사용할 때마다 스프링 컨테이너에 새로 요청을 한다. 

    @Scope("singleton")
    static class SingletonBean{

        @Autowired
        ApplicationContext applicationContext;

        public int logic(){
            PrototypeBean prototypeBean = applicationContext.getBean(PrototypeBean.class);
            prototypeBean.addCount();
            int count = prototypeBean.getCount();
            return count;
        }
    }

• 의존관계를 외부에서 주입(DI) 받는게 아니라 이런 식으로 직접 필요한 의존관계를 찾는 것을 의존관계 탐색 Dependency Lookup (DL) 이라고 한다.
  
  
• 이런식으로 Spring의 ApplicationContext 전체를 주입 받아 버리면, Spring Container에 종속적이게 되버리고 단위 테스트가 어려워진다.

2. ObjectFactory, ObjectProvider 사용

@Scope("singleton")
static class ClientBean{

    @Autowired
    private ObjectProvider<PrototypeBean> prototypeBeanProvider;

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

• ObjectProvider가 ObjectFactory를 상속받는 구조로 둘 다 getObject()를 통해 빈을 가져올 수 있는데, 여기서는 프로토타입 빈을 가져오므로 항상 새로운 프로토타입 빈의 생성되어 가져올 수 있다. ObjectProvider가 ObjectFactory보다 기능을 더 제공해준다고 생각하면 된다.
• 하지만 ObjectProvider는 프로토타입 전용이라고 생각하면 안되고 스프링 컨테이너를 통해서 DL을 간단하게 도와주는 대리자 정도로 생각하면 된다.
• 1번처럼이 아니라 우리는 DL 의존관계 탐색 정도의 기능이 필요한건데 그걸 제공해주는게 ObjectProvider이다.
• ObjectFactory: 단순한 기능만 제공, 별도의 라이브러리 필요 X. 스프링에 의존
• ObjectProvider: ObjectFactory를 상속받음, 옵션, 스트림 처리 등 편리한 기능을 많이 제공, 별도의 라이브러리 필요 X, 스프링에 의존

import org.springframework.beans.factory.ObjectProvider;

스프링에 의존적이라는 단점이 있다.

 

 

3. JSR-330 Provider

javax.inject.Provider라는 JSR-330 자바 표준을 사용하는 방법

사용하기 위해 'javax.inject:javax.inject:1' 라이브러리를 gradle에 추가해야 함.

implementation 'javax.inject:javax.inject:1'

 

import javax.inject.Provider;

@Scope("singleton")
static class ClientBean{

    @Autowired
    private Provider<PrototypeBean> prototypeBeanProvider;

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

• Provider의 get()을 호출하면 내부에서는 DL개념으로 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다.
• 자바 표준 방법이고 기능이 정말 단순해서 단위테스트를 만들거나 Mock 코드를 만들기 훨씬 쉽다.
• ObjectProvider는 스프링에 의존적이고 다른 기능들이 많이 있던 반면, Provider는 정말 필요한 DL 하나의 기능 정도만 제공한다.
• 별도의 라이브러리가 필요하다.
• 스프링에 의존적이지 않으므로 스프링이 아닌 다른 컨테이너에서도 사용이 가능하다.

 

3-3. 언제 프로토타입 빈을 사용할까?

• 매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요할 때 사용하면 된다.
• 하지만 싱글톤 빈으로 대부분의 문제를 해결할 수 있기 때문에 프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다.

 

참고) ObjectProvider, Provider는 프로토타입에서만 사용하는게 아니라 DL이 필요한 상황에 어디든지 사용 가능하다.

 

 

3-4. ObjectProvider VS Provider

• ObjectProvider는 DL을 위한 편의 기능을 여러 제공해주고 스프링 외에 별도의 gradle에 의존성을 추가하고 하는 일이 필요 없어서 편리하다.
• Provider는 스프링에 의존적이지 않고 자바 표준이므로 코드를 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 할 때 사용한다.(거의 없는 일) 그런데 라이브러리를 설치해야하는 불편함..

대부분 스프링이 더 다양하고 편리한 기능을 제공해주므로 특별히 다른 컨테이너를 사용할 일이 없다면, 스프링이 제공하는 기능을 사용하면 된다.

---

4. Web Scope

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

웹 스코프 종류

    1. request: HTTP 요청이 하나 들어오고 나갈 때 까지 유지.

                     각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리된다.

    2. session: HTTP Session과 동일한 생명주기를 가진다.

    3. application: 웹의 Servletcontext와 동일한 생명주기를 가진다.

    4. websocket: 웹 Socket과 동일한 생명주기를 가진다.

 

4-1. Request Scope Example

web scope는 웹 환경에서만 동작하기 때문에 web 환경이 동작하도록 라이브러리를 추가해야 한다.

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

라이브러리를 추가하면 Spring Boot는 내장 톰캣 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.

 

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

 

예제 설명 : 동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어려우므로 request scope를 이용하여 UUID를 로그 문장에 추가하여 정확한 로그를 남기는 예제.

 

MyLogger에 requestURL을 저장해두는데 MyLogger는 스코프가 request이므로 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.

@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);
    }
}

@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";
    }
}

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

• request scope를 사용하지 않고 파라미터로 requestURL같은 모든 정보를 서비스 계층으로 넘기면 파라미터가 많아서 지저분해지고 웹과 관련없는 서비스 계층에 이러한 정보들이 들어오는 것은 문제가 된다. 
• 웹과 관련된 부분은 컨트롤러까지만 사용해야 한다.
• 서비스 계층은 웹 기술에 종속되지 않고 순수하게 유지하는 것이 유지보수 관점에서 좋다.
• MyLogger를 request scope로 사용했기 때문에 코드와 계층을 깔끔하게 유지할 수 있다.

 

이대로 실행하면 문제가 발생한다.

request Scope 관련해서 오류가 나는 것을 볼 수 있다.

문제

왜냐하면 request scope는 위에서 말했듯이 사용자의 http 요청이 들어올 때 빈이 생성된다고 했는데 요청이 들어오지를 않았는데 Controller와 Service에 자동 주입해주려고 하니 문제가 생기는 것이다.

따라서 request scope의 빈을 받는 것을 사용자의 요청이 입력될 때로 미뤄야 한다. 무엇을 사용해야 할까?

 

 

문제 해결법

1. ObjectProvider 사용

ObjectProvider를 이용하여 HTTP 요청이 들어올 때 getObject해서 DL하여 빈을  찾아온다.

ObjectProvider.getObject()를 호출하는 시점에는 HTTP 요청이 진행중이므로 request scope의 빈의 생성이 정상처리되므로 찾아올 수 있는 것임.

@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도 ObjectProvider를 사용하도록 변경하면 정상적으로 동작한다.

 

2. Proxy 사용(웹 스코프에서만 사용할 수 있는건 아님)

MyLogger의 대리자(가짜) Proxy 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다. 

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

    private String uuid;
    private String requestURL;
    
    ...
}

Scope에 proxyMode 옵션을 설정해주면 된다.

- 적용 대상(여기서는 MyLogger)이 class이면 TARGET_CLASS

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

단지 annotation 설정을 추가한 것만으로 원본 객체를 Proxy로 대체할 수 있는 것이다. 여기서 다형성과 DI 컨테이너가 가진 큰 장점을 알 수 있다.

 로그를 찍어보면 CGLIB 라이브러리를 통해 내 클래스를 상속받은 가짜 Proxy 객체를 만들어서 주입한 것을 볼 수 있다.

• @Scope의 proxMode를 설정하면 스프링 컨테이너는 CGLIB라는 바이트 코드를 조작하는 라이브러리를 사용하여 MyLogger를 상속받은 가짜 Proxy 객체를 생성한다.
• 그리고 스프링 컨테이너에 myLogger라는 이름으로 진짜 대신에 가짜 Proxy 객체를 등록한다.
• 따라서 DI 시에도 이 가짜 Proxy 객체가 주입된다.

대리자(가짜) Proxy 객체는 요청이 오면 그때서야 내부에서 진짜 Bean을 요청하는 위임 logic이 들어있다.

• 가짜 Proxy Bean은 내부에 실제 MyLogger의 진짜 Bean을 찾는 방법을 알고 있다.
• 클라이언트가 MyLogger.logic()을 호출하면 실제로는 가짜 Proxy 객체의 메서드를 호출한 것이다.
• 가짜 Proxy 객체는 request scope의 진짜 myLogger.logic()을 내부에서 호출한다.
• 가짜 Proxy 객체는 위에서 말했듯이 원본 클래스를 상속 받아서 만들어지기 때문에 이 객체를 사용하는 클라이언트 입장에서는 원본인지 아닌지도 모르게 동일하게 사용할 수 있다. (다형성 개념) 

 

Proxy 구동 방식 정리

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

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

3. 가짜 Proxy 객체는 실제 request scope와는 관계 없이 그냥  가짜이고 내부에 단순한 위임 로직이 있는데 싱글톤 처럼 동작한다. 그런데 실제로는 내부에서는 싱글톤이 아니므로 주의해야 한다.

 

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

 

참고) Provider를 사용하던지 Proxy를 사용하던지 핵심 아이디어인 진짜 객체 조회를 꼭 필요한 시점까지 지연처리한다는게 중요하다.