스프링기본12_빈스코프

빈스코프

(1) 빈스코프

스프링 빈이 스프링 컨테이너와 시작과 함께 생성되어서 스프링 컨테이너가 종료될 때 까지 유지된다고 학습했다.
이것은 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다.
스코프는 번역 그대로 빈이 존재할 수 있는 범위를 뜻한다.

1.스프링은 다음과 같은 다양한 스코프를 지원한다.

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

(2) 프로토타입 스코프

프로토타입 스코프를 스프링 컨테이너에 조회할 시 항상 새로운 인스턴스를 생성해서 반환한다.

싱글톤 빈 요청

a. 싱글톤 스코프 빈을 스프링 컨테이너에 요청한다.
b. 스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환한다.
c. 이후에 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈을 반환한다.

프로토타입 빈 요청

a. 프로토타입 스코프의 빈을 스프링 컨테이너에 요청한다.
b. 스프링 컨테이너는 이 시점에 프로토타입 빈을 생성하고, 필요한 의존관계를 주입한다.

c. 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환한다.
d. 이후에 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환한다.

[정리]

스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화 까지만 처리한다.
클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다.
프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다
-> @PreDestroy 같은 종료 메서드가 호출되지 않는다.

3.테스트코드 작성

디폴트스코프(싱글톤)의 경우

-싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드가 실행됨
-싱글톤 빈은 스프링 컨테이너가 관리하기 때문에 스프링 컨테이너가 종료될 때 빈의 종료 메서드가 실행됨.

프로토타입의 경우

-프로토타입 스코프의 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고, 초기화 메서드도 실행됨.
-프로토타입 빈을 2번 조회했으므로, 완전히 다른 스프링 빈이 생성되고, 초기화도 2번 실행됨
-프로토타입 빈은 스프링 컨테이너가 생성과 의존관계 주입, 그리고 초기화 까지만 관리하고 더는 관리하지 않음.
-따라서 프로토타입 빈은 스프링컨테이너가 종료될 때 @PreDestroy 같은 종료 메서드가 전혀 실행되지 않는다.

프로토타입 빈의 특징 정리

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

스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입 그리고 초기화 까지만 관여한다.

종료 메서드가 호출되지 않는다.

그래서 프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 한다. 종료 메서드에 대한 호출도 클라이언트가 직접 해야한다.

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

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

프로토타입 빈 직접 요청

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이 된다.

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

clientBean은 싱글톤이므로, 보통 스프링 컨테이너 생성시점에 함께 생성되고, 의존관계 주입도 발생한다.

1. clientBean은 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환한다. 프로토타입 빈의 count필드값은 0이다.

이제 clientBean은 프로토타입 빈을 내부 필드에 보관한다.(정확히는 참조값을 보관한다)

클라이언트A는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean이 반환된다.

3. 클라이언트A는 client.logic()을 호출한다.
4. clientBean은 prototypeBean의 addCount()을 호출

해서 프로토타입 빈의 count를 증가한다. count값이 1이 된다.

클라이언트B는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean이 반환된다.

여기서 중요한점은 clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다. 
주입 시점에 스프링 컨테이너에 요청해서 포로토타입 빈이 새로 생성이 된 것이지, 사용할 때 마다 새로 생성되는 것이 아니다.

5. 클라이언트B는 client.logic()을 호출한다.
6. clientBean은 prototypeBean의 addCount()을 호출
해서 프로토타입 빈의 count를 증가한다. count값이 2가 된다.

전체 테스트 코드

package springbasic.core.scope;

import org.assertj.core.api.Assertions;
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 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);
    }

    @Test
    void singletonClientUserPrototype(){
        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 = clientBean1.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");
        }
    }
}

정리

스프링은 일반적으로 싱글톤 빈을 사용하므로, 싱글톤 빈이 프로토 타입 빈을 사용하게 된다.
그런데 싱글톤 빈은 생성 시점에만 의존관계를 주입을 받기 때문에, 프로토타입 빈이 새로 생성되기는 하지만, 싱글톤 빈과 함께 계속 유지되는 것이 문제다.

우리가 프로토타입을 사용하는 이유는 위와 같지 않을 것이다.

프로토타입 빈을 주입 시점에만 새로 생성하는게 아니라, 사용할 때 마다 새로 생성해서 사용하는 것을 원할 것이다.

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

싱글톤 빈과 프로토타입 빈을 함께 사용할 때,
어떻게 하면 사용할 때 마다 항상 새로운 프로토타입 빈을 생성할 수 있을까.

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

가장 간단한 방법은 싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청하는 것.

@Autowired
private ApplicationContext ac;

public int logic(){
	prototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
    prototypeBean.addCount();
    int count = prototypeBean.getCOunt();
    return count;
    }

a. 실행해보면 ac.getBean()을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
b. 의존관계를 외부에서 주입(DI)를 받는게 아니라 이러한 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL)의존관계 조회(탐색)이라 한다.
c. 그런데 이렇게 스프링의 애플리케이션컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다.
d. 지금 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는, DL 정도의 기능만 제공하는 것이 있으면 된다.

2.ObjectFactory, ObjectProvider

지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하는 것이 바로 ObjectProvider이다. 참고로 과거에는 ObjectFactory가 있었는데, 여기에 편의 기능을 추가해서 ObjectProvider가 만들어 졌다.

        @Autowired
        private ObjectProvider<PrototypeBean> prototypeBeanProvider;


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

a. 실행해보면 'prototypeBeanProvider.getObject()'을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
b. ObjectProvider의 getObject()를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다.(DL)
c. 스프링이 제공하는 기능을 사용하지만, 기능이 단순하므로 단위테스트를 만들거나 mock코드를 만들기는 훨씬 쉬워진다.
d. ObjectProvider는 지금 딱 필요한 DL 정도의 기능만 제공한다.

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

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

3.JSR-330 Provider

javax.inject.Provider 라는 JSR-330 자바 표준을 사용하는 방법
'javax.inject:javax.inject:1' 라이브러리를 gradle에 추가해주어야 함.

        @Autowired
          private Provider<PrototypeBean> prototypeBeanProvider;

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

a. 실행해보면 provider.get()을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
b. provider의 get()을 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다(DL)
c. 자바 표준이고, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다.
d. Provider는 지금 딱 필요한 DL 정도의 기능만 제공한다.

4.정리

프로토타입 빈을 언제 사용할까?
-> 실무에서 웹 애플리케이션을 개발해보면, 싱글톤 빈으로 대부분의 문제를 해결할 수 있기 때문에 프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다.
-> ObjectProvider, JSR303 Provider 등은 프로토타입 뿐만 아니라 DL이 필요한 경우 언제든지 사용할 수 있다.

실무에서 둘 중 무엇을 사용할까?
-> 스프링에서만 쓰면 ObjectProvider
-> 다른 컨테이너에서 쓸꺼면 Provider

(5) 웹 스코프

1.웹 스코프의 특징

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

2.웹 스코프 종류

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

(6) request 스코프 예제 만들기

1.웹 환경 추가

build.gradle 추가

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

-> spring-boot-starter-web 라이브러리를 추가하면 스프링 부트가 내장톰켓 서버를 활용해서 웹 서버와 스프링을 함께 실행함
-> 스프링부트는 웹라이브러리가 없으면 AnnotationConfigApplicationContext를 기반으로 에플리케이션을 구동함.
-> 웹라이브러리가 있을때는 웹과 관련된 추가설정을 위해AnnotionConfigServletWebServerApplicationContext를 기반으로 애플리케이션을 구동함

2.request 스코프 예제 개발

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어려움.
이럴 때 사용하기 좋은것이 request 스코프이다.

기대하는 공통포멧 : [UUID][requestURL][message]

UUID를 사용해서 HTTP 요청을 구분하자.

requestURL 정보도 추가하여 어떤 URL을 요청해서 남은 로그인지 확인하자.

3.로그 생성 코드 작성

MyLogger.java

로그를 출력하기 위한 MyLogger 클래스

@Scope(value = "request")를 사용해서 request스코프로 지정했다. 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.

이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다. 이 빈은 HTTP요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.

이 빈이 소멸되는 시점에 @PreDestroy를 사용해서 종료 메시지를 남긴다.

requestURL은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력받는다.

LogDemoController.java

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

여기서 HttpServletRequest를 통해서 요청 URL을 받음.
-> requestURL : http://localhost:8080/log-demo

이렇게 받은 requestURL 값을 myLogger에 저장해둔다. myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 떄문에 값이 섞이는 걱정은 하지 않아도 된다.

MyLogger를 저장하는 부분은 컨트롤러 보다는 공통처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다.

LogDemoService.java

비즈니스 로직이 있는 서비스 계층에서도 로그를 출력해보자.

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;

->스프링 애플리케이션을 실행시키면 오류가 발생한다.
--> 스프링 애플리케이션을 실행하는 시점에 싱글톤 빈은 생성해서 주입가능하나,
---> request 스코프 빈은 아직 생성되지 않는다 ( 실제 고객의 요청이 와야 생성할 수 있다.)

(7) 스코프와 Provider

Provider 사용

LogDemoController.java
LogDemoService.java
테스트 시 로그

[33bb9df2-2bfc-435e-a070-81cfc0a3be2a] request scope bean create:springbasic.core.common.MyLogger@3e75d975
[33bb9df2-2bfc-435e-a070-81cfc0a3be2a][http://localhost:8080/log-demo]controller test
[33bb9df2-2bfc-435e-a070-81cfc0a3be2a][http://localhost:8080/log-demo]service id = testid
[33bb9df2-2bfc-435e-a070-81cfc0a3be2a] request scope bean close:springbasic.core.common.MyLogger@3e75d975

[68f60462-79b6-45ed-afcd-2765bc78d4b6] request scope bean create:springbasic.core.common.MyLogger@4b96c2b8
[68f60462-79b6-45ed-afcd-2765bc78d4b6][http://localhost:8080/log-demo]controller test
[68f60462-79b6-45ed-afcd-2765bc78d4b6][http://localhost:8080/log-demo]service id = testid
[68f60462-79b6-45ed-afcd-2765bc78d4b6] request scope bean close:springbasic.core.common.MyLogger@4b96c2b8

[7e5922c1-90a1-44ae-8015-78c2c54201ac] request scope bean create:springbasic.core.common.MyLogger@2db1fa07
[7e5922c1-90a1-44ae-8015-78c2c54201ac][http://localhost:8080/log-demo]controller test
[7e5922c1-90a1-44ae-8015-78c2c54201ac][http://localhost:8080/log-demo]service id = testid
[7e5922c1-90a1-44ae-8015-78c2c54201ac] request scope bean close:springbasic.core.common.MyLogger@2db1fa07

정리

'ObjectProvider' 덕분에 'ObjectProvider.getObject()'을 호출하는 시점까지 request scope "빈의 생성을 지연"할 수 있다.

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

'ObjectProvider.getObject()'를 'LogDemoCOntroller','LogDemoService'에서 각각 한번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다.

(8) 스코프와 프록시

1.프록시 방식 사용

MyLogger.java

proxyMode = ScopedProxyMode.TARGET_CLASS을 추가
-> 적용 대상이 인터페이가 아닌 클래스면 TARGET_CLASS 선택
-> 적용 대상이 인터페이스면 INTERFIACES 선택

이렇게 할 시 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.

LogDemoController.java
LogDemoService.java

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

a. CGLIB라는 라이브러리로 내 클래스를 상속받는 가짜 프록시 객체를 만들어서 주입한다.
b. @Scope의 'proxyMode = ScopedProxyMode.TARGET_CLASS'를 설정하면 스프링 컨테이너는 CGLIB라는 바이트코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받는 가짜 프록시 객체를 생성한다.
c. 결과 확인 시 우리가 등록한 순수한 MyLogger클래스가 아니라 'MyLogger$$EnhancerBySpringCGLIB'라는 클래스로 만들어진 객체가 대신 등록된 것을 확인 가능하다.
d. 그리고 스프링 컨테이너에 "myLogger" 라는 이름으로 이 가짜 프록시 객체를 등록한다. 즉 의존관계 주입도 가짜 프록시 객체가 주입된다.

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

동작원리

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

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

가짜 프록시 객체는 실제 request scope와는 관계가 없다.
-> 가짜이며, 내부에 단순한 위임 로직만 있고, 싱글톤 처럼 동작한다.

특징 정리

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

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

단지 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다.
-> 이것이 바로 다형성과 DI컨테이너가 가진 큰 강점이다

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

주의점

마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 결국 주의해서 사용해야 한다.

이런 특별한 scope는 꼭 필요한 곳에서만 최소화해서 사용하자.

Author And Source

이 문제에 관하여(스프링기본12_빈스코프), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다 https://velog.io/@hadoyaji/스프링-강의-속성-정리11

우수한 개발자 콘텐츠 발견에 전념 (Collection and Share based on the CC Protocol.)