빈 스코프

1. 빈 스코프란

빈이 존재할 수 있는 범위

스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어서 스프링 컨테이너가 종료될 때 까지 유지되는데, 이는 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문.

 

 

 

스프링에서 지원하는 다양한 스코프

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

 

스코프 지정 

@Scope("prototype")

 

 

2. 프로토타입 스코프

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

 

1. 클라이언트가 스프링 컨테이너에 빈 요청
2. 프로토타입 빈 생성, 의존관계 주입
3. 생성한 빈을 클라이언트에게 반환
4. 요청마다 반복

 

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

클라이언트에 빈을 반환한 후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않고 클라이언트에게 책임을 넘긴다. 그래서 @PreDestroy 같은 종료 메서드가 호출되지 않는다.

@Scope("prototype")
static class PrototypeBean {

    @PostConstruct
    public void init() {System.out.println("PrototypeBean.init");}
    
    @PreDestroy
    public void destroy() {System.out.println("PrototypeBean.destroy"); }
}

============================= 결 과 ===================================

prototypeBean1 = PrototypeBean.init
prototypeBean2 = PrototypeBean.init

prototypeBean1 = hello.core.scope.PrototypeTest$PrototypeBean@9ebe38b
prototypeBean2 = hello.core.scope.PrototypeTest$PrototypeBean@4b23c30a
19:37:48.767 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@4310d43, started on Thu Sep 01 19:37:48 KST 2022

Process finished with exit code 0

// init()은 실행되지만 destroy()는 실행되지 않는다.

 

 

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

스프링 컨테이너에 프로토타입 스코프의 빈을 요청하면 항상 새로운 객체 인스턴스를 생성해서 반환한다.
하지만 싱글톤 빈과 함께 사용할 때는 의도한 대로 잘 동작하지 않으므로 주의해야 한다.

 

프로토타입 빈은 요청이 들어올 때마다 생성하는데 싱글톤과 함께 사용하는경우 처음 생성시 의존관계 주입을 위해 생성하고 그 뒤는 계속 유지된다는 문제가 있다.

 

프로토타입 빈을 생성했다는 것은 필요시마다 새로 생성하길 원했기 때문인데 싱글톤 빈과 함께 사용할 때 문제가 생길 수도 있다.

 

해결 방법

• ObjectFactory
• ObjectProvider
• JSR-330 Provider

 

ObjectProvider

ObjectProvider가 지정한 빈을 컨테이너에서 대신 찾아주는 *Dependency Lookup (DL)서비스를 제공한다.

* Dependency Lookup
의존관계를 외부에서 주입(DI) 받는게 아니라 직접 필요한 의존관계를 찾는 것을 DL 의존관계 조회(탐색) 이라고 한다.

 

 

-  ObjectFactory  : 기능이 단순, 별도의 라이브러리 필요 없음

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

 

 

ObjectFactory에 편의 기능을 추가해서 만들어진것이 ObjectProvider 이며 둘 다 스프링에 의존한다.

// 기존코드
@RequiredArgsConstructor
static class ClientBean {
    private final PrototypeBean prototypeBean;

    public int logic() {
        prototypeBean.addCount();
        return prototypeBean.getCount();
    }
}

// ObjectPrivider 사용
@RequiredArgsConstructor
static class ClientBean {

    private final ObjectProvider<PrototypeBean> prototypeBeanProvider;

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

 

 

 

JSR-330 Provider

스프링에 의존하지 않는 JSR-330 자바 표준
사용하기 위해서 라이브러리를 gradle에 추가해야 한다. (implementation 'javax.inject:javax.inject:1')

 

 

• Provider를 생성 후 프로토타입 빈이 필요한 곳에서 .get()을 호출하면 스프링 컨테이너에서 해당 빈을 찾아 반환한다.
• 자바 표준이며, 기능이 단순하여 단위테스트를 만들거나 mock 코드를 만들기 쉬워진다.

 

// JSR-330 Provider 사용
@RequiredArgsConstructor
static class ClientBean {

    private final Provider<PrototypeBean> prototypeBeanProvider;

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

 

사용할 때 마다 매번 의존관계 주입이 완료된 새로운 객체가 필요할 때 사용하면 되지만,
대부분의 문제는 싱글톤 빈으로  해결할 수 있기 때문에, 프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다.

ObjectProvider , JSR330 Provider 등은 프로토타입 뿐만 아니라 DL이 필요한 경우는 언제든지 사용할 수 있다.

 

 

💡 JSR-330 Provider, ObjectProvider 중 어떤것을 선택할 것인가.

• 스프링이 별도의 의존관계 추가가 필요 없고, 다양하고 편리한 기능을 제공하기 때문에, 특별히 다른 컨테이너를 사용할 일이 없다면,스프링이 제공하는 기능을 사용

 

 

4. 웹 스코프

웹 스코프는 웹 환경에서만 동작한다.
웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리하기 때문에 종료 메서드가 호출된다.

 

 

웹 스코프 종류

• request : HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프, 각각의 HTTP 요청마다 별도의 빈
  인스턴스가 생성되고, 관리된다.
• session : HTTP Session과 동일한 생명주기를 가지는 스코프
• application : 서블릿 컨텍스트( ServletContext )와 동일한 생명주기를 가지는 스코프
• websocket : 웹 소켓과 동일한 생명주기를 가지는 스코프

 

5. request 스코프 예제 만들기

HTTP 요청을 구분하기 위해 UUID를 사용해서 로그를 출력하는 MyLogger 클래스

 

1. HttpServletRequest를 통해서 요청 URL을 받는다.
2. requestURL 값 http://localhost:8080/log-demo 이렇게 받은 requestURL 값을 myLogger에 저장한다.
3. myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.
4. 컨트롤러에서 controller test라는 로그를 남긴다.

 

requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다. 이 예제는 단순하게 하기 위함.

 

 

웹 환경 추가

• 해당 라이브러리를 추가하면 스프링 부트는 내장 톰켓 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.

implementation 'org.springframework.boot:spring-boot-starter-web'

스프링 부트는 웹 라이브러리가 없으면 AnnotationConfigApplicationContext 기반으로 애플리케이션을 구동한다.
웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요하므로  AnnotationConfigServletWebServerApplicationContext 를 기반으로 애플리케이션을 구동한다.

 

// request 스코프로 지정
// HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸
@Scope(value = "request")   
@Component
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);
    }
    
    // 초기화 메서드를 사용해서 uuid를 생성
    @PostConstruct
    public void init() {
        String 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);
    }
}

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final MyLogger myLogger;

    public void logic(String id) {
        myLogger.log("service id = " + id);
    }
}

📌
웹과 관련된 부분은 컨트롤러까지만 사용해야 한다. 서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋다.
여기서는 request scope의 MyLogger 덕분에 requestURL 같은 웹과 관련된 정보를 파라미터로 넘기지 않고, MyLogger의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다

 

 

 

❗ 실행 시키면 에러가 난다.

LogDemoService는  MyLogger를 주입받아야 하는데 MyLogger의 Scope는 "request" 이다. request는 HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프인데 스프링 서버가 뜰때 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;

 

→ 앞에서 배운 Provider를 사용하면 된다.

ObjectProvider를 사용해서 ObjectProvider.getObject() 를 호출하는 시점까지 request scope 빈의 생성을 지연(스프링 컨테이너에게 요청하는 것)할 수 있다.

 

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final ObjectProvider<MyLogger> myLoggerProvider;

    public void logic(String id) {
        MyLogger myLogger = myLoggerProvider.getObject();
        myLogger.log("service id = " + id);
    }
}

 

Controller와 Service 모두 변경 후 실행 시키면 정상적으로 작동 된다.

 

[4d9a626e-e47b-4d8e-921a-eb8af411cba1] request scope bean create:hello.core.common.MyLogger@5854d660
[4d9a626e-e47b-4d8e-921a-eb8af411cba1][http://localhost:8080/log-demo] controller test
[4d9a626e-e47b-4d8e-921a-eb8af411cba1][http://localhost:8080/log-demo] service id = testId
[4d9a626e-e47b-4d8e-921a-eb8af411cba1] request scope bean close:hello.core.common.MyLogger@5854d660

 

같은 HTTP 요청이면 같은 스프링 빈이 반환된다

 

 

6. 스코프와 프록시

가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.
프록시 모드를 통해 간단하게 Provider와 같은 기능을 수행할 수 있다.

 

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

 

• 적용 대상이 인터페이스면 INTERFACES
• 적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS

 

//프록시 객체 출력
System.out.println("myLogger = " + myLogger.getClass());

-----------------------------------------------------------------------

//결과값
myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$b69621a1

 

1. 프록시 객체를 출력해 보면 @Configuration 객체 처럼 가짜 객체가 출력되는 것을 확인 할 수 있다.
2. 스프링 빈 등록시 MyLogger를 상속받은(CGLIB라는 라이브러리) 가짜 프록시 객체를 생성해서 주입한다.
3. 프록시 모드를 통해 가짜 객체를 넣어두고 실제 호출되는 시점에 Provider가 getObject()를 호출 한 것처럼 동작한다.

 

 

 

 

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

• 가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있다.
• 클라이언트가 myLogger.logic() 을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.
• 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic() 를 호출한다.
• 가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트
• 입장에서는 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있다(다형성)

 

동작 정리

• CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
• 이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.
• 가짜 프록시 객체는 실제 request scope와는 관계가 없다.
  가짜 객체이며, 내부에 단순한 위임 로직만 있고, 싱글톤 처럼 동작한다.

 

특징 정리

• 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope를 사용할 수 있다.
• 사실 Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지
  지연처리 한다는 점이다.
• 단지 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다. 이것이 바로 다형성과 DI 
• 컨테이너가 가진 큰 강점이다.
• 꼭 웹 스코프가 아니어도 프록시는 사용할 수 있다.

 

주의점

• 마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 결국 주의해서 사용해야 한다.
• 이런 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용하자, 무분별하게 사용하면 유지보수하기
  어려워진다

 

 

 

 

 

 

출처 : 스프링 핵심 원리
https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard