빈 스코프

이전에 빈의 생명주기에 따라 초기화, 소멸 콜백 메서드를 지정하는 방법을 알아보았다.

그렇다면 스프링 컨테이너가 관리하는 빈은 언제 생성돼서 언제 소멸될까?

 

---

 

빈 스코프란?

스프링 빈이 언제부터 언제까지 유지되는지, 유지 범위를 의미한다.

스프링은 다양한 스코프를 지원한다

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

빈 스코프 지정 방법

1. 컴포넌트 스캔(자동 등록)

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

 

2. @Bean(수동 등록)

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

 

 

---

 

 

 

 

각 클라이언트마다 다른 빈을 주입받아 쓰고 싶다면 어떡할까?

 

프로토타입 스코프

싱글톤 스코프의 빈을 조회하면, 스프링 컨테이너는 항상 같은 인스턴스의 빈을 반환한다.

반면 프로토타입 스코프의 빈을 조회하면, 스프링 컨테이너는 ①항상 새로운 인스턴스를 생성해서 반환한다.

프로토타입 스코프의 빈은 ②만들고 버린다. 관리하지 않는다.

프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다.
그래서 @PreDestory 같은 종료 메서드가 호출되지 않는다.
필요하면 클라이언트에서 종료 메서드를 직접 호출해줘야 한다.

 

프로토타입의 빈의 프로세스

1. 프로토타입 스코프의 빈을 스프링 컨테이너에 요청한다
2. 스프링 컨테이너는 이 요청 시점에 프로토타입 빈을 생성하고, 필요한 의존관계를 주입하고, 필요에 따라 초기화한다

3. 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환한다 (관리 x)
4. 이후에 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환한다

 

싱글톤과의 비교

스코프	생성/의존관계 주입/초기화 시점	관리	종료 메서드 콜백
싱글톤	컨테이너 생성 시점	컨테이너가 관리	컨테이너 종료시 호출
프로토타입	빈 조회 시점	클라이언트가 관리	호출 X

 

 

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

매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용하면 된다.

(그저 단순한 새로운 객체가 필요하면 new()하면 된다^^. 프로토타입 빈은 컨테이너가 DI까진 해준다!)

사실 싱글톤 빈으로 대부분의 문제를 해결할 수 있기 때문에, 프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다

 

---

 

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

싱글톤 빈에서 프로토타입 빈을 사용할 경우,

프로토타입 빈이 새로 생성되기는 하지만, 싱글톤 빈과 함께 계속 유지되는 문제가 발생할 수 있다.

아래 예시 코드를 보자.

 

사용할 때마다 새로운 객체를 받아쓰려고 프로토타입 빈을 받았다

 

보시다시피 프로토타입 빈이다

 

prototypeBean이 매번 다른 객체이길 원했으나, 같은 객체를 공유하고 있다.

주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것이지,

사용할 때마다 새로 생성되는 것이 아니다!

 

Q. 어떻게 해결할 수 있을지 생각해보자

사용할 때마다 필드로 새로운 빈을 받아 쓰고 싶은 것이다.

그런데 싱글톤 빈 생성 시 생성자로 빈을 주입받아 유지하고 있다.(DI)

매 사용 시점에 빈을 가져오면 된다.

 

이처럼 의존관계를 외부에서 주입(DI) 받는게 아니라 직접 필요한 의존성을 찾는 것을 Dependency Lookup(DL), 의존관계 조회(탐색)이라고 한다.

 

---

 

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

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

어떻게 하면 사용할 때 마다 항상 새로운 프로토타입 빈을 생성할 수 있을까?

 

가장 간단한 방법은

ApplicationContext 필드를 두고서 프로토타입을 사용할 때마다 컨테이너에 새로 요청하는 것이다.(ac.getBean( ))

 

그런데 이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면,

스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다.

 

 

 

우선, 단위 테스트 편의성을 위해 필요한 조회 기능(DL)만 가져다 써보자

1. ObjectProvider (ObjectFactory)

ObjectProvider는 지정한 빈을 컨테이너를 통해 대신 찾아주는 DL 서비스를 제공한다.

ObjectFactory를 상속받아 편의 기능을 추가해서 ObjectProvider가 만들어졌다.

ProtoTypeBean이 아니라 ObjectProvider를 필드로 주입받는다. 그리고 필요할 때 빈을 꺼낸다.

[장점]
ObjectProvider는지금 딱 필요한 DL 정도의 기능만 제공한다.

여전히 스프링이 제공하는 기능을 사용하지만,

기능이 단순하므로 단위 테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다

테스트에서는 가짜 구현체를 만드는 경우가 있다.

이때, 가짜 구현체는 테스트를 실행하는데 필요한 정도만 동작하면 되므로, 모든 기능이 동작하지 않아도 된다.

 

이러한 관점에서,

ApplicationContext를 mock으로 만들려면 그곳에 있는 수많은 인터페이스를 모두 구현하나,

ObjectProvider를 사용하면 매우 적은 인터페이스만 구현해도 되므로 mock을 상대적으로 쉽게 만들 수 있다.

 

[단점]

스프링에 의존

 

---

 

다음으로 스프링의 기능이 아닌 자바 표준을 사용하는 방법을 알아보자

2. JSR-330 Provider

javax.inject.Provider라는 JSR-330 자바 표준이다.

provider의 get()을 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. (DL)

필드로 PrototypeBean이 아닌 Provider를 받는다. 필요할 때 빈을 꺼낸다.

[장점]

기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다.

자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.

 

[단점]

이 방법을 사용하려면 javax.inject:javax.inject:1 라이브러리를 gradle에 추가해야 한다..

 

---

 

정리

ObjectProvider는 DL을 위한 편의 기능을 많이 제공하며, 별도의 의존관계 추가가 필요없기 때문에 편리하다.

만약 코드를 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 한다면 JSR-330 Provider를 쓰자.(그럴 일 거의 없다)

 

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

 

 

---

 

 

웹 스코프

웹 스코프는 ①웹 환경에서만 동작한다.

웹 스코프는 프로토타입과 다르게, ②스프링이 해당 스코프의 종료시점까지 관리한다. (따라서 종료 메서드 호출된다)

웹 스코프의 종류

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

 

---

 

request 스코프를 예제로 설명하겠다. 나머지도 범위만 다르지 동작 방식은 비슷하다.

request 스코프

HTTP request 요청 당 각각 할당되는 request 스코프

요청이 n개면 빈도 n개 생성되며, 같은 http 요청에 대하여 같은 빈을 반환한다.

각 요청에 대해 프로토타입처럼 생성되고, 같은 요청에 대해서는 싱글톤처럼 동작한다.

 

request 스코프 사용

1. 웹 환경 추가

웹 스코프는 웹 환경에서만 동작하므로 web 환경이 동작하도록 라이브러리를 추가

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

spring-boot-starter-web 라이브러리를 추가하면,
스프링 부트는 내장 톰캣 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.

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

 

 

2. 사용 상황

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다.

이럴 때 사용하기 좋은 것이 바로 request 스코프이다. (HTTP 요청이 구분되므로)

 

request 스코프를 활용해서 공통 포맷으로 로그를 출력해 구분해보자

공통 포맷: [UUID][requestURL] {message}

- UUID: HTTP 요청을 구분하기 위한 Id

 

이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다

myLogger는 HTTP 요청 당 각각 구분된다

※ 실제로는 requestURL을 MyLogger에 저장하는 부분은

컨트롤러보단 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 것을 활용하는 것이 좋다

 

Service 객체도 로거 빈을 필드로 주입받는다

여기서 잠깐,

Q. request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면?

1. 파라미터가 많아서 지저분해진다.

2. requestURL 같은 웹과 관련된 정보가 웹과 관련 없는 서비스 계층까지 넘어가게 된다.
   웹과 관련된 부분은 컨트롤러까지만 사용해야 한다.

   서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋다.

 

그런데 이 코드를 실행하면 다음과 같은 오류가 발생한다..!

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;

 

Q. 왜 이런 오류가 발생할까?

request 스코프 빈은 아직 생성되지 않아 주입할 수 없다. 이 빈은 실제 고객의 요청이 와야 생성할 수 있다!

 

Q. 어떻게 해결할 수 있을까? 배운 걸 떠올려보자

요청이 올 때까지 빈 조회를 지연해야 한다.

1. Provider를 활용해서 필요한 시점에 조회해주면 된다 (DL)

2. Proxy를 활용해서 먼저 가짜 빈을 주입하고, 진짜 객체 조회를 꼭 필요한 시점까지 지연 처리한다

 

---

 

[해결 1] Provider를 활용한 request 스코프 빈 사용

첫 번째 해결방안은 Provider를 사용해 요청 시점에 DL 하는 것이다.

 

request 스코프 빈이 아닌 ObjectProvider를 필드로 받는다

서비스는 컨트롤러에서 생성한 myLogger 빈과 같은 빈을 조회하게 된다

ObjectProvider 덕분에 ObjectProvider.getObject()를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.

ObjectProvider.getObject() 호출 시점에는 HTTP 요청이 진행 중이므로 request scope 빈의 생성이 정상 처리된다.

ObjectProvider.getObject()를 LogDemoController, LogDemoService에서 각각 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다.

 

[결과]

컨테이너가 관리하므로, 초기화/종료 메서드 콜백까지 진행된다.

 

---

 

 

[해결 2] 프록시를 활용한 request 스코프 빈 사용

단지 request 스코프 빈 클래스에 proxyMode = ScopedProxyMode.TARGET_CLASS를 추가하면 된다.

 

적용 대상이 클래스면 TARGET_CLASS, 인터페이스면 INTERFACE

이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고

HTTP request와 상관없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다

 

Q. 어떻게 이런 일이 가능할까? AOP의 동작 원리를 상기해보자

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

2. 이 가짜 프록시 객체는 실제 요청이 오면, 그때 내부에서 실제 빈을 요청하는 위임 로직을 갖고 있다.

 

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

1. CGLIB이라는 바이트코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받은 가짜 프록시 객체를 생성한다

• 실제로 주입된 myLogger를 출력해보면 순수한 MyLogger 클래스가 아니라
  MyLogger$$EnhancerBySpringCGLIB이라는 클래스로 만들어진 객체가 대신 등록된 것을 확인할 수 있다

2. 스프링 컨테이너에 "myLogger"라는 이름으로 진짜 대신에 이 가짜 프록시 객체를 등록한다

• ac.getBean("myLogger", MyLogger.class)로로 조회해도 프록시 객체가 조회되는 것을 확인할 수 있다.

3. 그래서 의존관계 주입도 이 가짜 프록시 객체가 주입된다

 

4. 가짜 프록시 객체는 실제 객체의 기능이 호출될 때 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다.

• 가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있다.
• 클라이언트가 myLogger.logic()을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.
• 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic()을 호출한다.
• 가짜 프록시 객체는 실제 request scope와는 관계가 없다. 그냥 가짜이고, 내부에 단순한 위임 로직만 있고, 싱글톤 처럼 동작한다.

프록시 전략. 일단 프록시 빈을 앞 세운다.

 

다형성과 DI 컨테이너가 가진 큰 강점을 볼 수 있다.

가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에,

이 객체를 사용하는 클라이언트 입장에서는 진짜인지 아닌지도 모르게, 동일하게 사용할 수 있다(다형성)

여기에 DI 컨테이너를 이용해서 코드 변경없이 주입받을 수 있다.

 

주의점

1. 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope를 사용할 수 있다.
    하지만 진짜 싱글톤 빈은 아니기 때문에 주의해야 한다.

2. 이런 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용하자, 무분별하게 사용하면 유지보수하기 어려워진다.

 

 

 

 

---

 

참고 자료
스프링 핵심 원리(김영한 님)