9.1 빈 스코프
지금까지는 스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어서 스프링 컨테이너가 종료될 때 까지 유지된다고 배웠다.
이것은 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다.
스코프는 빈이 존재할 수 있는 범위를 뜻한다.
스프링 빈이 지원하는 스코프
1) 싱글톤
기본 스코프로 스프링 컨테이너의 시작부터 종료까지 유지되는 가장 넓은 범위의 스코프이다.
(생명주기 == 스프링 컨테이너)
2) 프로토타입
스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프이다.
3) 웹 관련 스코프
- request : 웹 요청이 들어오고 나갈때까지 유지되는 스코프이다.
- session : 웹 세션이 생성되고 종료될 때 까지 유지되는 스코프이다.
- application : 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프이다.
빈 스코프를 지정하는 방법은 다음과 같다.
1) 컴포넌트 스캔 자동 등록
@Scope("prototype")
@Component
public class HelloBean {}
2)수동 등록
@Scope("prototype")
@Bean
PrototypeBean HelloBean() {
return new HelloBean();
}
9.2 프로토타입 스코프
싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환한다.
반면에 프로토타입 스코프를 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환한다.
1. 싱글톤 빈의 경우
클라이언트 A, B, C 가 memberService 스프링 빈을 요청하는 경우
1. 싱글톤 스코프의 빈을 스프링 컨테이너에 요청한다.
2. 스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환한다.
3. 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈을 반환한다.
2. 프로토타입 빈의 경우
클라이언트 A, B, C 가 prototypeBean 스프링 빈을 요청하는 경우
1. 프로토타입 스코프의 빈을 스프링 컨테이너에 요청한다.
2. 스프링 컨테이너는 이 시점에 프로토타입 빈을 생성하고, 필요한 의존관계를 주입한다
3. 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환한다. (더 이상 관리 X)
4. 이후에 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환한다.
[정리]
1) 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다.
2) 클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다.
3) 프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다.
@PreDestroy 같은 종료 메서드가 호출되지 않는다.
1) 싱글톤 스코프 빈 테스트
package hello.core.scope;
import org.junit.jupiter.api.Test;
import
org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import static org.assertj.core.api.Assertions.assertThat;
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);
assertThat(singletonBean1).isSameAs(singletonBean2); // 같은 빈인지 확인
ac.close(); //종료
}
// 싱글톤 스코프
@Scope("singleton")
static class SingletonBean {
@PostConstruct
public void init() {
System.out.println("SingletonBean.init");
}
@PreDestroy
public void destroy() {
System.out.println("SingletonBean.destroy");
}
}
}
실행 결과
SingletonBean.init // 빈 초기화 메서드 실행
singletonBean1 = hello.core.scope.PrototypeTest$SingletonBean@54504ecd // 같은 인스턴스 빈 조회
singletonBean2 = hello.core.scope.PrototypeTest$SingletonBean@54504ecd
SingletonBean.destroy // 종료 메서드 호출
프로토타입 스코프 빈 테스트
package hello.core.scope;
import org.junit.jupiter.api.Test;
import
org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Scope;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
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); // 두개의 빈이 다른지 확인
// prototypeBean1.destroy();
// prototypeBean2.destroy();
ac.close();
}
// 프로토타입 스코프
@Scope("prototype")
static class PrototypeBean {
@PostConstruct
public void init() {
System.out.println("PrototypeBean.init");
}
@PreDestroy
public void destroy() {
System.out.println("PrototypeBean.destroy");
}
}
}
실행 결과
find prototypeBean1
PrototypeBean.init // 새로운 객체 생성
find prototypeBean2
PrototypeBean.init // 새로운 객체 생성
prototypeBean1 = hello.core.scope.PrototypeTest$PrototypeBean@13d4992d
prototypeBean2 = hello.core.scope.PrototypeTest$PrototypeBean@302f7971
싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드가 실행 되지만,
프로토타입 스코프의 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고, 초기화 메서드도 실행된다.
프로토타입 빈을 2번 조회했으므로 완전히 다른 스프링 빈이 생성되고, 초기화도 2번 실행된다.
싱글톤 빈은 스프링 컨테이너가 관리하기 때문에 스프링 컨테이너가 종료될 때 빈의 종료 메서드가 실행되지만,
프로토타입 빈은 스프링 컨테이너가 생성과 의존관계 주입 그리고 초기화 까지만 관여하고, 더는 관리하지 않는다.
따라서 프로토타입 빈은 스프링 컨테이너가 종료될 때 @PreDestroy 같은 종료 메서드가 전혀 실행되지 않는다.
프로토타입 빈의 특징 정리
1) 스프링 컨테이너에 요청할 때 마다 새로 생성된다.
2) 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입 그리고 초기화까지만 관여한다.
3) 종료 메서드가 호출되지 않는다.
4) 그래서 프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 한다. 종료 메서드에 대한 호출도 클라이언트가 직접 해야한다.
9.3 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 문제점
프로토타입 스코프의 빈을 요청하면 항상 새로운 객체 인스턴스를 생성해서 반환한다.
하지만 싱글톤 빈과 함께 사용할 때는 의도한 대로 잘 동작하지 않는다.
1) 프로토타입 빈 직접 요청 예제
1. 클라이언트A는 스프링 컨테이너에 프로토타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x01)한다. 해당 빈의 count 필드 값은 0이다.
3. 클라이언트는 조회한 프로토타입 빈에 addCount() 를 호출하면서 count 필드를 +1 한다.
결과적으로 프로토타입 빈(x01)의 count는 1이 된다.
1. 다른 클라이언트B는 스프링 컨테이너에 프로토타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x02)한다. 해당 빈의 count 필드 값은 0이다.
3. 클라이언트는 조회한 프로토타입 빈에 addCount() 를 호출하면서 count 필드를 +1 한다.
결과적으로 프로토타입 빈(x02)의 count는 1이 된다.
public class SingletonWithPrototypeTest1 {
@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("PrototypeBean.destroy"); // 호출되지 않음
}
}
}
2) 싱글톤 빈에서 프로토타입 빈 사용 예제
clientBean 이라는 싱글톤 빈이 의존관계 주입을 통해서 프로토타입 빈을 주입받아서 사용한다.
clientBean 은 싱글톤이므로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 발생한다.
1. clientBean 은 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean 에 반환한다.
스프링 컨테이너는 더 이상 프로토타입 빈을 관리하지 않으므로, 이는 클라이언트빈이 관리한다.
프로토타입 빈의 count 필드 값은 0이다.
clientBean 은 프로토타입 빈을 내부 필드에 보관한다. (정확히는 참조값을 보관한다.)
클라이언트 A는 clientBean 을 스프링 컨테이너에 요청해서 받는다.
싱글톤이므로 항상 같은 clientBean 이 반환된다.
3. 클라이언트 A는 clientBean.logic() 을 호출한다.
4. clientBean 은 prototypeBean의 addCount() 를 호출해서 프로토타입 빈의 count를 증가한다. count값이 1이 된다.
또 다른 클라이언트 B는 clientBean 을 스프링 컨테이너에 요청해서 받는다.
싱글톤이므로 항상 같은 clientBean 이 반환된다.
여기서 clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다.
주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것이지, 사용 할 때마다 새로 생성되는 것이 아니다.
5. 클라이언트 B는 clientBean.logic() 을 호출한다.
6. clientBean 은 prototypeBean의 addCount() 를 호출해서 프로토타입 빈의 count를 증가한다.
원래 count 값이 1이었으므로 2가 된다.
package hello.core.scope;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import
org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
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);
}
// 싱글톤 스코프
@Scope("singleton")
static class ClientBean {
private final PrototypeBean prototypeBean; // 생성시점에 주입
@Autowired
public 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("PrototypeBean.destroy");
}
}
}
스프링은 일반적으로 싱글톤 빈을 사용하므로, 싱글톤 빈이 프로토타입 빈을 사용하게 된다.
싱글톤 빈은 생성 시점에만 의존관계 주입을 받기 때문에 프로토타입 빈이 새로 생성되기는 하지만,
싱글톤 빈과 함께 계속 유지된다.
하지만 우리는 프로토타입 빈을 주입 시점에만 새로 생성하는게 아니라,
사용할 때 마다 새로 생성해서 사용하는 것을 원한다!
(로직을 호출할 때 마다 applicationContext를 작성해도 되지만 너무 지저분해진다,,)
[참고]
여러 빈에서 같은 프로토타입 빈을 주입 받으면, 주입 받는 시점에 각각 새로운 프로토타입 빈이 생성된다.
예를 들어서 clientA, clientB가 각각 의존관계 주입을 받으면 각각 다른 인스턴스의 프로토타입 빈을 주입 받는다.
clientA -> prototypeBean@x01
clientB -> prototypeBean@x02
물론 사용할 때 마다 새로 생성되는 것은 아니다.
9.4 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 Provider로 문제 해결
싱글톤 빈과 프로토타입 빈을 함께 사용할 때
어떻게 하면 사용할 때 마다 항상 새로운 프로토타입 빈을 생성할 수 있을까?
가장 간단한 방법은 싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청하는 것이다.
public class PrototypeProviderTest {
@Test
void providerTest() {
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("PrototypeBean.destroy");
}
}
}
@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) 의존관계 조회(탐색)라고 한다.
하지만 스프링의 applicationContext 전체를 주입받게 되면,
스프링 컨테이너에 종속적인 코드가 되고 단위 테스트가 어려워진다.
즉 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 DL 정도의 기능만 제공하는 무언가가 있으면 된다.
방법1) ObjectFactory, ObjectProvider
ObjectProvider : 지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스 제공
(과거의 ObjectFactory 를 상속받아, 편의 기능을 추가해서 ObjectProvider 가 만들어졌다.)
// 테스트 이므로 필드 주입 사용
@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanProvider;
public int logic() {
// 스프링 컨테이너에서 해당 빈을 찾아서 반환 (DL)
PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}
테스트 코드를 실행해보면 prototypeBeanProvider.getObject() 을 통해서 항상 새로운 프로토타입 빈이 생성된다.
이는 스프링이 제공하는 기능을 사용하지만 기능이 단순하므로
단위테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다.
ObjectProvider 는 지금 딱 필요한 DL 정도의 기능만 제공한다.
특징
ObjectFactory : 기능이 단순, 별도의 라이브러리 필요 없음, 스프링에 의존
ObjectProvider : ObjectFactory 상속, 옵션, 스트림 처리등 편의 기능이 많고, 별도의 라이브러리 필요 없음, 스프링에 의존
방법2) JSR-330 Provider
마지막 방법은 javax.inject.Provider 라는 JSR-330 자바 표준을 사용하는 방법이다.
스프링 부트 3.0은 jakarta.inject.Provider 사용한다.
먼저, 다음 라이브러리를 gradle에 추가한다.
스프링부트 3.0 미만
javax.inject:javax.inject:1
스프링부트 3.0 이상
jakarta.inject:jakarta.inject-api:2.0.1
@Autowired
// javax.inject Provider 사용
private Provider<PrototypeBean> provider;
public int logic() {
// get() 메서드 사용 : 스프링 컨테이너에서 해당 빈을 찾아서 반환(DL)
PrototypeBean prototypeBean = provider.get(); // get() 메서드 사용
prototypeBean.addCount();
int count = prototypeBean.getCount();
return count;
}
실행해보면 provider.get() 을 통해서 항상 새로운 프로토타입 빈이 생성된다.
자바 표준이고, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기 훨씬 쉽다.
Provider 는 지금 딱 필요한 DL 정도의 기능만 제공한다. (장점도 심플 단점도 심플?)
특징
1) get() 메서드 하나로 기능이 매우 단순하다.
2) 별도의 라이브러리가 필요하다.
3) 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.
정리
프로토타입 빈은 매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용한다.
그런데 실무에서 웹 애플리케이션을 개발해보면 싱글톤 빈으로 대부분의 문제를 해결할 수 있기 때문에
프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다.
ObjectProvider , JSR330 Provider 등은 프로토타입 뿐만 아니라 DL이 필요한 경우는 언제든지 사용할 수 있다.
[참고]
스프링이 제공하는 메서드에 @Lookup 애노테이션을 사용하는 방법도 있다.
[참고]
실무에서 자바 표준인 JSR-330 Provider를 사용할 것인지, 아니면 스프링이 제공하는 ObjectProvider를 사용할 것인지 고민이 될 것이다. ObjectProvider는 DL을 위한 편의 기능을 많이 제공해주고 스프링 외에 별도의 의존관계 추가가 필요 없기 때문에 편리하다. 만약(정말 그럴일은 거의 없겠지만) 코드를 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 한다면 JSR-330 Provider를 사용해야한다.
스프링을 사용하다 보면 이 기능 뿐만 아니라 다른 기능들도 자바 표준과 스프링이 제공하는 기능이 겹칠때가 많이 있다. 대부분 스프링이 더 다양하고 편리한 기능을 제공해주기 때문에, 특별히 다른 컨테이너를 사용할 일이 없다면, 스프링이 제공하는 기능을 사용하면 된다.
9.5 웹 스코프
웹 스코프의 특징
1) 웹 스코프는 웹 환경에서만 동작한다.
2) 웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다.
따라서 종료 메서드가 호출된다.
웹 스코프 종류
1) request
HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고, 관리된다.
2) session
HTTP Session과 동일한 생명주기를 가지는 스코프
3) application
서블릿 컨텍스트( ServletContext )와 동일한 생명주기를 가지는 스코프
4) websocket
웹 소켓과 동일한 생명주기를 가지는 스코프
다음은 request 스코프의 예제이다.
나머지 방식도 범위만 다를 뿐 동작 방식은 비슷하다.
HTTP request 요청 당 각각 할당되는 request 스코프
클라이언트 A와 B가 동시에 요청하면, 각각 다른 인스턴스가 생성된다.
즉 HTTPrequest가 들어오고 나갈 때까지 A와 B 각각 전용 인스턴스가 할당되고 관리된다.
9.6 request 스코프 예제 만들기
1. 웹 환경 추가
웹 스코프는 웹 환경에서만 동작하므로 web 환경이 동작하도록 라이브러리를 추가한다.
build.gradle에 추가
//web 라이브러리 추가
implementation 'org.springframework.boot:spring-boot-starter-web'
hello.core.CoreApplication 의 main 메서드를 실행하면 웹 애플리케이션이 실행된다.
Tomcat started on port(s): 8080 (http) with context path '' Started CoreApplication in 0.914 seconds (JVM running for 1.528)
해당 페이지에 접속하면, 오류 페이지가 뜬다.
[참고]
spring-boot-starter-web 라이브러리를 추가하면 스프링 부트는 내장 톰켓 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.
[참고]
스프링 부트는 웹 라이브러리가 없으면 우리가 지금까지 학습한 AnnotationConfigApplicationContext 을 기반으로 애플리케이션을 구동한다. 웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요하므로 AnnotationConfigServletWebServerApplicationContext 를 기반으로 애플리케이션을 구동한다.
2. request 스코프 예제 개발
동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다.
이때 request 스코프를 활용하면 좋다.
다음과 같이 고객 요청이 들어오면 UUID를 남겨 HTTP 요청을 구분하도록 한다.
또한 requestURL 정보도 추가로 넣어서 어떤 URL을 요청해서 남은 로그인지 확인한다.
공통 포멧 : [UUID][requestURL] {message}
[d06b992f...] request scope bean create
[d06b992f...][http://localhost:8080/log-demo] controller test
[d06b992f...][http://localhost:8080/log-demo] service id = testId
[d06b992f...] request scope bean close
로그 출력을 위한 MyLogger 클래스는 다음과 같다.
package hello.core.common;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.util.UUID;
@Component
@Scope(value = "request") // request 스코프로 지정
public class MyLogger {
private String uuid;
private String requestURL;
// requestURL은 빈이 생성되는 시점에는 알 수 없으므로 나중에 setter로 입력 받도록 함
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 = UUID.randomUUID().toString();
System.out.println("[" + uuid + "] request scope bean create:" + this);
}
@PreDestroy
public void close() {
System.out.println("[" + uuid + "] request scope bean close:" + this);
}
}
@Scope(value = "request")
이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.
@PostConstruct
이 빈이 생성되는 시점에 자동으로 초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다.
이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.
@PreDestroy
이 빈이 소멸되는 시점에 @PreDestroy 를 사용해서 종료 메시지를 남긴다.
로거가 잘 작동하는지 확인하는 테스트용 컨트롤러 LogDemoController는 다음과 같다.
package hello.core.web;
import hello.core.common.MyLogger;
import hello.core.logdemo.LogDemoService;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
@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(); // 고객의 URL을 알 수 있음
myLogger.setRequestURL(requestURL); // URL 정보를 넣어둠
myLogger.log("controller test"); // 컨트롤러
logDemoService.logic("testId"); // 서비스
return "OK";
}
}
1) HttpServletRequest을 통해 요청 URL을 받는다.
2) requestURL 값 http://localhost:8080/log-demo
3) 받은 requestURL 값을 myLogger에 저장한다.
myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이지 않는다.
4) 컨트롤러에서 controller test라는 로그를 남긴다.
[참고]
requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다. 여기서는 예제를 단순화하고, 아직 스프링 인터셉터를 학습하지 않은 분들을 위해서 컨트롤러를 사용했다. 스프링 웹에 익숙하다면 인터셉터를 사용해서 구현해보자.
LogDemoService 코드
package hello.core.logdemo;
import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
@Service
@RequiredArgsConstructor
public class LogDemoService {
private final MyLogger myLogger;
public void logic(String id) {
myLogger.log("service id = " + id);
}
}
request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘길 수 있지만, 파라미터가 많아서 지저분해진다.
또한 requestURL 같은 웹과 관련된 정보가 웹과 관련없는 서비스 계층까지 넘어가게 된다.
웹과 관련된 부분은 컨트롤러까지만 사용해야 한다.
서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋다.
request scope의 MyLogger 덕분에 이런 부분을 파라미터로 넘기지 않고, MyLogger의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.
하지만 앞선 코드를 실행해보면 애플리케이션 실행 시점에 오류가 발생하는 것을 확인할 수 있다.
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;
이는 myLogger는 requestScope이므로 고객의 HTTP request가 들어오고 나갈 때까지 작동하는데,
스프링이 뜰 때 HTTP request 요청이 없기 때문이다
즉 스프링 애플리케이션을 실행하는 시점에 싱글톤 빈은 생성해서 주입이 가능하지만,
request 스코프 빈은 아직 생성되지 않는다. request 스코프 빈은 실제 고객의 요청이 와야 생성할 수 있다.
9.7 스코프와 Provider
앞선 오류를 해결하기 위한 방법은 Provider를 사용하는 것이다.
방법1) ObjectProvider 사용
package hello.core.web;
import hello.core.common.MyLogger;
import hello.core.logdemo.LogDemoService;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
@Controller
@RequiredArgsConstructor
public class LogDemoController {
private final LogDemoService logDemoService;
private final ObjectProvider<MyLogger> myLoggerProvider; // provider 사용
@RequestMapping("log-demo")
@ResponseBody
public String logDemo(HttpServletRequest request) {
String requestURL = request.getRequestURL().toString();
MyLogger myLogger = myLoggerProvider.getObject(); // myLogger를 받음
myLogger.setRequestURL(requestURL);
myLogger.log("controller test");
logDemoService.logic("testId");
return "OK";
}
}
package hello.core.logdemo;
import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Service;
@Service
@RequiredArgsConstructor
public class LogDemoService {
private final ObjectProvider<MyLogger> myLoggerProvider; // Provider 사용
public void logic(String id) {
MyLogger myLogger = myLoggerProvider.getObject(); // getObject() 사용
myLogger.log("service id = " + id);
}
}
main() 메서드로 스프링을 실행한 후
http://localhost:8080/log-demo 웹 브라우저에 접속하면 정상적으로 작동한다.
웹 브라우저에는 OK 화면이 뜨고,
기대했던 로그가 뜨는 것을 확인할 수 있다.
[d06b992f...] request scope bean create
[d06b992f...][http://localhost:8080/log-demo] controller test
[d06b992f...][http://localhost:8080/log-demo] service id = testId
[d06b992f...] request scope bean close
ObjectProvider 덕분에 ObjectProvider.getObject() 를 호출하는 시점까지
request scope 빈의 생성을 지연할 수 있다. (스프링 컨테이너에 요청을 지연)
ObjectProvider.getObject() 를 호출하시는 시점에는 HTTP 요청이 진행중이므로
request scope 빈의 생성이 정상 처리된다.
ObjectProvider.getObject() 를 LogDemoController , LogDemoService 에서 각각 한번씩 따로 호출해도
같은 HTTP 요청이면 같은 스프링 빈이 반환된다.
9.8 스코프와 프록시
방법2) 프록시 사용
@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {
}
proxyMode = ScopedProxyMode.TARGET_CLASS
TARGET_CLASS : 적용 대상이 인터페이스가 아닌 클래스일 때
INTERFACES : 적용 대상이 인터페이스일 때
(이때, 값이 2개 이상 이므로 request에 value를 붙여주어야 한다.)
위의 방법을 사용하면 MyLogger의 가짜 프록시 클래스를 만들어두고
HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.
package hello.core.web;
import hello.core.common.MyLogger;
import hello.core.logdemo.LogDemoService;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
@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";
}
}
package hello.core.logdemo;
import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
@Service
@RequiredArgsConstructor
public class LogDemoService {
private final MyLogger myLogger;
public void logic(String id) {
myLogger.log("service id = " + id);
}
}
LogDemoController , LogDemoService 코드는 Provider 사용 전과 완전히 동일하지만
실행해보면 제대로 동작하는 것을 확인할 수 있다.
웹 스코프와 프록시 동작 원리
myLogger 정보를 출력해보면 다음과 같다.
System.out.println("myLogger = " + myLogger.getClass());출력결과
myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$b68b726d
출력 결과를 보면 내가 만든 myLogger가 아닌
CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입하는 것을 볼 수 있다.
@Scope 의 proxyMode = ScopedProxyMode.TARGET_CLASS)
스프링 컨테이너는 CGLIB 라는 바이트코드를 조작하는 라이브러리를 사용해서,
MyLogger를 상속받은 가짜 프록시 객체를 생성한다.
결과를 확인해보면 우리가 등록한 순수한 MyLogger 클래스가 아니라
MyLogger$ $EnhancerBySpringCGLIB 이라는 클래스로 만들어진 객체가 대신 등록된다.
그리고 스프링 컨테이너에 "myLogger"라는 이름으로 진짜 대신에 가짜 프록시 객체를 등록한다.
ac.getBean("myLogger", MyLogger.class) 로 조회해도 프록시 객체가 조회된다.
따라서 의존관계 주입도 이 가짜 프록시 객체가 주입된다.
가짜 프록시 객체는 요청이 오면 그때 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다.
1) 가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있다.
2) 클라이언트가 myLogger.logic() 을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.
3) 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic() 를 호출한다.
4) 가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에
클라이언트 입장에서는 원본인지 아닌지도 모르게 동일하게 사용할 수 있다(다형성)
동작 정리
1) CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
2) 이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.
3) 가짜 프록시 객체는 실제 request scope와는 관계가 없다. 싱글톤 처럼 동작한다. (공유 가능)
특징 정리
1) 프록시 객체 덕분에 클라이언트는 싱글톤 빈을 사용하듯이 request scope를 사용할 수 있다.
2) 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리하는 것이다.
(실제 HTTP 요청이 들어올 때 까지는 버티는 것!)
3) 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다. (다형성, DI 컨테이너의 장점)
4) 웹 스코프가 아니어도 프록시 사용이 가능하다.
주의점
1) 마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 결국 주의해서 사용해야 한다.
2) 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용해야한다. 무분별하게 사용하면 유지보수가 어렵다.
'SPRING 핵심 원리 [ 기본편 ]' 카테고리의 다른 글
| 8. 빈 생명주기 콜백 (-ing) (0) | 2023.06.24 |
|---|---|
| [스프링 핵심 원리] 섹션 3.9 객체 지향 원리 적용 (스프링으로 전환하기) (0) | 2023.01.31 |
| [스프링 핵심 원리] 섹션 3.8 객체 지향 원리 적용 (IoC, DI, 그리고 컨테이너) (0) | 2023.01.31 |
| [스프링 핵심 원리] 섹션 3.7 객체 지향 원리 적용 (좋은 객체 지향 설계의 5가지 원칙의 적용) (0) | 2023.01.31 |
| [스프링 핵심 원리] 섹션 3.5 객체 지향 원리 적용 (새로운 구조와 할인정책 적용) (0) | 2023.01.31 |