#11 빈 스코프(+Provider, 프록시 모드)

앞에서 우리는 스프링 빈은 스프링 컨테이너의 시작과 함께 생성되고, 컨테이너가 종료될 때 까지 유지된다고 학습했다. 이는 스프링 빈이 기본적으로 '싱글톤 스코프'로 생성되기 때문이다. 여기에서 스코프는 말 그대로 빈이 존재할 수 있는 생명주기 범위를 의미한다.

 

---

# 스프링이 지원하는 다양한 스코프

하지만 필요에 따라 스프링 빈의 생명주기, 즉 스코프를 변경할 수 있다. 스프링은 다양한 스코프를 지원한다.

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

물론 아직 생성되지 않은 스프링빈 (ex request빈을 싱글톤에 주입하려고하는경우)을 사용하면 스프링앱이 안뜬다. 오류발생.
만약 필요하다면 DL(Dependcy Lookup) 기능인 ObjectProvider 등을 사용하면된다. 이는 아래에서 설명.

 

 

# 스프링 빈 스코프 설정 방법

@Scope("prototype")
@Component // 컴포넌트 스캔을 이용한 자동 등록
public class HelloBean {}

@Scope("prototype")
@Bean // 스프링 빈 수동 등록.
PrototypeBean HelloBean() {
    return new HelloBean();
}

 

---

# 프로토타입 스코프란

기존의 싱글톤 스코프 빈을 조회하면, 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환했다. 이는 싱글톤 스코프의 빈이 컨테이너의 생성부터 종료까지 함께하기 때문이다.

 

싱글톤 빈은 의존성 주입(DI)을 하든지 ApplicationContext를 이용해서 빈을 불러오던지 매번 같은 객체를 반환한다. 그런데 때로는 빈을 싱글톤이 아닌 하나의 빈으로 여러개의 객체를 만들어 사용해야 할 때가 있다.

그럴 때 프로토 타입 빈을 사용하는데 프로토타입 빈은 컨테이너에게 빈을 요청할 때마다 매번 새로운 객체를 생성하여 반환해준다.

 

프로토타입 빈의 경우 생성, 의존성주입+초기화 이후 스프링 컨테이너에서 관리하지 않는다. 즉 호출할 때 마다 새로운 빈 객체를 생성하며 종료할 때도 따로 컨테이너가 관리해주는 콜백 메서드를 사용할 수 없다. 만약 @PreDestory 같은 종료 메서드 호출이 필요하다면, 해당 빈을 조회한 클라이언트에서 따로 관리해주어야 한다.

 

---

@ 싱글톤과 프로토타입을 함께 사용할 때 문제점

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

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

각각 다른 인스턴스 객체를 가지기 때문에 addCount()로 카운트를 증가시켜도 각각 고유한 count를 가진다.

만약 싱글톤 빈(clientBean)이 의존관계 주입을 통해서 프로토타입 빈(PrototypeBean)을 주입받으면 어떻게 될까?

컨테이너에서 관리되는 싱글톤 빈에서, 프로토타입 빈을 주입받으면?

• clientBean은 싱글톤이므로, 스프링 컨테이너 생성 시점에 함께 생성되고 의존관계 주입도 발생한다.
• clientBean은 의존관계 자동 주입을 사용한다. 즉 주입 시점에 스프링 컨테이너에서 프로토타입 빈을 요청하게 된다.
• 스프링 컨테이너는 프로토타입 빈을 생성하여 clientBean에 반환한다.
• clientBean은 프로토타입 빈을 내부 필드에 보관한다. (정확히는 인스턴스가 아닌 참조값을 보관한다.)

이 상황에서 addCount()를 클라이언트마다 호출하게 되면 어떻게 될까? 기존의 프로토타입 빈처럼 각각 고유한 count값을 가질까?

 count 값을 프로토타입 객체가 공유해서 사용하고 있다. 즉 클라이언트마다 새로운 객체가 만들어지지 않는다.

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

 

스프링은 일반적으로 싱글톤 빈을 사용하므로, 보통 싱글톤 빈이 프로토타입 빈을 주입받는 경우가 많다. 하지만 싱글톤빈은 생성 시점에만 의존관계 주입을 받기 때문에 주입받은 프로토타입 빈이 싱글톤 빈과 함께 유지되는 문제가 있다.

 

프로토타입 빈은 주입시점에만 새로 생성하고 싶은게 아니라, 사용할 때 마다 새로운 객체를 생성해 반환하는 것을 의도하고 만들었을 것이다. 이를 어떻게 하면 원하는대로 동작하게 바꿀 수 있을까?

 

---

@ 해결책

사실 가장 간단한 해결책은 싱글톤 객체에서 프로토타입 객체를 사용할 때 마다 새롭게 객체를 생성하면 된다. 참고로 이렇게 의존관계를 외부에서 주입(DI)받는게 아니라 객체 내부에서 컨테이너(App..Context)에 있는 의존관계를 찾는 것을 Dependency Lookup(DL, 의존관계 탐색)라고 부른다.

class ClientBean {
    @Autowired
    private ApplicationContext ac;

    public int logic() {
    	// 로직을 실행할 때 마다 새로운 객체 생성
        PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
        prototypeBean.addCount();
        int count = prototypeBean.getCount();
        return count;
    }
}

• 실행해보면 logic()을 실행 할 때 마다 ac.getBean()을 통해 새로운 프로토타입 빈이 생성된다.
• 그런데 이렇게 스프링 앱 컨텍스트를 주입받게 되면, 스프링 컨테이너(App..Context)에 종속적인 코드가 만들어져 유지보수가 어렵고 단위테스트도 매우 까다로워진다.
• 그렇다면 스프링에서 Denpendency Lookup을 해주는 기능은 없을까?

 

---

@ ObjectFactory, ObjectProvider

지정한 빈을 컨테이너에서 대신 찾아주는 DL서비스를 제공해주는 것이 바로 ObjectProvider 이다. 과거에는 ObjectFactory를 사용했는데, 여기에 여러 편의 기능을 추가하여 만든 것이 ObjectProvider이다. 이는 스프링에서 제공하는 기능이라 별도의 라이브러리가 필요하지 않고, 바로 사용할 수 있다. (대신 스프링에 의존적이다. 다른곳에서 사용X)

• ObjectProvider : ObjectFactory를 상속, 옵션이나 스트림 처리등 편의기능 제공. 별도의 라이브러리 필요없음. 

static class ClientBean {
  @Autowired
  private ObjectProvider<PrototypeBean> prototypeBeanProvider;

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

• prototypeBeanProvider.getObject()를 통해서 새로운 프로토타입 빈이 생성된다.
• ObjectProvider의 getObject()가 호출되면, 내부에서 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. (DL)
• 스프링이 제공하는 기능을 사용하지만, 기능이 단순해서 단위테스트를 만들거나 mock 코드(가짜 객체를 이용한 테스트)를 만들기 쉽다.

* ApplicationContext를 mock으로 만들려면 그곳에 있는 수 많은 인터페이스를 모두 구현해야 한다. 반면에 ObjectProvider를 사용하면 그 곳에서 제공하는 매우 적은 인터페이스만 구현해도 되므로 테스트나 mock을 상대적으로 쉽게 만들 수 있다.

 

---

@ JSR-330 Provider (JSR-330 자바 표준)

다만 위의 ObjectProvider는 스프링 프레임워크에서만 사용할 수 있는, 스프링에 의존적인 방법이었다. 의존적이지 않게 자바 표준(javax.inject.Provider)을 사용하는 방법을 알아보자.

 

참고로 스프링 프레임워크에서 해당 기능을 사용하려면 build.gradle에 아래와 같은 설정을 추가해주면 된다.

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

• 아래 코드를 실행해보면 provider.get()을 통해 항상 새로운 프토토타입 빈이 생성된다.
• ObjectProvider와 비슷하게 provider의 get()을 호출하면 스프링 컨테이너에서 해당 빈을 찾아 반환한다(DL)
• 이는 스프링의 기능이 아닌 자바 표준이기에 단위테스트나 코드의 유연성이 훨씬 좋다.
• get() 메서드 하나로 기능이 매우 단순하며, 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용가능하다.
• 다만 별도의 라이브러리 (javax.inject)가 필요하다.

package javax.inject;
public interface Provider<T> {
 T get();
}

//implementation 'javax.inject:javax.inject:1' gradle 추가 필수
static class ClientBean {

    @Autowired
    private Provider<PrototypeBean> provider;

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

 

---

@ 정리

사실 실무에서 웹 앱을 개발하다보면, 대부분 싱글톤 빈으로 해결할 수 있기에 프로토타입 빈을 사용하는 일은 드물다. 하지만 위에서 배운 ObjectProvider, javax.inject.Provider는 프로토타입 빈 뿐만 아니라 위와 같이 컨테이너에서 필요한 의존성을 찾아 직접 주입하는 DL(Dependency Lookup)이 필요한 경우 언제든지 사용할 수 있는 기능이다.

 

또한 Provider를 사용하면 메서드를 호출하는 시점까지 빈 생성을 지연시킬 수 있어서, 아래의 웹 스코프에서 사용하기 좋다. (빈 스코프가 컨테이너와 함께 빈을  생성하지 않고 고객의 요청이 들어와야 시작하기 때문.)

 

* ObjectProvider는 DL을 위한 편의 기능을 많이 제공해주고, 스프링을 사용하면 별도의 설정없이 바로 사용할 수 있어 훨씬 편리하다. 만약 다른 컨테이너에도 사용 할 수 있게 설계해야한다면 자바 표준 Provider를 사용하면 된다. 근데 보통 그런 일은 잘 없긴하다.

* 참고로 스프링이 제공하는 메서드에 @Lookup 어노테이션이 있긴 하지만, 이전 방법들로 충분하기도 하고 해당 어노테이션은 사용시 조심해야 될 부분이 많아서 굳이 설명하지는 않겠다. 쓰지말자.

@Component
@Scope("prototype")
public class SchoolNotification {
    // ... prototype-scoped state
}

// @Lookup을 달면, 매번 새롭게 생성해준다.
@Component
public class StudentServices {

    // ... member variables, etc.

    @Lookup
    public SchoolNotification getNotification() {
        return null;
    }

    // ... getters and setters
}

참고로 이렇게 @Lookup등을 사용하면, 싱글톤 객체에는 프록시가 삽입되어 있다.
그리고 아래와 같이 사용할 때 마다 해당 프록시에서 new Prototype 인스턴스를 생성해주는 형식.

 

---

# 웹 스코프

웹 스코프는 웹 환경에서만 동작한다. 웹 스코프는 프로토타입과는 다르게 스프링이 해당 스코프의 종료시점까지 관리한다. (=종료 메서드가 호출된다.) 기존에 사용하던 싱글톤 빈은 스프링 앱이 실행하는 시점에 생성해서 주입이 가능하지만, 웹 스코프 빈은 실제 요청이 들어와야 생성할 수 있다.

 

참고로 스프링 부트에서는 아래와 같이 웹 라이브러리를 쉽게 추가할 수 있다. 웹 라이브러리가 추가되면 기존에 사용하던 컨테이너 구현체(AnnotationConfigApp..Context) 대신에 AnnotationConfigServletWebServerApplicationContext를 사용하도록 바뀐다. 이는 웹과 관련된 추가 설정들과 환경을 제공해준다.

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

이는 웹 MVC를 공부하게되면 자연스럽게 이해가 된다.

@Component
@Scope(value = "request") // 웹 request 스코프
public class MyLogger {
	public void setRequestURL(String requestURL) {
        this.requestURL = requestURL; // 객체 생성 이후 외부에서 setter로 주입받는다.
    }

	... 생략 ...
    
    @PostConstruct // request 요청이 들어올 때, 빈 생성
    public void init() {
        uuid = UUID.randomUUID().toString(); // UUID를 이용해 각 요청을 구분
        System.out.println("[" + uuid + "] request scope bean create:" + this);
    }

    @PreDestroy // 작업 종료. 빈 소멸
    public void close() {
        System.out.println("[" + uuid + "] request scope bean close:" + this);
    }
}

 

위 코드를 사용하면 HTTP 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

 

---

@ 웹 스코프 종류

세션, 서블릿 컨텍스트, 웹 소켓 같은 용어를 안다면 쉽게 이해할 수 있다. 아래의 스코프들도 결국 적용범위만 다를 뿐, 위 예제의 requset와 크게 다르지않다.

@Component
@Scope(value = "request") // 웹 request 스코프
public class MyLogger {...}

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

사실 스코프를 지정하지 않고 사용한다고 해서, 갑자기 문제가 생기지는 않는다. 하지만 request scope등을 사용하지 않고 파라메타로 모든 정보를 서비스 계층(비즈니스 로직이 있는 곳)에 넘긴다면 관리하는 파라메타가 많아 지저분해진다.

 

더 문제는 requestURL 같은 웹과 관련된 정보가, 전혀 관련없는 비즈니스 서비스 계층까지 넘어간다는 것이다. 웹과 관련된 부분은 컨트롤러까지만 사용해야 한다. 서비스 계층은 웹 기술에 종속되지않고 계층을 분리해서 만드는 것이 유지보수나 확장에 좋기 때문이다.

 

---

# 스코프와 프록시

또한 Provider를 사용하면 메서드를 호출하는 시점까지 빈 생성을 지연시킬 수 있어서, 아래의 웹 스코프에서 사용하기 좋다. (빈 스코프가 컨테이너와 함께 빈을  생성하지 않고 고객의 요청이 들어와야 시작하기 때문.)

사실 이는 Provider 대신 프록시를 이용해서 더 간단하게 구현할 수 있다.

프록시 자체를 잘 모른다면, 나중에 다시 알아보도록하고 이런 방법이 있다는 것만 기억하고 있자. 프록시는 아래와 같이 proxyMode를 이용해서 설정할 수 있다. 

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

• 적용 대상이 인터페이스면 .INTERFACES 를 선택하면 된다.
• 이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다. 우리는 Provider를 신경쓰지 않고, 클래스 사용하듯이 사용하면 된다.
• 의존관계 주입도 가짜 프록시 객체가 주입되게 된다.

 

---

@ Provider를 사용하는 방법

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

 

---

@ 프록시(MyLogger의 가짜 프록시 클래스)를 이용하는 방법

@Controller
@RequiredArgsConstructor
public class LogDemoController {
    private final LogDemoService logDemoService;
    private final MyLogger 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) { // Provider를 사용하지 않고도 동일하게 사용할 수 있다.
        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$$EnhancerBySpringCGLIB가 생성됨을 알 수 있다.
• 그리고 스프링 컨테이너에 "MyLogger"라는 이름으로 진짜 대신에 이 가짜 프록시 객체를 등록한다.
• ac.getBean("myLogger", MyLogger.class)로 조회해도 이 가짜 프록시 객체가 조회되는 것을 확인할 수 있다.
• 즉 의존관계 주입 또한 이 가짜 객체가 주입된다.

다시 아래 그림을 살펴보자.

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

• 클라이언트가 myLogger.logic()을 호출하면 중간에 있는 가짜 프록시 객체의 logic()이 호출된다.
• 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic()을 호출한다.
• 가짜 프록시 객체는 원본을 상속받아 만들었기에, 클라이언트 입장에서 프록시의 존재를 몰라도 동일하게 사용할 수 있다. (다형성)
• 가짜 프록시 객체는 원본이 requset 스코프던 말던 전혀 상관없다. 내부에는 단순한 위임 로직만 있고, 싱글톤처럼 동작한다.

---

@ 프록시의 장점

Scope에 프록시 모드를 지정해주면, 아래와 같은 동작이 일어난다.

• CGLIB라는 라이브러리로 바이트코드를 조작해, 내 클래스를 상속받은 가짜 프록시 객체를 만들어 주입한다.
• 이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어가있다.
• 가짜 프록시 객체는 말 그대로 가짜이기에 실제 객체의 scope와는 전혀 상관없다. 싱글톤 스코프로 사용된다.

 

이렇게 프록시를 사용하면서 아래와 같은 장점을 얻을 수 있다.

• 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯 requset scope를 이용할 수 있다.
• 어노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다. (다형성과 DI 컨테이너의 장점)
• 웹 스코프가 아니더라도, 프록시가 필요한 경우 쉽게 사용할 수 있다.

 

사실 Provider를 사용하든, 프록시를 사용하든 필요한 것은 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 가능하게 한다는 점이다. 이는 요청이 들어올 때 빈을 생성하는 웹 스코프를 마치 '싱글톤을 사용하는 것' 처럼 만들어 주는 것이지, 결국에는 다르게 동작한다는 걸 유의하자.

 

또한 프록시를 사용해서 이렇게 특수한 Scope를 너무 많이 만들게 되면 유지보수가 어려워진다는 걸 명심하자.