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

개발할래·2024년 10월 20일

Request Spring scope 기본 빈스코프 스프링 핵심원리

개발

목록 보기

20/21

1. 빈 스코프

스프링 빈이 스프링 컨테이너 시작 및 스프링 컨테이너가 종료 될 때까지 유지된다고 학습
-> 스프링 빈이 기본적으로 싱글톤 스코프로 생성
스코프란 빈이 존재할 수 있는 범위를 뜻함

스프링에서 지원하는 스코프

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

빈 스코프는 다음과 같이 지정할 수 있음

컴포넌트 자동 스캔

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

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

2. 프로토타입 스코프

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

싱글톤 빈 요청
- 싱글톤 스코프의 빈을 스프링 컨테이너에 요청
- 스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환
- 이후에 스프링 컨테이너에 같은 요청이 와도 같은 인스턴스의 스프링 빈을 반환(스프링 빈을 공유해서 사용)
프로토타입 빈 요청(1)
- 프로토타입 스코프의 빈을 스프링 컨테이너에 요청
- 스프링 컨테이너는 이 시점에 프로토타입 빈을(객체를) 생성하고, 필요한 의존관계를 주입 (초기화 메서드까지 호출)
프로토타입 빈 요청(2)
- 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환(그리고 관리 하지 않음)
- 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환

📣 핵심사항

스프링 컨테이너는 프로타입 빈을 생성, 의존관계 주입, 초기화 까지만 처리
클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않음
프로토타입 빈을 관리할 책임은 클라이언트에게 있음, 그러므로 스프링 컨테이너가 호출하는 @PreDestroy 같은 종료 메서드가 호출 되지 않음

1) 싱글톤 스코프 빈 테스트

SingletonTest 클래스
- 빈 초기화 메서드 실행
- 동일한 인스턴스의 빈을 조회
- 종료 메서드 까지 정상 호출 확인

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

PrototypeTest 클래스
- 프로토타입 스코프의 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고, 초기화 메서드 실행
- 싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드가 실행
- 프로토타입 빈은 인스턴스 각각 다름
- 프로토타입 빈은 스프링 컨테이너가 생성과 의존관계 주입 그리고 초기화 까지만 관여 - @PreDestroy 종료메서드 실행X

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

프로토타입 빈 직접 요청

스프링 컨테이너에 프로토타입 빈 직업 요청 - (1)
- 클라이언트A는 스프링 컨테이너에 프로토타입 빈을 요청
- 스프링컨테이너는 프로토타입 빈을 새호 생성하여 반환, 해당 빈의 count 필드 값은 0
- 클라이언트는 조회한 프로토타입 빈에 addCount() 를 호출 - count 필드에 1 추가
- 결과적으로 프로토타입 빈의 count는 1
스프링 컨테이너에 프로토타입 빈 직업 요청 - (2)
- 클라이언트B는 스프링 컨테이너에 프로토타입 빈을 요청
- 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환, 해당 빈의 count 필드 값은 0
- 클라이언트는 조회한 프로토타입 빈에 addCount() 를 호출 - count 필드에 1 추가
- 결과적으로 프로토타입 빈의 count는 1

SingletonWithPrototypeTest1 클래스
- 각각 개별의 스프링 빈이 생성, 초기화도 2번 실행

싱글톤 빈에서 프로토타입 빈 사용
이번에는 clientBean이라는 싱글톤 빈이, 의존관계 주입을 통해서 프로토타입 빈을 주입받아서 사용하는 예

싱글톤에서 프로토타입 빈 사용 - (1)
- clientBean은 싱글톤이므로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 발생
- clientBean은 의존관계 자동 주입을 사용, 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청
- 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환
  프로토타입 빈의 count 필드 값은 0 (스프링 컨테이너는 해당 프로토타입 빈을 관리 하지 않음, 클라이언트가 관리)
- clientBBean은 프로토타입 빈을 내부 필드에 보관
싱글톤에서 프로토타입 빈 사용 - (2)
- 클라이언트 A는 clientBean을 스프링 컨테이너에 요청하여 받음. 싱글톤이므로 항상 같은 clientBean이 반환
- 클라이언트 A는 clientBean.logic()을 호출
- clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가, count값은 1
싱글톤에서 프로토타입 빈 사용 - (3)
- 클라이언트 B는 clientBean을 스프링 컨테이너에 요청해서 받음, 싱글톤이므로 항상 같은 clientBean이 반환
  (clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 괒거에 주입이 완료된 빈, 주입 시점에 스프링 컨테이너에
  요청해서 프로토타입 빈이 새로 생성이 된 것, 사용 할 때마다 새로 생성되는 것이 아니다)
- 클라이언트 B는 clientBean.logic()을 호출
- clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가, count 값이 1에서 2로 증가

SingletonWithPrototypeTest1 클래스 - 코드 추가 후 sinletonClientUsePrototype 테스트 실행
- 싱글톤 빈이 프로토타입 빈을 사용. 그런데 싱글톤 빈은 생성 시점에만 의존관계 주입을 받기 때문에, 프로토타입 빈이 새로 생성되기는 하지만, 싱글톤 빈과 함께 계속 유지되는 것이 문제

참고

여러 빈에서 같은 프로토타입 빈을 주입 받으면, 주입 받는 시점에 각각 새로운 프로토타입 빈이 생성
예) clientA, clientB가 각각 의존관계 주입을 받으면 각각 다른 인스턴스의 프로토타입 빈을 주입
- clientA : prototypeBean@x01
- clientB : prototypeBean@x02
- 물론 사용할 때 마다 새로 생성 X

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

스프링 컨테이너에 요청
싱글톤 빈이 프로토타입을 사용 시 스프링 컨테이너에 새로 요청

예)
static class ClientBean {

 @Autowired
 private ApplicationContext ac;
 
 public int logic() {
      PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
      prototypeBean.addCount();
      int count = prototypeBean.getCount();

      return count;
 }

}

@Autowired로 ApplicationContext를 받아서, logic() 로직을 호출할 때 마다, 스프링 컨테이너에서 프로토타입 빈을 받음
실행해보면 ac.getBean() 을 통해서 항상 새로운 프로토타입 빈이 생성
의존관계를 외부에서 주입(DI) 받는게 아니라 이렇게 직접 필요한 의존관계를 찾는 것을 Dependency Lookup (DL) 의존관계 조회(탐색) 이라 함
스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트가 어려움

✔️ - ObjectFactory, ObjectProvider
지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하는 것이 바로 objectProvider

SingletonWithPrototypeTest1 클래스에 ClientBean을 수정
- 실행 시 prototypeBeanProvider.getObject() 을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인
- ObjectProvider의 getObject()를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아 반환(DL)
- 스프링이 제공하는 기능을 사용하지만, 기능이 단순하여 단위테스트나 mock 코드 만들기가 쉬움
- ObjectProvider는 DL 정도의 기능

✔️- JSR-330 Provider
javax.inject.Provider 라는 JSR-330 자바 표준을 사용하는 방법, 스프링 부트 3.0 이상은 jakarta.inject.Provider 사용
Maven, gradle에 해당 라이브러리를 추가

스프링이 아닌 다른 컨테이너에서 사용
스프링부트 3.0 미만
javax.inject:javax.inject:1 라이브러리를 gradle에 추가
( implementation 'javax.inject:javax.inject:1' )
스프링부트 3.0 이상
jakarta.inject:jakarta.inject-api:2.0.1 라이브러리를 gradle에 추가
( implementation 'jakarta.inject:jakarta.inject-api:2.0.1' )

SingletonWithPrototypeTest1 클래스에 ClientBean을 수정
- provider.get()을 통해서 새로운 프로토 타입 빈이 생성
- provider의 get() 호출 시 내부에서 스프링 컨테이너를 통해 해당 빈을 찾아서 반환(DL)
- 자바 표준이고, 기능이 단순하므로 단위테스트를 만들거나 MOCK 코드를 만들기 쉬움
- Provider는 DL정도 기능 제공

5. 웹 스코프

특징
- 웹 스코프는 웹 환경에서만 동작
- 웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리, 종료 메서드 호출
종류
- request : HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고, 관리
- session : HTTP Session과 동일한 생명주기를 가지는 스코프
- application : 서블릿 컨텍스트(ServletContext)와 동일한 생명주기를 가지는 스코프
- websocket : 웹 소켓과 동일한 생명주기를 가지는 스코프

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

클라이언트 A가 요청
컨트롤러에서 request scope와 관련된 객체를 조회 (예를 들어 로깅), A 클라이언트 전용으로 로깅 객체가 만들어짐, 서비스 객체에서 또 로그 객체를 조회하면
HTTP 요청이 같은 시 같은 객체 인스턴스를 바라봄
동시에 클라이언트 B가 요청
그러면 다른 HTTP 요청이므로, 별도의 B전용 로깅 객체를 생성, 서비스 객체에서 또 로그 객체를 조회하면 HTTP 요청이 같은 시 같은 객체 인스턴스를 바라봄
결과적으로 HTTP 요청에 맞춰서 각각 할당, 요청에 대한 응답이 완료 시 destroy

6. request 스코프 예제 만들기

web 환경에서만 작동

build.gradle
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
}
main 실행
- spring-boot-starter-web 라이브러리 gradle에 추가. 스프링부트 내장 톰켓을 활용하여 웹 서버와 스프링을 함께 실행

request 스코프를 활용한 추가 기능
- 기대하는 공통 포멧: [UUID][requestURL] {message}
common 패키지 > MyLogger 클래스 생성
- 로그 출력을 위한 클래스
- @Scope(value = "request") 를 사용해서 request 스코프로 지정, 빈은 HTTP 요청 당 하나씩 생성, HTTP 요청이 끝나는 시점에 소멸
- 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성하여 저장, HTTP 요청 당 하나씩 생성되므로
  uuid를 저장해두면 다른 HTTP 요청과 구분 가능
- 빈이 소멸되는 시점에 @PreDestroy 를 사용하여 종료 메시지를 남김
- requestURL은 이 빈이 생성되는 시점에는 알 수 없으므로 외부에서 setter로 받음
web 패키지 > LogDemoContoller 클래스 생성
- 로거가 잘 작동하는지 확인하는 테스트용 컨트롤러
- requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용
web 패키지 > LogDemoService 클래스 생성
- 비즈니스 로직이 있는 서비스 계층에서도 로그 출력
실행
- request 스코프 빈이 아직 생성되지 않음

7. 스코프와 Provider

ObjectProvider 사용

LogDemoController 클래스

LogDemoService 클래스

실행
- 잘 작동하는거 확인
- ObjectProvider를 사용하여 ObjectProvider.getObject() 호출하는 시점까지 request scope 빈의 생성을 지연
- ObjectProvider.getObject()를 호출하는 시점에는 HTTP 요청이 진행 중이므로 request scope빈의 생성이 정상 처리
- ObjectProvider.getObject()를 LogDemoController, LogDemoService에서 각각 호출해도 HTTP 요청이 같으면 같은 스프링 빈이 반환

8. 스코프와 프록시

프록시 방식 사용

MyLogger 클래스 수정
- proxyMode = ScopedProxyMode.TARGET_CLASS 추가
  - 적용 대상(MyLogger)이 인테스가 아닌 클래스면 TARGET_CLASS 입력
  - 적용 대상이 인터페이스면 INTERFACES 입력
- MyLogger의 가짜 프록시를 생성하고 HTTP request와 상관없이 가짜 프록시 클래스를 다른 빈에 미리 주입
LogDemoController 클래스
LogDemoService 클래스
실행

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

먼저 주입된 myLogger 확인
System.out.println("myLogger: " + myLogger.getClass());
실행

CGLIB를 통해 클래스를 상복 받은 가짜 프록시 객체를 만들어 주입

@Scope의 proxyMode = ScopedProxyMode.TARGET_CLASS 설정 시
스프링 컨테이너는 CGLIB라는 바이트 코드를 조작하는 라이브러리를 사용하여, MyLogger를
상속받은 가짜 프록시 객체를 생성
스프링 컨테이너에 가짜 프록시 객체를 등록
ac.getBean("myLogger", MyLogger.class) 조회 시 프록시 객체가 조회
그러므로 의존관계 주입도 가짜 프록시 객체가 주입

가짜 프록시 객체는 요청이 오면 그때 내부에서 진짜 빈을 요청하는 위임 로직이 포함

가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있음
클라이언트가 myLogger.logic()을 호출 하는것은 가짜 프록시 객체의 메서드를 호출 하는 것
가짜 프록시 객체는 원본 클래스를 상속 받아서 생성되기 때문에 이 객체를 사용하는 클라이언트 입장에서는
진짜와 가짜를 구별할 수 없어, 동일하게 사용

프록시 동작

CGLIB 라이브러리로 클래스를 상속받은 가짜 프록시 객체를 만들어 주입
해당 가짜 프록시 객체는 실제 요청이 오면 내부에 실제 빈을 요청하는 위임 로직을 포함
가짜 프로식 객체는 실제 request scope와는 관계 없음. 단순하게 생각해서 가짜 프록시이고, 내부에 위임 로직이 포함, 동작을 싱글톤 처럼 함

특징