Spring Framework - 빈 스코프

빈 스코프란?

스프링 빈이 존재할 수 있는 범위 혹은 생명주기

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

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

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

// 수동 등록
@Scope("prototype")
@Bean
PrototypeBean HelloBean() {
    return new HelloBean();
}

프로토타입 스코프

싱글턴 스코프 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환함. 반면에 프로토타입 스코프를 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환함

프로토타입 빈 요청에 대한 흐름은 아래와 같음

Alt text

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

Alt text

스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환
이후 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성하여 반환

주요 핵심은 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화 까지만 처리한다는 것. 클라이언트에 반환하고 난 이후부터 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않고 관리 책임은 모두 프로토타입 빈을 받은 클라이언트에 있음. 그러므로 @PreDestory 같은 종료 메서드가 호출되지 않음

프로토타입빈의 특징은 아래과 같음

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

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

싱글턴 스코프의 스프링 빈이 프로토 타입 스코프 빈을 소유하여 의존관계가 형성되는 구조의 경우, 프로토타입 빈의 사용의도와는 다른 문제가 발생하게 됨

프로토타입 빈 직접 요청의 경우

Alt text

클라이언트A는 스프링 컨테이너에 프로토타입 빈을 요청
스프링 컨테이너는 프로토타입 빈을 새로 생성하여 반환(x01) 하며 해당 빈의 count 값은 0
클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하여 count 값을 1 더함
결과적으로 프로토타입 빈(x01)의 count 는 1

Alt text

클라이언트B는 스프링 컨테이너에 프로토타입 빈을 요청
스프링 컨테이너는 프로토타입 빈을 새로 생성하여 반환(x02) 하며 해당 빈의 count 값은 0
클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하여 count 값을 1 더함
결과적으로 프로토타입 빈(x02)의 count 는 1

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

Alt text

clientBean은 싱글턴이므로 보통 스프링 컨테이너 생성 시점에 함께 생성되며 의존관계 주입도 발생하게 됨
clientBean은 의존관계 자동주입으로 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청함
스프링 컨테이너는 프로토타입 빈을 생성하여 clientBean에 반환함. 이때 프로토타입 빈의 count 값은 0
이후 clientBean은 프로토타입 빈을 내부 필드에 보관함(참조값을 보관)

Alt text

클라이언트A는 clientBean을 스프링 컨테이너에 요청하여 받음
- 이때 싱글턴 빈이므로 항상 같은 clientBean이 반환됨
클라이언트A는 clientBean.logic()을 호출함
clientBean은 prototypeBean의 addCount()를 호출하여 count 값을 1 더하여 count 값이 1이됨

Alt text

클라이언트B는 clientBean을 스프링 컨테이너에 요청하여 받음
- 이때 싱글턴 빈이므로 클라이언트A와 같은 clientBean이 반환됨
- 해당 시점에 주요 포인트는 clientBean이 내부에 소유하고 있는 프로토타입 빈은 이미 과거에 의존관계 주입이 끝난 빈임. 즉, 의존관계 주입 시점에 스프링컨테이너에 요청하여 프로토타입 빈이 새로 생성된 것이지, 사용할 떄마다 새로 생성되지 않음
클라이언트B는 clientBean.logic()을 호출함
clientBean은 prototypeBean의 addCount()를 호출하여 count 값을 1 더하여 count 값이 2가 됨

싱글턴 빈은 생성 시점에만 의존관계를 주입 받기 떄문에 프로토타입 빈이 새로 생성되긴 하지만 처음 생성된 프로토타입 빈이 싱글톤 빈과 함꼐 계속 유지되는 것이 문제 포인트

여러 빈에서 같은 프로토타입 빈을 주입 받으면 주입 받는 시점에 각각 새로운 프로토타입 빈이 생성됨 clientA -> prototypeBean@x01 clientB -> prototypeBean@x02

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

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

  
class ClientBean {
  @Autowired
  private ApplicationContext ac;

  public int logic() {
    PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
    ...
  }
}

이렇게 의존관계를 외부에서 주입(DI) 받는게 아니라 직접 필요한 의존관계를 찾는것을 DL(Dependency Looup) 혹은 의존관계 조회(탐색) 이라고 함

그러나 위와 같이 스프링의 어플리케이션 컨텍스트 전체를 주입받게 되면 스프링 컨테이너에 종속적인 코드가 되며 단위 테스트에 어려움이 있음

ObjectFactory, ObjectProvider

지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공해 주는것이 ObjectProvider(과거에는 ObjectFactory) 임

  
@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanProvider;

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

ObjectProvicer의 getObject()를 호출하면 내부에선 스프링 컨테이너를 통해 해당 빈을 찾아 반환(DL) 스프링에 의존적인 방법

JSR-330 Provider

다른 방법으로는 javax.inject.Provider(스프링 부트 3.0은 jakarta.inject.Provicer) 라는 JSR-330 자바 표준을 사용하는 방법이 있음

해당 방법은 다음 라이브러리를 추가 해주어야 함

스프링 부트 3.0 미만
- javax.inject:javax.inject:1
스프링 부트 3.0 이상
- jakarta.inject:jakata.inject-api:2.0.1

  
@Autowired
private Provider<PrototypeBean> provider;

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

Provider의 get() 을 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환(DL) 자바 표준이므로 스프링이 안니 다른 컨테이너에서도 사용 가능

정리

주로 실무에서 웹 어플리케이션을 개발할떄는 싱글턴 빈으로 대부분의 문제를 해결할 수 있기 때문에 프로토타입 빈을 직접적으로 사용하는 일은 매우 드음. 다만 매번 사용하 떄 마다 의존관계 주입이 완료된 새로운 객체가 필요할때 프로토타입 빈을 사용함

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

웹 스코프

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

웹 스코프의 종류는 아래과 같이 여러 종류가 있음

request
- HTTP 요청 하나가 들어오고 나갈 떄 까지 유지되는 스코프
- 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리됨
session
- HTTP Session과 동일한 생명주기를 가지는 스코프
application
- 서블릿 컨텍슽트(ServletContext)와 동일한 생명주기를 가지는 스코프
websocket
- 웹 소켓과 동일한 생명주기를 가지는 스코프

스코프와 프록시

  
@Component
@Scope(value = "request")
public class MyLogger {
}

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

위와 같이 로그 클래스가 있고 request 마다 해당 로그 클래스를 주입받아 사용하려 할때, 실행해보면 런타임시 에러가 발생함

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 스코프 빈은 아직 HTTP reeust가 오기 전이므로 생성되지 않았기 떄문임

위와 같은 문제를 해결하기 위해선 아래와 같이 두가지 방법을 사용할 수 있음

ObjectProvider, JSR-330 Provicer 를 사용
프록시 방식 사용

ObjectProvider, JSR-330 Provicer 사용하는 방법에 대해선 위 내용에 대해 그대로 따라하면 되므로 넘어가고 프록시 방법에 대해 확인해보면 아래와 같음

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

ProxyMode = ScopedProxyMode.TARGET_CLASS를 추가

적용 대상이 클래스면 TARGET_CLASS 를 선택
적용 대상이 인터페이스면 INTERFACES 를 선색

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

동작을 확인하기 위해 주입된 myLogger를 확인해 보면 아래와 같음

  
@Controller
@RequiredArgsConstructor
public class LogDemoController {
  private final MyLogger myLogger;

  @RequestMapping("log-demo")
  @ResponseBody
  public String logDemo(HttpServletRequest req) {
    System.out.println("mylogger : " + myLogger.getClass());

    ...

  }
}

mylogger : class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$33575f05

CGLIB이라는 라이브러리로 내 클래스를 상속받은 가짜 프록시 객체를 만들어서 주입된 것을 확인

@Scope의 proxyMode = ScopedProxyMode.TARGET_CLASS 를 설정하면 스프링 컨테이너는 CGLIB 이라는 바이트코드를 조작하는 라이브러리를 사용하여 MyLogger를 상속받는 가까 프록시 객체를 생성함
이후 스프링 컨테이너에 “myLogger” 라는 이름으로 진짜 대신에 이 가짜 프록시 객체를 등록함
그러므로 의존관계 주입도 이 가짜 프로시 객체가 주입됨

Alt text

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

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

동작에 대하여 정리하면 아래와 같음

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

Provider를 사용하든 프록시를 사용하든 주요 포인트는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 것 또한 꼭 웹 스코프가 아니더라도 프록시는 사용가능

주의해야 할 점으로는

싱글턴 처럼 동작하지만 결국 싱글턴이 아니고 다르게 동작하기 떄문에 주의가 필요
이러한 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용해야 유지보수에 어려움이 없음

참고

스프링 핵심 원리 - 기본편(김영한)

Spring Framework - 빈 스코프

빈 스코프란?

프로토타입 스코프

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

프로토타입 빈 직접 요청의 경우

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

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

ObjectFactory, ObjectProvider

JSR-330 Provider

정리

웹 스코프

스코프와 프록시

Further Reading

Spring Framework - 객체 지향 설계와 스프링

Spring Framework - 핵심 원리 이해(예제 만들기)

Spring Framework - 핵심 원리 이해