스프링 핵심 원리 기본편 8 - 프로토타입 스코프(싱글톤 빈과 함께 사용시 문제점)

이번 챕터는 빈 스코프에 대해서 보다 자세히 설명해준다.
그리고 프로토타입 스코프로 생성한 빈과 싱글톤 빈을 함께 사용할 시 발생할 수 있는 문제점을 나열한다.

빈 스코프란?

지금까지 우리는 스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어 스프링 컨테이너가 종료될 때 까지 유지된다고 학습했다. 이것은 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다. 하지만 스프링은 다양한 스코프를 지원한다.

스코프 : 빈이 존재할 수 있는 범위

• 싱글톤 : 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 버위의 스코프이다.
• 프로토타입 : 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프이다.
• 웹 관련 스코프
  • request : 웹 요청이 들어오고 나갈때까지 유지되는 스코프이다.
  • session : 웹 세션이 생성되고 종료될 때 까지 유지되는 스코프이다.
  • application: 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프이다.

빈 스코프 지정 방법 :

@Scope("prototype")
@Component
public class HelloBean{}

@Scope("prototype")
@Bean
PrototypeBean HelloBean(){
	return new HelloBean();
}

프로토타입 스코프

싱글톤 스코프의 빈을 조회하면, 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환한다. 반면, 프로토타입 스코프를 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 반환한다.

프로토타입 빈 생성 예제 코드

package hello.core.scope;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

public class PrototypeTest {

    @Test
    void prototypeBeanFind(){
        //이렇게 클래스를 지정해주면, @Component 애노테이션 등록을 해주지 않아도 컴포넌트 스캔 대상이 된다.
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);

        System.out.println("find protytypeBean1");
        PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
        System.out.println("find protytypeBean2");
        PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);

        System.out.println("prototypeBean1 = " + prototypeBean1);
        System.out.println("prototypeBean2 = " + prototypeBean2);

        Assertions.assertThat(prototypeBean1).isNotSameAs(prototypeBean2);

        ac.close();
    }

    @Scope("prototype")
    static class PrototypeBean {
        @PostConstruct
        public void init(){
            System.out.println("SingletonBean.init");
        }

        @PreDestroy
        public void destroy(){
            System.out.println("SingletonBean.destroy");
        }

    }

}

실행 결과

find protytypeBean1
SingletonBean.init
find protytypeBean2
SingletonBean.init
prototypeBean1 = hello.core.scope.PrototypeTest$PrototypeBean@242b836
prototypeBean2 = hello.core.scope.PrototypeTest$PrototypeBean@3f6f6701
11:18:20.706 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@4445629, started on Mon Mar 01 11:18:20 KST 2021

Process finished with exit code 0

• 싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메소드가 실행되지만, 프로토타입 스코브 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고, 초기화 메소드도 실행된다.
• 프로토타입 빈을 2번 조회했으므로 완전히 다른 스프링 빈이 생성되고, 초기화도 2번 실행된 것을 확인할 수 있다.
• 싱글톤 빈은 스프링 컨테이너과 간리하기 때문에 스프링 컨테이너가 종료될 떄 빈의 종료 메서드가 실행되지만, 프로토 타입 빈은 스프링 컨테이너가 생성, 의존관계 주입 및 초기화까지만 관여하고, 더는 관리하지 않는다. 따라서 프로토타입 빈은 스프링 컨테이너 종료 시점에 @PreDestroy같은 종료 메서드가 전혀 실행되지 않는다.

프로토타입 빈의 특징 정리

• 스프링 컨테이너가 요청할 때 마다 생성된다.
• 스프링 컨테이너는 프로토타입 빈의 생성, 의존관계 주입, 초기화까지만 관여한다.
• 종료 메서드가 호출되지 안흔다.
• 그래서 프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 한다. 종료 메서드에 대한 호출도 클라이언트가 직접 해야한다.

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

스프링 컨테이너에 프로토타입 스코프의 빈을 요청하면 항상 새로운 객체 인스턴스를 생성해서 반환한다. 하지만 싱글톤 빈과 함께 사용할 때는 의도한대로 잘 동작하지 않으므로 주의해야 한다.

예를들어, 싱글톤 빈 안에 프로토타입 빈을 주입받는 클래스를 설계해보았다고 가정해보자.
스프링 컨테이너가 구동되고 나면, 이 싱글톤 A는 프로토타입 빈 B를 주입받아 생성될 것이다. 여기서, 클라이언트가 A를 호출하고, 또 다른 클라이언트가 B를 호출하더라도 둘 다 결국 같은 프로토타입 빈을 주입받게 된다.(프로토타입 빈은 싱글톤 빈의 생성 시점에 주입받게 되므로).
그렇다면 어떻게 사용할 때마다 항상 새로운 프로토타입 빈을 생성할 수 있을까?

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

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

ObjectFactory, ObjectProvider

지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하는 것이 바로 ObjectProvider, ObjectFactory이다. 참고로 과거에는 ObjectFactory가 있었는데(단순히 getObject만 정의한 인터페이스), 여기에 편의기능을 몇가지 추가한 ObjectProvider가 만들어졌다.(ObjectFactory를 상속받은 인터페이스이다.).

핵심 코드 :

@Scope("singleton")
    static class ClientBean {

        @Autowired
        private ObjectProvider<PrototypeBean> prototypeBeanProvider;

        public int logic(){
            PrototypeBean prototypeBean = prototypeBeanProvider.getObject(); //getObject 호출시 그때서야 프로토타입 빈을 찾아서 생성하고 반환해준다
            prototypeBean.addCount();
            return prototypeBean.getCount();
        }
    }

• 실행해보면 prototypeBeanProvider.getObject()을 통해 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
  • 핵심은 프로토타입에서 쓴다는 것이 아니다. 스프링 컨테이너에서 DL하는 과정을 간단하게 도와주는 것이 주요 목적이다.
• ObjectProvider의 getObject()를 호출하면, 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다.(DL)
• 스프링이 제공하는 기능을 사용하지만, 기능이 단순하여 단위테스트를 만들거나 mock코드를 만들기 훨씬 쉬워진다.
• ObjectProvider는 딱 지금 필요한 이정도의 기능만 제공한다.

특징

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

JSR-330 Provider

마지막 방법은 javax.inject.Provider라는 JSR-330 자바 표준을 사용하는 방법이다. 이 방법을 사용하려면 javax.inject:javax.inject:1 라이브러리를 gradle에 추가해야 한다.

빌드 후 핵심 코드

@Scope("singleton")
    static class ClientBean {

        @Autowired
        private Provider<PrototypeBean> prototypeBeanProvider;

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

• 실행해보면 Provider.get()을 통해 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
• Provider의 get()을 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아 반환한다(DL)
• 자바 표준이고, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기 훨씬 쉬워진다.
• Provider는 지금 딱 필요한 DL정도의 기능만 제공한다.

특징 :

• get() 메서드 하나로 기능이 매우 단순하다.
• 별도의 라이브러리가 필요하다.
• 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.

결론

• 그렇다면 언제 프로토타입 빈을 사용할까? 매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용하면 된다. 하지만 실무에서는 싱글톤 빈으로 대부분의 문제를 해결할 수 있어 프로토타입 빈을 직접적으로 사용하는 일은 드물다.
• ObjectProvider, JSR330 Provider등은 프로토타입 뿐 아니라 DL이 필요한 경우는 언제든지 사용 가능하다.

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

참고: 그럼 언제 ObjectProvider, JSR330 Provider를 사용할 것인가 ? ObjectProvider는 DL을 위한 편의 기능을 많이 제공해주고 스프링 외에 별도의 의존관계 추가가 필요 없기 때문에 편리하다. 만약(정말 그럴 일은 없겠지만) 코드를 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 한다면 JSR-330 Provider를 사용해야 한다.

스프링을 사용하다 보면 이 기능 뿐 아니라 다른 기능도 자바 표준과 스프링이 제공하는 기능이 겹칠 때가 많다. 대부분 스프링이 더 다양하고 편리한 기능을 제공해주기 때문에, 특별히 다른 컨테이너를 사용할 일이 없다면 스프링이 제공하는 기능을 사용하면 된다.

웹 스코프

지금까지 싱글톤과 프로토타입 스코프를 학습했다. 싱글톤은 스프링 컨테이너의 시작과 끝까지 함께하는 매우 긴 스코프이고, 프로토타입은 생성과 의존관계 주입 그리고 초기화까지만 진행하는 특별한 스코프이다.
이번에는 웹 스코프에 대해 알아보도록 한다.

웹 스코프의 특징

• 웹 스코프는 웽 환경에서만 동작한다.
• 웹 스코프 타입은 프로토타입 빈과 다르게 해당 스코프의 종료 시점까지 관리한다. 그렇기 때문에 소멸 메소드를 호출할 수 있다.

웹 스코프의 종류

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

네가지 방식 모두 동작이나 구현하는 방식은 비슷하기 때문에, 다음 챕터에서는 request만 예시를 들어 자세히 설명해볼 예정이다.

request 스코프 예제 만들기

예제를 생성하기 위해 우선 build.gradle에 웹과 관련된 dependency를 추가한다.

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

참고 : 해당 라이브러리를 추가하면, 스프링 부트는 내장 톰켓 서버를 활용하여 웹 서버와 스프링을 함께 실행시킨다.

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

request 스코프 예제 개발

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다.
이럴때 사용하기 좋은 것이 바로 request 스코프이다.

다음과 같이 로그가 남도록 request 스코프를 활용해 추가 기능을 개발해보자. 예상 출력 양식 :

[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

• 기대하는 공통 포멧 : [UUID][requestURL]{message}
• UUID를 사용해 HTTP 요청을 구분하자.
• requestURL 정보도 추가로 넣어 어떤 URL을 요청해 남은 로그인지 확인하자.

package hello.core.common;

import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import javax.inject.Scope;
import java.util.UUID;

@Component
@Scope("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 );
    }
}

• 로그를 출력하기 위한 MyLogger 클래스를 만들었다.
• @Scope(value="request")를 사용하여 request 스코프로 지정하였다. 이 때 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.
• 이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메소드를 사용해서 uuid를 생성해 저장해둔다. 이 빈은 HTTP요청당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP요청과 구분할 수 있다.
• 이 빈이 소멸되는 시점에 @PreDestroy를 사용해 종료 메시지를 남긴다.
• requestURL은 빈이 생성되는 시점에 알 수 없으므로 외부에서 setter로 주입받는다.

컨트롤러 생성 코드 :

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
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 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을 myLogger에 저장해둔다. myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 변경되는 걱정은 하지 않아도 된다.
• 컨트롤러에서 controller test라는 로그를 남긴다.

참고 : requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다. 여기서는 예제를 단순화하고, 아직 스프링 인터셉터를 학습하지 않아 위와 같이 작성했다. 스프링 웹에 익숙하다면 인터셉터를 사용해 구현해보자.

서비스단 코드

package hello.core.web;

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

• 비즈니스 로직이 있는 서비스 계층에서도 로그를 출력한다.
• 여기서 중요한 점이 있다. request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면, 파라미터가 많아 지저분해진다. 더더욱이 문제는 requestURL과 같은 웹과 관련된 정보가 웹과 관련없는 서비스 계층까지 넘어가게 된다. 웹과 관련된 부분은 컨트롤러 까지만 사용해야 한다. 서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋다.
• request scope의 MyLogger 덕분에 이런 부분을 파라미터로 넘기지 않고, MyLogger의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.

이제 실행을 해보는데, 아래와 같이 오류가 나는 것을 확인할 수 있다.

Caused by: org.springframework.beans.factory.BeanCreationException: 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;
.

• 스플링 애플리케이션을 실행하는 시점에 싱글톤 빈은 주입해서 생성이 가능하지만, request 스코프 빈은 아직 생성되지 않는다. 이 빈은 실제 고객의 요청이 와야 생성할 수 있다.
• 즉, 싱글톤 컨테이너 생성시 해당 빈(MyLogger)가 생성되지 않아 생긴 오류라고 볼 수 있다.

스코프와 Provider

그럼 앞서 발생한 문제를 어떻게 해결할 수 있을까?
첫번째 해결방안은 Provider를 이용하는 것이다. 간단하게 ObjectProvider를 사용해보자.

컨트롤러단 코드 :

package hello.core.web;

import hello.core.common.MyLogger;
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;
    // MyLogger를 주입받는게 아니라, MyLogger를 찾을 수 있는, DL 할 수 있는 것이 주입됨
    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";
    }


}

서비스단 코드

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.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);
    }
}

위와 같이 코드 작성 후 CoreApplication()의 main() 메소드를 실행하여, http://localhost:8080/log-demo를 접속해보자. 그럴 경우 성공적으로 서버 구동이 되며, 아래와 같이 로그가 뜬다.(여러번 실행해봤다)

[f66e5f0c-184b-4916-a68f-c18c9ce9dac3] request scope bean create:hello.core.common.MyLogger@120dfe9a
[f66e5f0c-184b-4916-a68f-c18c9ce9dac3][http://localhost:8080/log-demo] controller test
[f66e5f0c-184b-4916-a68f-c18c9ce9dac3][http://localhost:8080/log-demo] service id = testId
[f66e5f0c-184b-4916-a68f-c18c9ce9dac3] request scope bean close:hello.core.common.MyLogger@120dfe9a
[89f05ecf-0812-4a87-a7e1-ee5c4d06cd3b] request scope bean create:hello.core.common.MyLogger@4ab2110b
[89f05ecf-0812-4a87-a7e1-ee5c4d06cd3b][http://localhost:8080/log-demo] controller test
[89f05ecf-0812-4a87-a7e1-ee5c4d06cd3b][http://localhost:8080/log-demo] service id = testId
[89f05ecf-0812-4a87-a7e1-ee5c4d06cd3b] request scope bean close:hello.core.common.MyLogger@4ab2110b

• ObjectProvider 덕분에 ObjectProvider.getObject()를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있게 되었다.(정확히는 스프링 컨테이너에게 빈을 요청하는 것을 지연한다)
• ObjectProvider.getObject()를 호출하는 시점에는 HTTP 요청이 진행중이므로 request scope 빈이 정상적으로 생성된다.
• ObjectProvider.getObject()를 LogDemoController, LogDemoService에서 각가 한번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다.

이렇게 끝마쳐도 되지만, 조금,, 아니 훨씬 더 간단한 방법이 더 있다!(다음 챕터에서 배워보자)

스코프와 프록시

이번에는 프록시 방식을 사용해보자.

적용 코드 :

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

• @Scope애노테이션의 파라미터로 proxyMode를 넣어준다.
  • ScopedProxyMode.TARGET_CLASS : 적용 대상이 인터페이스가 아닌 클래스일 경우
  • ScopgedProxyMode.INTERFACE : 적용 대상이 클래스일 경우.
• 이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고, HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.

이렇게 대상 클래스를 프록시 설정 해준 뒤에, 컨트롤러와 서비스는 ObjectProvider를 적용하기 이전의 코드로 되돌려 놓는다.

컨트롤러단 코드 :

package hello.core.web;

import hello.core.common.MyLogger;
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 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";
    }


}

서비스단 코드 :

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final MyLogger myLogger;

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

결과적으로 이전과 완전히 동일하게 서버가 구동되고, 로깅도 정상적으로 적용되는 것을 볼 수 있다. 어떤 원리로 작동되는 것일까??

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

Controller단에 mylogger를 출력하는 코드를 추가하고 그 결과를 확인해보자.

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

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

위 결과를 통해 알 수 있듯이, Proxy로 설정함으로써 우리가 만든 순수한 MyLogger객체가 반환되는 것이 아니라, 바이트코드로 조작된 빈이 반환되는 것을 볼 수 있다.(AppConfig @Configuration 공부할 때도 이와 비슷한 방식으로 출력됐었다)

이렇듯, 스프링 컨테이너는 프록시 설정을 통해 CGLIB라는 라이브러리를 사용하여 내 클래스를 상속받은 가짜 객체를 생성하여 주입한다. 의존관계도 이 가짜 프록시 객체가 주입된다.(ac.getBean() 메서드를 통해 확인 가능)

가짜 프록시 객체의 내부 로직 동작 방식

• 가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있다.
• 클라이언트가 myLogger.logic()을 호출하면, 사실은 가짜 프록시 객체의 메소드를 호출한 것이다.
• 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic()을 호출한다.
• 가짜 프록시 객체는 원본 클래스를 상속받아 만들어졌기 때문에, 클라이언트의 입장에서는 사실 원본인지 가짜인지도 모르게 사용할 수 있다(다형성 적용)

동작 정리

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

특징 정리

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

주의점

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

• 실무에서는 주로 어떤 용도로 request scope을 제일 많이 사용하는가?
• 답변 : request scope 자체가 HTTP 요청 정보의 내용을 편리하게 다룰 수 있기에, 이 요청 정보를 공통화하여 객체로 만들어두고, 공통으로 로그 처리를 하거나 혹은 외부 API를 호출할 때 요청서버에서 넘어온 정보를 함께 넘기거나 할 떄 유용하게 사용할 수 있다.
• 예를 들어 요청서버 -> 현재서버 -> 대상서버라는 구조가 되어있을 때, 요청서버에서 뭔가 요청 ID를 만들어서 현재 서버에 넘겼을 떄 현재서버는 이 요청ID가 비즈니스 로직과는 전혀 상관이 없고, 로그용으로 필요하고 또 대상 서버를 넘길때 필요하다면 계속 가지고 다니기에는 부담스럽다. 이 경우에 사용하면 비즈니스 로직을 전혀 손대지 않고 공통 로그 처리, 외부 API에 파라미터 전달등등 업무를 처리할 수 있다.
• 정리하면 request scope는 비즈니스 로직에 따라 파라미터를 계속 들고다닐 필요 없이 공통 정보를 처리할 때 효과적이다.
• 하지만 request scope와 같은 것을 너무 자주 사용하면 ,http 요청이 없는 테스트 코드 등에서 고민할 내용이 많아지는 단점이 존재한다.

앞선 내용은 김영한 강사님의 스프링 핵심 원리 기본편 강의를 들으며 정리한 내용입니다.