[Spring Boot] 9. 빈 스코프

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

스프링 핵심 원리 - 기본편 - 인프런 | 강의

목차

• 빈 스코프란?
• 프로토타입 스코프
• 프로토타입 스코프 - 싱글톤 빈과 함께 사용 시 문제점
• 프로토타입 스코프 - 싱글톤 빈과 함께 사용 시 Provider로 문제 해결
• 웹 스코프
• request 스코프 예제 만들기
• 스코프와  Provider
• 스코프와 프록시

 

빈 스코프란?

---

스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어, 스프링 컨테이너가 종료될 때까지 유지된다.
이것은 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다.
스코프는 번역 그대로 빈이 존재할 수 있는 범위를 뜻한다.

스프링이 지원하는 스코프

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

 

지금가진 싱글톤 스코프를 사용해봤다.
앞으론 프로토타입 스코프부터 확인해보자.

 

프로토타입 스코프

---

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

 

싱글톤 빈 요청

1. 싱글톤 스코프의 빈을 스프링 컨테이너에 요청한다.
2. 스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환한다.
3. 이후에 스프링 컨테이너에 같은 요청이 와도, 같은 객체 인스턴스의 스프링 빈을 반환한다.

 

프로토타입 빈 요청 1

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

프로토타입 빈 요청 2

 

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

정리

스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다.

• 클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입을 관리하지 않는다.
• 프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다.
• 그래서 @PreDestroy 같은 종료 메서드가 호출되지 않는다.

 

싱글톤 스코프 빈 테스트

• 빈 초기화 메서드 실행, 같은 인스턴스의 빈 조회 및 종료 메서드까지 정상 호출됐다.

 

프로토타입 스코프 빈 테스트

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

prototypeBean.destroy();

 

프로토타입 빈의 특징 정리

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

 

 

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

---

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

프로토타입 빈 직접 요청1

1. 클라이언트A가 스프링 컨테이너에 프로토타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(*01)한다. 해당 빈의 count값은 0
3. 클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하며 count 필드를 +1 gksek.

결과적으로 프로토타입 빈(*01)의 count는 1이 된다.

 

스프링 컨테이너에 프로토타입 빈 직접 요청2

• 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(*02)한다. 해당 빈의 count 값은 0
• 클라이언트는 조회한 프로토타입 빈에 addcount()를 호출하며 count 필드를 +1한다.
• 결과적으로 프로토타입 빈(*02)의 count는 1이 된다.

 

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

• clientBean이라는 싱글톤 빈이 의존관계 주입을 통해 프로토타입 빈을 주입받아서 사용하는 예를 보자.

• clientBean은 싱글톤으로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 발생한다.
• 1. clientBean은 의존관계 자동주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.
• 2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환한다. 프로토타입 빈의 count 필드값은 0이다.
• 이제 clientBean은 프로토타입 빈을 내부 필드에 보관한다. (정확히 참조값을 보관)

 

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

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

 

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

• 클라이언트B는 clientBean을 스프링 컨테이너에 요청해서 받는다.
• 싱글톤이므로 항상 같은 clientBean이 반환된다.
• clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다.
  주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성된 것이지, 사용할 때마다 생성되는 것이 아니다.
• 5. 클라이언트 B는 clientBean.logic()을 호출한다.
• 6. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가한다.
• 원래 count값이 1이었으므로 2가 된다.

 

프로토타입 빈이 새로 생성되기는 하지만, 싱글톤과 함께 계속 유지되는 것이 문제다.
아마 원하는 것이 이런 것은 아닐 것이다.
프로토타입 빈을 주입 시점에만 생성하는게 아닌, 사용할 때 마다 새로 생성해서 사용하는 것을 원한다.

 

 

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

---

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

스프링 컨테이너에 요청

• 싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청한다.
•  Dependency Lookup(DL) : 의존관계를 찾는 것. 의존관계 조회(탐색)
• 그런데 이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다.
• 지금 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는, DL 정도의 기능만 제공하는 무언가가 있으면된다.

 

 ObjectFactory, ObjectProvider

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

• 참고로 과거엔 ObjectFactory가 있었는데, 여기에 편의 기능을 추가해 ObjectProvider가 만들어졌다.
• 실행하면, prototypeBeanProvider.getObject()를 통해 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
• ObjectProvider의 getObject()를 호출하면 내부에선 스프링 컨테이너를 통해 해당 빈을 찾아 반환한다. (DL)
• 스프링이 제공하는 기능을 사용하지만, 기능이 단순하므로, 단위테스트를 만들거나 mock 코드를 만들긴 훨씬 쉽다.
• objectProvider는 지금 딱 필요한 DL 정도의 기능만 제공한다.

특징

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

 

JSR-330 Provider

javax.inject.Provider라는 JSR-330 자바 표준을 사용하는 방법이다.

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

 

정리

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

 

참고
실무에서 자바 표준인 JSR-330 Provider를 사용할 것인지, 아니면 스프링이 제공하는 ObjectProvider를 사용할 것인지 고민이 될 것이다.
ObjectProvider는 DL을 위한 편의 기능을 많이 제공해주고 스프링 외에 별도의 의존관계 추가가 필요 없기 때문에 편리하다. 만약(정말 그럴일은 거의 없겠지만) 코드를 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 한다면 JSR-330 Provider를 사용해야한다.
> > 스프링을 사용하다 보면 이 기능 뿐만 아니라 다른 기능들도 자바 표준과 스프링이 제공하는 기능이 겹칠때가 많이 있다. 대부분 스프링이 더 다양하고 편리한 기능을 제공해주기 때문에, 특별히 다른 컨테이너를 사용할 일이 없다면, 스프링이 제공하는 기능을 사용하면 된다.

 

 

웹 스코프

---

싱글톤은 스프링 컨테이너의 시작과 끝까지 함께하는 매우 긴 스코프이고,
프로토타입은 생성과 의존관계 주입, 그리고 초기화까지만 진행하는 특별한 스코프다.

웹 스코프 특징

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

 

웹 스코프 종류

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

 

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

 

 

request 스코프 예제 만들기

---

라이브러리 추가

implementation 'org.springframework.boot:spring-boot-starter-web'

• 위의 라이브러리를 추가하면, 스프링 부트는 내장된 톰켓 서버를 활용해 웹 서버와 스프링을 함께 실행시킨다.
• hello.cor.CoreApplication의 main 메서드 실행하면, 웹 애플리케이션이 실행된다.
• 웹 라이브러리가 없으면, AnnotationConfigApplicationContext를 기반으로 애플리케이션을 구동한다.
• 웹 라이브러리가 추가되면, 웹과 관련된 추가 설정과 환경이 필요하므로, AnnotationConfigServletWebServerApplicationContext를 기반으로 애플리케이션을 구동한다.

이렇게 나오면 성공!

 

request 스코프 예제 개발

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

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

 

MyLogger

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

 

LogDemoController

• 여기서 HttpServletRequest를 통해 요청 URL을 받았다.
• 이렇게 받은 requstURL 값을 myLogger에 저장해둔다.
• myLogger는 HTTP  요청 당 각각 구분되므로, 다른 HTTP  요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.

참고
컨트롤러보다 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다.
여기선 스프링 인터셉터를 학습하지 않았기 대문에 컨트롤러를 사용했다.

 

LogDemoService 추가

• request scope를 사용하지 않고, 파라미터로 이 모든 정보를 서비스계층에 넘긴다면, 파라미터가 많아 지저분해진다. 더 문제는 requestURL 같은 웹 관련 정보가 웹과 관련없는 서비스 계층까지 넘어가게 된다.
• 웹과 관련된 부분은 컨트롤러까지만 사용해야 한다.
• 서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋다.

 

실행하면 아래와 같은 에러가 발생한다.

• MyLogger의 생존범위는 고객 요청이 들어와서 나갈때까지다.
• 따라서 코드를 실행시키면 HTTP request가 없기 때문에 위와 같은 에러가 발생한다.
• Provider로 해결한다. 이건 뒤에 나온다.

 

스코프와  Provider

---

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

Log

 

이걸 더 간단하게 수행하는 방법이 아래 내용이다.

 

스코프와 프록시

---

@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)

• 적용 대상이 인터페이스가 아닌 클래스면, TARGET_CLASS
• 적용 대상이 인터페이스면, INTERFACES
• 이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고, HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해둘 수 있다.

 

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

• CGLIB라는 라이브러리로, 내 클래스를 상속 받은 가짜 프록시 객체를 만들어 주입한다.
• CGLIB라는 바이트코드를 조작하는 라이브로리로, MyLogger를 상속 받은 가짜 프록시 객체를 생성한다.
• 그래서 의존관계 주입도 이 가짜 프록시 객체가 주입된다.

 

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

• 클라이언트가 myLogger.logic()을 호출하면, 사실 가짜 프록시 객체의 메서드를 호출한 것이다.
• 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic()을 호출한다.
• 다형성 : 가짜 프록시 객체는 원본 클래스를 상속 받아 만들어졌기 때문에, 이 객체를 사용하는 클라이언트 입장에선 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있다.
• 가짜 프록시 객체는 실제 request scope와는 관계 없고, 그냥 가짜다. 내부에 단순 위임 로직만 있고, 싱글톤처럼 동작한다.

 

특징 정리

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

 

주의점

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