빈 스코프란 말 그대로 빈의 범위, 빈이 존재할 수 있는 범위를 뜻한다.
지금까지 우리는 스프링이 기본적으로 제공해주는 싱글톤 스코프를 사용해왔다.
스프링은 다음 같은 다양한 스코프를 지원한다.
- 싱글톤: 기본 스코프. 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프이다.
- 프로토타입: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 짧은 범위의 스코프.
- 웹 관련 스코프
- request: 웹 요청이 들어오고 나갈 때 까지 유지되는 스코프
- session: 웹 세션이 생성되고 종료될 때 까지 유지되는 스코프
- application: 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프
빈의 스코프는
@Scope("protoytype") 과같이 애노테이션으로 지정할 수 있다.
프로토 타입 스코프
싱글톤 스코프의 빈을 조회할 때 스프링 컨테이너는 항상 같은 인스턴스를 반환한다. 그 이유는 싱글톤 스코프는 스프링 컨테이너의 시작과 종료까지 유지되기 때문이다.
반면 프로토타입 스코프를 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성한다. 그 이유는 역시나 프로토타입 스코프가 적용된 스프링 컨테이너가 프로토타입 빈의 생성과 의존관계 까지만 관여하기 때문이다.
스프링 DI 컨테이너에 프로토타입 스코프 빈이 있을 때 클라이언트가 해당 컨테이너에 빈을 요청하면 모두 다른 인스턴스를 클라이언트에게 반환한다는 것이다.
핵심은 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다는 것이다.
따라서 클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다. 프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에게 있다. 그렇기에 @PreDestroy와 같은 종료 메서드가 호출되지 않는다.
package hello.core_review.scope;
import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;
public class SingletonTest {
@Test
public void singletonBeanFind() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SingletonBean.class);
SingletonBean singletonBean1 = ac.getBean(SingletonBean.class);
SingletonBean singletonBean2 = ac.getBean(SingletonBean.class);
System.out.println("singletonBean1 = " + singletonBean1);
System.out.println("singletonBean2 = " + singletonBean2);
Assertions.assertThat(singletonBean1).isSameAs(singletonBean2);
}
@Scope("singleton")
static class SingletonBean {
@PostConstruct
public void init() {
System.out.println("singletonBean.init");
}
@PreDestroy
public void destroy() {
System.out.println("singletonBean.destroy");
}
}
}
두 인스턴스가 같은 것을 알 수 있다.
package hello.core_review.scope;
import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;
public class PrototypeTest {
@Test
public void prototypeBeanFind() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(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);
Assertions.assertThat(prototypeBean1).isNotSameAs(prototypeBean2);
}
@Scope("prototype")
static class PrototypeBean {
@PostConstruct
public void init() {
System.out.println("PrototypeBean.init");
}
@PreDestroy
public void destroy() {
System.out.println("Prototype.destroy");
}
}
}
하지만 프로토타입은 서로 다른 인스턴스를 반환하고 있다.
또한 @PreDestroy 어노테이션이 붙은 메서드를 실행하지 않는다. 즉 종료 메서드가 호출되지 않는다.
프로토타입 빈은
- 스프링 컨테이너에 의해 요청할 때 마다 새로 생성된다.
- 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입 그리고 초기화까지마 관여한다.
- 종료 메서드가 호출되지 않는다.
- 그래서 프로로타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 한다. 종료 메서드에 대한 호출도 클라이언트가 직접 해야 한다.
하지만 프로토타입 빈을 싱글톤 빈과 함께 사용하게 되면 의도한대로 작동하지 않을 수 있다.
위에서 만든 프로토타입테스트를 조금 바꿔서 클라이언트가 스프링 컨테이너에 프로토타입 빈을 요청하고, 클라이언트가 반환 받은 프로토 타입 빈의 addCount 메서드를 통해 count 필드의 값을 +1 해본다고 해보자.
예상 되는 결과는 두 클라이언트가 프로토타입 빈을 요청하고 받았을 때, 메서드를 실행한다면 count 필드는 각각 1의 값이어야 할 것이다.
package hello.core_review.scope;
import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;
import static org.assertj.core.api.Assertions.*;
public class PrototypeTest {
@Test
public void prototypeBeanFind() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(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);
}
@Test
void prototypeFind() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);
PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
prototypeBean1.addCount();
assertThat(prototypeBean1.getCount()).isEqualTo(1);
PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);
prototypeBean2.addCount();
assertThat(prototypeBean2.getCount()).isEqualTo(1);
}
@Scope("prototype")
static class PrototypeBean {
private int count = 0;
public void addCount() {
count++;
}
public int getCount() {
return count;
}
@PostConstruct
public void init() {
System.out.println("PrototypeBean.init" + this);
}
@PreDestroy
public void destroy() {
System.out.println("Prototype.destroy");
}
}
}
예상하던 결과를 얻었다.
하지만 싱글톤 빈에서 프로톤 타입 빈을 사용하는 경우는 어떨까?
싱글톤 빈과 프로토타입 빈
clientBean이라는 싱글톤 빈이 의존관계 주입을 통해서 프로토타입 빈을 주입받아 사용하는 예를 보자.
clientBean은 싱글톤이기 때문에 보통 컨테이너 생성 시점에 생성되고, 의존 관계 주입도 발생한다.
1. clienBean은 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토 타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환한다. 프로토타입 빈의 count 필드 값은 0이다.
이렇게 되면 clientBean은 프로토타입 빈을 내부 필드에 보관하게 된다. 정확히는 참조값을 보관하게 된다.
이 상황에서 클라이언트A가 clientBean을 요청해서 받았다고 해보자.
클라이언트A 는 clientBean.logic()이라는 메서드를 호출해서 prototype의 addCount() 메서드를 호출해 프로토타입 빈의 count를 증가시켰다.
그리고 클라이언트 B 또한 clientBean을 요청하고 받아 동일한 행동을 했을 때 count 값은 0에서 1 이 되는 것이 아닌 1에서 2가 된다.
이렇게 되는 이유는 clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이기 때문이다.
즉 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성된 것이지, 사용할 때 마다 새로 생성되는 것이 아닌 것이다.
clintBean은 최초에 생성될 때 자동 의존관계 주입을 통해서 prototypeBean을 내부에 갖게 되고 이를 '사용'하는 것이다.
package hello.core_review.scope;
import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;
import static org.assertj.core.api.Assertions.*;
public class SingletonWithPrototypeTest1 {
@Test
void singletonClientUsePrototype() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);
ClientBean clientBean1 = ac.getBean(ClientBean.class);
int count1 = clientBean1.logic();
assertThat(count1).isEqualTo(1);
ClientBean clientBean2 = ac.getBean(ClientBean.class);
int count2 = clientBean2.logic();
assertThat(count2).isEqualTo(2);
}
static class ClientBean {
private final PrototypeBean prototypeBean;
ClientBean(PrototypeBean prototypeBean) {
this.prototypeBean = prototypeBean;
}
public int logic() {
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}
}
@Scope("prototype")
static class PrototypeBean {
private int count = 0;
public void addCount() {
count++;
}
public int getCount() {
return count;
}
@PostConstruct
public void init() {
System.out.println("PrototypeBean.init" + this);
}
@PreDestroy
public void destroy() {
System.out.println("Prototype.destroy");
}
}
}
스프링은 일반적으로 싱글톤 빈을 사용하므로, 싱글톤 빈이 프로토탄입 빈을 사용하게 된다. 그런데 싱글톤 빈은 생성 시점에만 의존 관계 주입을 받기 때문에, 프로토타입 빈이 새로 생성되기는 하지만 싱글톤 빈과 함께 유지되며, 이 부분이 문제인 것이다.
이를 해결하려면 프로토타입 빈을 주입 시점에만 새로 생성하는 것이 아닌, 새로 생성할 때 마다 새로 생성해서 사용해야 할 것이다.
Provider 사용
위에서 말한 것처럼 싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청하게 만들어보자.
package hello.core_review.scope;
import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;
import static org.assertj.core.api.Assertions.assertThat;
public class PrototypeProviderTest {
@Test
void singletonClientUsePrototype() {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);
ClientBean clientBean1 = ac.getBean(ClientBean.class);
int count1 = clientBean1.logic();
assertThat(count1).isEqualTo(1);
ClientBean clientBean2 = ac.getBean(ClientBean.class);
int count2 = clientBean2.logic();
assertThat(count2).isEqualTo(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;
}
}
@Scope("prototype")
static class PrototypeBean {
private int count = 0;
public void addCount() {
count++;
}
public int getCount() {
return count;
}
@PostConstruct
public void init() {
System.out.println("PrototypeBean.init" + this);
}
@PreDestroy
public void destroy() {
System.out.println("Prototype.destroy");
}
}
}
ClientBean 클래스 부분이 바뀌었는데.
ac.getBean()을 통해 항상 새로운 프로토타입 빈이 생성되도록 하였다.
이렇게 외부에서 의존관계를 주입하는 것이 아니라 직접 필요한 의존관계를 찾는 것을 Dependency Lookup (DL)- 의존관계 탐색이라고 한다.
하지만 이렇게 되면 스프링 컨테이너에 종속적인 코드가 되고 단위 테스트가 어려워진다.
지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 기능만 제공해줄 수 없을까?
이 기능이 ObjectProvider이다.
static class ClientBean {
@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanProvider;
public int logic() {
PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}
}
이렇게 바꿔주었다.
ObjectProvider의 getObject() 메서드를 호출하면 내부에서 스프링 컨테이너를 통해 해당 빈을 찾아서 반환해준다. 즉 의존관계 탐색을 수행해주는 것이다.
또 다른 방법은
javax.inject.Provider라는 JSR-330 자바 표준을 사용하는 방법이다.
@Autowired
private Provider<PrototypeBean> provider;
public int logic() {
PrototypeBean prototypeBean = provider.get();
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
get() 메서드가 getObject() 메서드와 같은 기능을 수행해준다.
자바 표준이기 때문에 mock 코드를 만들기는 더 쉽다.
스프링 이외에 다른 컨테이너를 사용하게 된다면 JSR-330 Provider를 사용하지만 아니라면 ObjectProvider를 사용하면 된다.
프로로타입 빈은 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요할 때 사용한다.
웹 스코프
이번에는 웹 스코프에 대해 알아보자.
웹 스코프는
웹 환경에서만 동작한다.
프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다. 따라서 종료 메서드가 호출된다.
웹 스코프의 종류는
- request: HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프이다. 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리된다.
- session: HTTP Session과 동일한 생명주기를 가지는 스코프
- application: 서블릿 컨텍스트와 동일한 생명주기를 가지는 스코프
- websocket: 웹 소켓과 동일한 생명주기를 가지는 스코프
여기서는 request 스코프를 예제로 설명할 것이다. 나머지도 범위만 다르고 동작 방식은 유사하다.
동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다.
이럴때 사용하기 좋은 것이 request 스코프이다.
package hello.core_review.common;
import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;
import java.util.UUID;
@Component
@Scope(value = "request")
public class MyLogger {
private String uuid;
private String requestURL;
public void setRequestURL(String requestURL) {
this.requestURL = requestURL;
}
public void log(String message) {
System.out.println("[" + uuid + "]" + "[" + requestURL + "]" + message);
}
@PostConstruct
public void init() {
uuid = UUID.randomUUID().toString();
System.out.println("[" + uuid + "] request scope bean crate: " + this);
}
@PreDestroy
public void close() {
System.out.println("[" + uuid + "] request scope bean clos" + this);
}
}
UUID {message}라는 공통 포멧을 만들기 위해 MyLogger라는 클래스를 만들었다.
UUID를 통해서 HTTP 요청을 구분하자.
requestURL 정보도 추가로 넣어 어떤 URL을 요청해서 남은 로그인지 확인해보자.
@Scope(value = "request")를 사용해 request 스코프로 지정한다.
이제 이 빈은 HTTP 요청 당 하나씩 생성되며, HTTP 요청이 끝나는 시점에 소멸되게 된다.
이 빈이 생성되는 시점에 @PostConstruct 초기화 메서드를 사용해 uuid를 생성하고 저장해두어었다.
uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있게 된다. HTTP 요청당 하나씩 생성되기 때문이다.
또한 빈이 소멸되는 시점에 @PreDestroy 메서드를 통해 종료 메시지를 남기게 했다.
package hello.core_review.web;
import hello.core_review.common.MyLogger;
import hello.core_review.logdemo.LogDemoService;
import jakarta.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
@RequiredArgsConstructor
public class LogDemoController {
private final LogDemoService logDemoService;
private final MyLogger myLogger;
@RequestMapping("log-demo")
@ResponseBody
public String logDemo(HttpServletRequest request) {
String requestURL = request.getRequestURL().toString();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testID");
return "OK";
}
}
여기서는 HttpsServletRequeset를 통해서 요청 URL을 받았다.
requestURL 값은 http://localhost:8080/log-demo
이렇게 받은 값을 myLogger에 저장해둔다.
컨트롤러에서 "controller test라는 로그를 남긴다.
package hello.core_review.logdemo;
import hello.core_review.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
import org.springframework.web.bind.annotation.ResponseBody;
@Service
@RequiredArgsConstructor
public class LogDemoService {
private final MyLogger myLogger;
public void logic(String id) {
myLogger.log("service id = " + id);
}
}
비즈니스 로직이 있는 서비스 계층에서도 로그를 출력해보자.
request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면, 파라미터가 많아서 지저분해진다.
더 문제는 requestURL과 같은 웹과 관련된 정보가 웹과 관련 없는 서비스 계층까지 넘어가게 된다는 것이다.
웹과 관련된 부분은 컨트롤러 까지만 사용해야 한다. 서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 더 좋다.
MyLogger가 request scope로 설정됐기 때문에 코드와 계층을 깔끔하게 유지할 수 있는 것이다.
그런데 그냥 실행하면 에러 메시지가 발생한다.
이 빈은 실제 고객의 요청이 와야 생성할 수 있다.
먼저 Provider를 사용해 이 문제를 해결할 수 있다.
@Controller
@RequiredArgsConstructor
public class LogDemoController {
private final LogDemoService logDemoService;
private final ObjectProvider<MyLogger> myLoggerProvider;
@RequestMapping("log-demo")
@ResponseBody
public String logDemo(HttpServletRequest request) {
String requestURL = request.getRequestURL().toString();
MyLogger myLogger = myLoggerProvider.getObject();
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testID");
return "OK";
}
}
@Service
@RequiredArgsConstructor
public class LogDemoService {
private final ObjectProvider<MyLogger> myLoggerProvider;
public void logic(String id) {
MyLogger myLogger = myLoggerProvider.getObject();
myLogger.log("service id = " + id);
}
}
ObjectProvider 덕분에 ObjectProvider.getObject()를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.
getObject() 메서드를 호출하는 시점에는 HTTP 요청이 진행중이기 때문에 request scope 빈의 생성이 정상 처리된다.
스코프와 프록시
이번에는 프록시 방법을 사용해보자.
@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {
provider 사용 전으로 코드를 돌리고 위와 같은 코드를 MyLogger 클래스에 추가한다.
적용 대상이 인터페이스가 아닌 클래스이면 TARGET_CLASS를 선택하고 인터페이스라면 INTERFACES를 선택한다.
이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해둘 수 있다.
위에 간단한 코드만 추가해줬을 뿐인데 어떻게 이것이 가능한 것일까?
CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
스프링 컨테이너는 CGLIB라는 바이트코드를 조작하는 라이브러리를 사용해 MyLogger를 상속받은 가짜 프록시 객체를 생성한다.
그리고 스프링 컨테이너에 myLogger라는 이름으로 진짜 대신 이 가짜 프록시 객체를 등록한다.
의존관계 주입도 이 가짜 프록시 객체가 주입된다.
가짜 프록시 객체는 요청이 오면 그때 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다.
따라서 클라이언트가 myLogger.log()를 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.
가짜 프록시 객체는 request 스코프의 진짜 myLogger.log()를 호출한다.
이 객체를 사용하는 클라이언트 입장에서는 이것이 원본인지 아닌지도 모르게 이를 사용할 수 있는 것이다.
CGLIB 라이브러리로 내 클래스를 상속받은 가짜 프록시 객체를 만들어 주입한다.
그리고 이 가짜 프록시 객체는 실제 요청이 오면 그 때 내부에서 실제 빈을 요청하는 위임 로직을 사용한다.
이렇게 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈처럼 편리하게 request scope를 사용할 수 있다.
사실 Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리하는 것이다!
단지 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다. 이것이 바로 다형성과 DI 컨테이너가 가진 큰 강점이라고 할 수 있다.
하지만 싱글톤처럼 사용할 수 있더라도 싱글톤과 다르게 동작하기에 주의해야하며, 꼭 필요한 곳에 최소해서 특별한 scope를 사용하는 것이 유지 보수 관점에서 더 좋다.
'Spring' 카테고리의 다른 글
| [Spring MVC] 스프링 MVC 패턴 정리 (0) | 2025.03.16 |
|---|---|
| [Spring 핵심 원리 이해] 7. 빈 생명주기 콜백 (3) | 2025.01.07 |
| [Spring 핵심 원리 이해] 6. 의존관계 자동 주입 (6) | 2025.01.03 |
| [Spring 핵심 원리 이해] 5. 컴포넌트 스캔 (3) | 2024.12.28 |
| [Spring 핵심 원리 이해] 4. 싱글톤 컨테이너 (4) | 2024.12.27 |