[Spring] 스프링 핵심 원리 기본편 9) 빈 스코프

스프링 핵심 원리 - 기본편

Session 9 빈 스코프

1. 빈 스코프란?

1) 빈 스코프란?

이전 강의까지 스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어 스프링 컨테이너가 종료될 때까지 유지된다고 배웠다.

스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문.

스코프는 빈이 존재할 수 있는 범위를 의미한다.

 

2) 스프링이 지원하는 스코프

싱글톤 : 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프

프로토타입 : 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더 이상 관여하지 않는 매우 짧은 범위의 스코프

웹 관련 스코프

request : 웹 요청이 들어오고 나갈 때까지 유지되는 스코프

session : 웹 세션이 생성되고 종료될 때까지 유지

application : 웹의 서블릿 콘텍스트와 같은 범위로 유지

 

3) 빈스코프 지정

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

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

---

2. 프로토타입 스코프

1) 프로토타입 스코프

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

프로토타입 스코프를 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환

 

2) 싱글톤 빈 요청

싱글톤 스코프의 빈을 스프링 컨테이너에 요청한다.

스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환

이후에 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈을 반환

 

3) 싱글톤 빈 테스트 결과

SingletonBean.init
singletonBean1 = hello.core.scope.PrototypeTest$SingletonBean@54504ecd
singletonBean2 = hello.core.scope.PrototypeTest$SingletonBean@54504ecd org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing SingletonBean.destroy

빈 초기화 메서드 실행하고 같은 인스턴스 빈 조회하고 종료 메서드까지 정상 호출

 

4) 프로토타입 빈 요청

프로토타입 스코프의 빈을 스프링 컨테이너에 요청한다.

스프링 컨테이너는 프로토타입 빈을 생성하고 필요한 의존 관계를 주입한다.

스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환

이후 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환

 

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

@Test
void prototypeBeanFind() {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);
    // PrototypeBean.class 지정해주면 컴포넌트 스캔 대상처럼 동작 알아서 빈 등록해줌
    System.out.println("find prototypeBean1");
    PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);

    System.out.println("find prototypeBean2");
    PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);

    System.out.println("prototypeBean1 = " + prototypeBean1);
    System.out.println("prototypeBean2 = " + prototypeBean2);

    assertThat(prototypeBean1).isNotSameAs(prototypeBean2);

    // 필요하다면 직접 호출
    prototypeBean1.destroy();
    prototypeBean2.destroy();

    // 호출되지 않는다.
    ac.close();
}

 

6) 프로토타입 스코프 빈 테스트 결과

find prototypeBean1 PrototypeBean.init
find prototypeBean2 PrototypeBean.init
prototypeBean1 = hello.core.scope.PrototypeTest$PrototypeBean@13d4992d
prototypeBean2 = hello.core.scope.PrototypeTest$PrototypeBean@302f7971 org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing

스프링 컨테이너에서 빈을 조회할 때 생성되고 초기화 메서드도 실행

2번 조회 시 2번 모두 다른 스프링 빈 생성, 초기화도 2번 실행

스프링 컨테이너가 생성과 의존관계 주입, 초기화까지만 관여하기 때문에 종료 메서드가 실행되지 않는다.

필요하다면 직접 호출해서 사용

 

7) 정리

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

클라이언트에게 빈을 반환하고 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다. 

프로토타입 빈을 관리할 책임은 클라이언트에게 있다 → @PreDestroy 같은 종료 메서드가 호출되지 않는다.

---

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

1) 프로토타입 빈 직접 요청

클라이언트 A와 B는 스프링 컨테이너에 프로토타입 빈 요청

프로토타입 빈을 각각 새로 생성해서 반환 이때 count는 모두 0

클라이언트는 조회한 프로토타입 빈에 addCount() 호출해 1 증가

클라이언트 A와 B의 프로토타입 빈의 count는 모두 1이다.

 

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

 

clientBean은 싱글톤으로 스프링 컨테이너 생성 시점에 생성되고 의존관계 주입도 발생

의존 관계 자동 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청

스프링 컨테이너는 프로토타입 빈을 생성해 clientBean에게 반환 count는 0이다.

clientBean은 프로토타입 빈을 내부 필드에 보관(참조값을 보관)

클라이언트 A가 스프링 컨테이너에게 요청해 clientBean을 받고 logic()을 호출

clientBean은 프로토타입 빈의 addCount() 호출해 1 증가

클라이언트 B가 스프링 컨테이너에게 요청

clientBean이 내부에 가지고 있는 프로토타입 빈은 과거에 주입이 끝난 빈이기 때문에 새로 생성되지 않고 같은 프로토타입 빈을 사용한다.

clientBean을 받고 logic()을 호출(A와 같은 clientBean을 받는다)

clientBean은 프로토타입 빈의 addCount() 호출해 1 증가

count는 2가 된다.

---

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

1) 스프링 컨테이너에 요청

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

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

ac.getBean()을 통해 항상 새로운 프로토타입 빈을 생성

의존관계를 외부에서 주입 DI 받는 게 아니라 직접 필요한 의존관계를 찾는 것을 Dependency Lookup DL 의존관계 조회라고 함

스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면 스프링에 종속적인 코드, 단위테스트가 어려워진다.

지금 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 DL 기능만 필요!

 

2) ObjectFactory, ObjectProvider

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

ObjectFactory : 기능이 단순, 별도의 라이브러리 없음, 스프링에 의존

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

@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

 

3) JSR-330 Provider

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

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

 

라이브러리를 gradle에 추가필요

// 스프링부트 3.0 이상
jakarta.inject:jakarta.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()을 통해 항상 새로운 프로토타입 빈 생성

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

 

4) ObjectProvider vs Provider

ObjectProvider는 DL을 위한 편의기능을 많이 제공 스프링 외에 별도의 의존관계 추가 필요 없어 편리

스프링이 아닌 다른 컨테이너에서도 사용이 필요한 경우 Provider 사용

특별히 다른 컨테이너를 사용할 일이 없다면 스프링이 제공하는 ObjectProvider 사용

---

5. 웹 스코프

1) 웹 스코프

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

 

2) 웹 스코프 종류

request : HTTP 요청 하나가 들어오고 나갈 때까지 유지, 각각 HTTP 요청마다 별도의 빈 인스턴스 생성되고 관리

session : HTTP session과 동일한 생명주기를 가지는 스코프

application : 서블릿 컨텍스트와 동일한 생명주기를 가지는 스코프

websocket :  웹 소켓과 동일한 생명주기를 가지는 스코프

 

3) request 스코프

클라이언트 A 요청이 들어오면 컨트롤러에서 request 스코프 관련 객체를 조회해 A 전용 request 스코프 객체를 생성

클라이언트 B 동시에 요청이 들어오면 B 전용 객체 생성

각각 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리

---

6. request 스코프 예제 만들기

1) 웹 라이브러리 추가

build.gradle에 추가

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

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

웹라이브러리가 없으면 AnnotationConfigApplicationContext를 기반으로 애플리케이션을 구동하고

웹 라이브러리가 추가되면 AnnotationConfigServletApplictionContext를 기반으로 애플리케이션을 구동

 

2) request 스코프 예제 개발

동시에 여러 HTTP 요청이 오면 어떤 요청이 남긴 로그인지 파악이 어려움 ▶ request 스코프 이용

UUID를 사용해서 HTTP 요청을 구분하고 requestURL 정보도 추가로 넣어 어떤 URL을 요청해서 남은 로그인지 확인

 

3) MyLogger 작성

로그를 출력하기 위한 클래스, @Scope(value = "request")를 사용해 request 스코프로 지정

HTTP 요청 당 하나씩 생성되고 HTTP 요청이 끝나는 시점에 소멸

빈이 생성되는 시점에 초기화 메서드 이용 UUID 생성, 다른 HTTP 요청과 구분할 수 있다.

빈이 소멸되는 시점 종료 메서드 이용해 종료 메시지 남김

requestURL은 빈이 생성되는 시점에는 알 수 없으니 외부에서 setter로 입력받음

 

4) LogDemoController 작성

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

HttpServletRequest 통해 requestURL을 받음

requestURL을 myLogger에 저장 myLogger는 HTTP요청 당 각각 구분되니 값이 섞이지 않는다

컨트롤러에서 controller test 로그를 남김

!! requestURL을 myLogger에 저장하는 부분은 공통처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋음

 

5) LogDemoService 작성

비즈니스 로직이 있는 서비스 계층에서도 로그 출력

서비스 계층은 웹 기술에 종속되지 않고 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋음 ▶ 웹 관련 부분은 컨트롤러까지만 사용

request 스코프의 MYLogger 덕분에 웹 관련 정보를 서비스 계층에 파라미터로 넘기지 않고 MyLogger 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.

 

6) 실행

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 요청이 있을 때 생성이 되는 스코프로 스프링 빈 생성이 되지 않아 에러가 발생한다. ▶ Provider 사용해 해결

---

7. 스코프와 Provider

1) ObjectProvider 사용

컨트롤러와 서비스에서 MyLogger에 ObjectProvider 적용

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

ObjectProvider.getObject()를 호출하는 시점에서 HTTP 요청이 진행 중이므로 request 스코프 빈의 생성이 정상 처리, 컨트롤러와 서비스에서 각각 한 번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다.

 

2) 실행

[52726905-20f6-4733-bf70-db9d131d3790] request scope bean create:hello.core.common.MyLogger@79e72c0b
[52726905-20f6-4733-bf70-db9d131d3790][/log-demo] controller test
[52726905-20f6-4733-bf70-db9d131d3790][/log-demo] service id = testId
[52726905-20f6-4733-bf70-db9d131d3790] request scope bean close:hello.core.common.MyLogger@79e72c0b
[902568ef-e42a-4c19-b5b1-8bb61464c183] request scope bean create:hello.core.common.MyLogger@48ad4ec5
[902568ef-e42a-4c19-b5b1-8bb61464c183][/log-demo] controller test
[902568ef-e42a-4c19-b5b1-8bb61464c183][/log-demo] service id = testId
[902568ef-e42a-4c19-b5b1-8bb61464c183] request scope bean close:hello.core.common.MyLogger@48ad4ec5
[b438bbe8-596e-480b-a472-0aa4f8af53e8] request scope bean create:hello.core.common.MyLogger@481c67b9

---

8. 스코프와 프록시

1) 프록시 사용

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

ObjectProvider 사용 전 코드에서 proxyMode = ScopedProxyMode.TARGET_CLASS 추가

적용대상이 클래스면 TARGET_CLASS

인터페이스면 INTERFACES 선택

MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP 요청과 상관없이 가짜 프록시 클래스를 다른 빈에 미리 주입

 

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

myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$b68b726d

주입된 가짜 myLogger를 출력해 보면 CGLIB라는 바이트코드를 조작하는 라이브러리로 MyLogger 클래스를 상속받은 가짜 프록시 객체가 출력된다.

스프링 컨테이너가 myLogger라는 이름으로 가짜 프록시 객체를 스프링 빈으로 등록하고 의존관계 주입도 가짜 프록시 객체가 주입된다.

 

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

내부에 실제 MyLogger를 찾는 방법을 가지고 있다

클라이언트가 myLogger.logic()을 호출하면 가짜 프록시 객체의 메서드를 호출

가짜 프록시 객체가 request 스코프의 진짜 myLogger.logic()을 호출

가짜 프록시 객체는 원본 클래스를 상속받아 만들어졌기 때문에 클라이언트는 원본인지 가짜인지 알 수 없고 원본처럼 동일하게 사용가능(다형성)

 

3) 동작 정리

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

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

가짜 프록시 객체는 실제 request 스코프와는 관계가 없다. 위임 로직만 가지고 있고 싱글톤처럼 동작한다.

 

4) 정리

프록시 객체를 사용하면 클라이언트는 마치 싱글톤 빈을 사용하듯 편리하게 request 스코프를 사용할 수 있다.

Provider나 프록시를 사용하던 진짜 객체 조회를 필요한 시점까지 지연처리한다는게 핵심

애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있는 것이 다형성과 DI컨테이너의 강점이다.

 

5) 주의점

싱글톤처럼 사용하는 것 같지만 다르게 동작하니 주의해서 사용해야 한다.

이런 특별한 스코프는 꼭 필요한 곳에서만 최소화해서 사용