Spring - 빈 스코프

Hyung Jun·2021년 2월 14일

목록 보기

5/5

빈 스코프

이 글은 '우아한 형제' 개발 팀장 김영한님의 '스프링 핵심원리' 강의를 수강하고, 그 내용을 기반으로 작성한 강의 노트이다.
강의 링크 : 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/dashboard

빈 스코프란?

스코프란 빈이 존재할 수 있는 범위이다.

스프링이 지원하는 스코프의 종류

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

프로토타입 스코프

싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환한다. 반면, 프로토타입 스코프를 스프링 컨테이너에 조회하면 스프링컨테이너는 항상 새로운 인스턴스를 생성에서 반환한다.
스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다.

싱글톤 빈은 스프링 컨테이너 생성 시점에 초괴화 메소드가 실행되지만, 프로토타입 스코프의 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고, 초기화 메소드도 실행된다.
싱글톤 빈은 스프링 컨테이너가 관리하기 때문에 스프링 컨테이너가 종료될 때 빈의 종료 메소드가 실행되지만, 프로토타입 빈은 스프링 컨테이너가 생성과 의존관계 주입 그리고 초기화 까지만 관여하고, 더는 관리하지 않는다. 따라서 프로토타입 빈은 스프링 컨테이너가 종료될 때 @PreDestroy같은 종료 메소드가 전혀 실행되지 않는다.

프로토타입 빈 정리

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

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

스프링 컨테이너에 프로토타입 스코프의 빈을 요청하면 항상 새로운 객체 인스턴스를 반환한다. 이 때 싱글톤 빈을 함께 사용하면 잘 동작하지 않을 수 있는데, 그림과 코드로 설명을 함께하자.

먼저 스프링 컨테이너에 프로토타입 빈을 직접 요청하는 상황을 보면,

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

또 다른 클라이언트B가 프로토타입 빈을 똑같이 요청한다고 해보자.

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

그런데 만약 싱글톤 빈에서 프로토타입 빈을 사용하는 상황을 생각해 보자.

clientBean은 싱글톤이므로, 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 하게 된다. clientBean은 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.
스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환한다. 프로토타입 빈의 count 필드 값은 0이다. 이제 clientBean은 프로토타입 빈을 내부 필드에 보관한다.

이제 클라이언트가 싱글톤빈이 가지고있는 프로토타입빈을 사용한다고 해보자.

클라이언트A는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean이 반환된다. 클라이언트 A는 clientBean.logic()을 호출한다. clientBean은 프로토타입 빈의 addCount()를 호출해서 프로토타입 빈의 count를 증가 시키기고, count 는 1이 된다.

또 다른 클라이언트B가 나타나서 clientBean을 스프링 컨테이너에 요청해서 받는다고 해보자.

clientBean이 내부에 가지고 있는 프로토타입 빈은 과거에 스프링컨테이너가 처음 생성될 때 주입이 끝난 빈이다. 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성된 것이지, 프로토타입 빈을 사용할 때마다 새로 생성되는 것은 아니다.
클라이언트B가 clientBean.logic()을 호출하여 clientBean이 프로토타입빈의 addCount()를 호출해서 프로토타입 빈의 count를 증가한다. 원래 count는 1이였기 때문에 2가 된다.

스프링은 일반적으로 싱글톤 빈을 사용하기 때문에, 싱글톤 빈이 프로토타입 빈을 사용하게된다. 그런데 싱글톤 빈은 생성 시점에만 의존관계 주입을 받기 때문에, 프로토타입 빈이 새로 생성되기는 하지만, 싱글톤 빈과 함께 계속 유지되는 것은 애초에 프로토타입 빈을 생성해서 사용하기 위한 목적과는 다른 문제가 생긴다.
사용할 때마다 새로 생성되는 프로토타입을 만들기 위한 방법은 이제 다음과 같다.

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

가장 간단한 방법은 싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청하는 방법이다.
의존 관계를 외부에서 주입(DI) 받는게 아니라 이렇게 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL) 의존관계 조회(탐색) 이라고 한다. 이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고 단위 테스트도 어려워진다.

ObjectFactory, ObjectProvider

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

@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 코드를 만들기 훨씬 쉬워진다.
ObjectProvider는 딱 필요한 DL기능을 제공한다.

JSR-330 Provider

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

//implementation 'javax.inject:javax.inject:1' gradle 추가 필수 
@Autowired
private Provider<PrototypeBean> provider;
public int logic() {
      PrototypeBean prototypeBean = provider.get();
      prototypeBean.addCount();
      int count = prototypeBean.getCount();
      return count;
}

이 코드를 실행해 보면 provider.get()을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다. provider의 get()을 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다.(DL)
자바 표준이고, 기능이 단순하므로 단위테스트를 만들거나 mock코드를 만들기는 훨씬 쉬워진다.
프로토타입 빈은 언제 사용하나?
매번 사용할 때마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용하면 된다.

웹 스코프

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

웹 스코프의 종류

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

build.gradle에 웹 라이브러리 추가

//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라이브러리르 추가하게 되면 스프링 부트는 내장 톰켓 서버를 이용해서 웹서버와 스프링을 함께 실행시킨다. 스프링 부트는 웹 라이브러리가 없으면 AnnotationConfigApplicationContext를 기반으로 애플리케이션을 구동한다. 웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요하므로 AnnotationConfigServletWebServerApplicationContext를 기반으로 애플리케이션을 구동한다.
만약, 포트 번호를 변경하려면, main/resources/application.properties 에서
server.port = (원하는 포트 번호)
이런식으로 변경할 수 있다.

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을 요청해서 남은 로그인지 확인하자.

MyLogger.java 로그를 출력하기 위한 클래스

package hello.core.common;
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);
      }
}

@Scope(value = "request")를 사용해서 request 스코프로 지정했다. 이제 이 빈은 HTTP 요청 당 하나 씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다. 이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메소드를 사용해서 uuid를 생성해서 저장해둔다. 이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청도 구분할 수 있다. 이 빈이 소멸되는 시점에 @PreDestroy를 사용해서 종료 메시지를 남긴다.
requestURL은 이 빈이 생성되는 시점에는 알 수 없으므로, setter로 입력 받는다.

LogDemoController 로거가 잘 작동하는지 확인하는 테스트용 컨트롤러

package hello.core.web;
import hello.core.common.MyLogger;
import hello.core.logdemo.LogDemoService;
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에 저장해둔다. 컨트롤러에서는 controller test라는 로그를 남긴다.

requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는게 좋다. 스프링 웹에 익숙하다면 인터셉터를 사용해서 구현해보자.

LogDemoService 비즈니스 로직이 있는 서비스계층

package hello.core.logdemo;

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 빈은 생성이 되지 않고 이 빈은 실제 고객이 요청을 해야 생성할 수 있기 때문이다.

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

proxyMode = ScopedProxyMode.TARGET_CLASS 를 추가하면, MyLogger의 가짜 프록시 클래스를 만들어두고, HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수가 있다.

CGLIB 라이브러리

이렇게 할 수 있는 이유는 CGLIB 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어 주입하기 때문이다. @Scope의 proxyMode = scopedProxyMode.TARGET_CLASS를 설정하면 스프링 컨테이너는 CGLIB라는 바이트코드를 조작하는 라이브러리를 사용해서 MyLogger를 상속받은 가짜 프록시 객체를 생성한다. 이렇게 함으로써 스프링 컨테이너에 "myLogger"라는 이름으로 진짜 대신에 가짜 프록시 객체가 등록되고, ac.getBean("myLogger", MyLogger.class)로 조회해도 프록시 객체가 조회되는 것을 확인 할 수 있다.

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

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

정리

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

Hyung Jun

Keep Learning👨🏻‍💻

이전 포스트