빈 스코프 (Bean Scope)

스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어서 스프링 컨테이너가 종료될 때 까지 유지된다 (싱글톤 스코프)

 

스프링의 다양한 스코프

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

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

- 웹 관련 스코프

• request : 웹 요청이 들어오고 나갈 때까지 유지되는 스코프
• session : 웹 세션이 생성되고 종료될 때까지 유지되는 스코프
• application : 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프

프로토타입 스코프

 

싱글톤 빈 요청

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

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

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

 

프로토타입 빈 요청1

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

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

 

프로토타입 빈 요청2

3. 스프링 컨테이너는 생성한 프로토타입 빈을 반환.

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

 

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

클라이언트에 빈을 반환하고 프로토타입 빈을 관리하지 않는다.

프로토타입 빈의 @PreDestory 같은 종료 메서드는 호출되지 않는다.

 

@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")
@PostConstruct
@PreDestory

- 같은 인스턴스의 빈을 조회하고 종료 메서드까지 정상 호출

 

@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);
    ac.close(); //종료
}

@Scope("prototype")
@PostConstruct
@PreDestroy

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

- 완전히 다른 스프링 빈이 생성되고, 초기화도 2번

- @PreDestory 같은 종료 메서드는 실행되지 않는다.

 

프로토타입 빈 특징

- 스프링 컨테이너에 요청할 때마다 새로 생성

- 프로토타입 빈의 생성과 의존관계 주입 그리고 초기화까지만 관여

- 종료 메서드 호출 X

- 프로토타입 빈을 조회한 클라이언트가 관리해야하며, 이는 종료 메서드도 마찬가지다.

 

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

프로토타입 스코프 빈은 항상 새로운 객체 인스턴스 생성 반환

싱글톤 빈과 함께 사용할 때에는 의도한 대로 동작 안할 수 있으니 주의 필요

 

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

1. 클라이언트A 프로토타입 빈 요청

2. 스프링 컨테이너는 프로토타입 빈(x01)을 생성하고 반환, count = 0

3. 클라이언트는 addCount() 호출하여 count + 1한다.

프로토타입 빈(x01) count = 1 이다.

 

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

1. 클라이언트B 프로토타입 빈 요청

2. 스프링 컨테이너는 프로토타입 빈(x02)을 생성하고 반환, count = 0

3. 클라이언트는 addCount() 호출하여 count + 1한다.

프로토타입 빈(x02) count = 1 이다.

 

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

 

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

- clientBean은 싱글톤이므로, 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입

1. clientBean은 의존관계 자동 주입 사용, 주입 시점에 스프링 컨테이너에 프로토타입 빈 요청

2. 프로토타입 빈을 생성해서 clientBean에 반환, 프로토타입 빈 count = 0

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

 

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

- 클라이언트A는 clientBean을 스프링 컨테이너에 요청해서 항상 같은 clientBean을 받는다. (싱글톤)

3. 클라이언트 A는 clientBean.logic()을 호출

4. clientBean은 prototypeBean의 addCount() 호출해서 count = 1이 된다.

 

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

- 클라이언트B는 clientBean을 스프링 컨테이너에 요청해서 항상 같은 clientBean을 받는다. (싱글톤)

- clientBean 내부에 저장되어 있는 prototypeBean은 이미 과거에 주입이 끝났다.

- 주입 시점에 프로토타입 빈이 새로 생성된 것, 사용할 때마다 새로 생성되는 것이 아니다!

5. 클라이언트B는 clientBean.logic()을 호출한다.

6. clientBean은 prototypeBean의 addCount() 호출해서 count = 2가 된다.

 

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

싱글톤 빈과 프로토타입 빈을 함께 사용할 때, 사용할 때마다 새로운 프로토타입 빈을 생성하는 방법

 

스프링 컨테이너에 요청

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

- 의존관계를 외부에서 주입(DI)받는 게 아니라 직접 필요한 의존관계를 찾는 것을 Dependeny Lookup(DL)이라 한다.

- 단위 테스트가 어려워지고, 스프링 컨테이너에 종속적인 코드가 되는 단점이 있다.

 

ObjectFactory, ObjectProvider

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

@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanProvider;

public int logic() {
	PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
	prototypeBean.addCount();
	int count = prototypeBean.getCount();
	return count;
}

- prototypeBeanProvider.getObject()을 통해서 항상 새로운 프로토타입 빈을 생성

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

 

JSR-330 Provider

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

//implementation 'javax.inject:javax.inject:1' gradle 추가 필수
@Autowired
private Provider<PrototypeBean> provider;

public int logic() {
    PrototypeBean prototypeBean = provider.get();
    prototypeBean.addCount();
    int count = prototypeBean.getCount();
    return count;
}

- provider.get()을 통해서 항상 새로운 빈이 생성

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

- 자바 표준이브로 스프링 아닌 다른 컨테이너에도 사용 가능

 

실무에서 웹 애플리케이션을 개발해보면, 싱글톤 빈으로 대부분의 문제를 해결

프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다

 

웹 스코프

- 웹 환경에서만 동작

- 프로토타입과 다르게 해당 스코프의 종료 시점까지 관리

 

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

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

- application : Servlet Context와 동일한 생명주기를 가지는 스코프

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

 

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

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

 

request 스코프 예제

- [UUID][requestURL]{message} 포맷의 각 요청에 대한 로그 설정하여 HTTP 구분

@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 create:" + this);
    }
    
    @PreDestroy
    public void close() {
    	System.out.println("[" + uuid + "] request scope bean close:" + this);
    }
}

- @Scope(value = "request") request 스코프 설정, HTTP 요청 당 하나씩 생성, HTTP 요청 끝나는 시점에 소멸

- requestURL은 외부에서 setter로 입력받는다.

@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";
    }
}

- 테스트용 컨트롤러

- requestURL : http://localhost:8080/log-demo by HttpServletRequest

@Service
@RequiredArgsConstructor
public class LogDemoService {
    private final MyLogger myLogger;
    
    public void logic(String id) {
    	myLogger.log("service id = " + id);
    }
}

- 비즈니스 로직이 있는 서비스 계층에도 로그 설정

 

오류 발생!

스프링 애플리케이션은 실행하는 시점에 싱글톤 빈은 생성해서 주입이 가능하지만, request 스코프 빈은 아직 생성되지 않는다.

실제 고객의 요청이 와야 생성 가능

 

스코프와 Provider

private final ObjectProvider<MyLogger> myLoggerProvider;

MyLogger myLogger = myLoggerProvider.getObject();

- Controller와 Service에 ObjectProvider를 적용한다.

- ObjectProvider.getObject()를 호출하는 시점까지 request scope 빈의 생성 지연

- ObjectProvider.getObject()를 호출하는 시점에는 HTTP 요청이 진행 중이므로 request scope 빈의 생성이 정상 처리

 

스코프와 프록시

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

}

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

- 기존의 ObjectProvider 적용 제거

 

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

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

- proxyMode = ScopedProxyMode.TARGET_CLASS를 설정하면 CGLIB 바이트코드 조작 라이브러리를 사용해서 MyLogger를 상속받은 객체를 생성

- 순수한 MyLogger 클래스가 아니라 $EnhancerBySpringCGLIB이라는 클래스로 만들어진 객체가 대신 등록

- 스프링 컨테이너에 "myLogger"라는 이름으로 가짜 프록시 객체 등록

- 의존관계 주입도 가짜 프록시 객체가 주입

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

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

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

- 가짜 프록시 객체는 원본 클래스를 상속받아서 만들어졌기 때문에 클라이언트는 원본인지 모른다.(다형성)

 

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

- Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연 처리한다는 것

- 꼭 웹 스코프가 아니더라도 프록시는 사용할 수 있다.

 

 

출처: 스프링 핵심 기본 원리편