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

본 시리즈는 우아한형제들 개발 팀장이신 김영한님의 스프링 핵심 원리 - 기본편 강의를 들으며 개인적으로 정리한 내용을 담고 있습니다. 제가 들은 강의는 인프런에 등록되어 있습니다. 모든 다이어그램을 포함한 사진의 출처는 위 강의의 강의록임을 밝힙니다. 개인적으로 정리한 내용이기 때문에 글 내용에 오류가 있을 수 있으며 이에 대한 피드백은 댓글로 부탁드립니다.

이번 섹션에서 다룰 내용

• 빈 스코프

---

빈 스코프란?

스코프는 빈이 존재할 수 있는 범위를 뜻한다. 스프링에서는 다양한 스코프를 지원한다.

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

빈 스코프를 지정하는 방법

//컴포넌트 스캔 이용한 자동 등록
@Scope("prototype")
@Component
public class SomeBean() {}

//빈 수동 등록
@Scope("prototype")
@Bean
PrototypeBean SomeBean() {
    return new SomeBean();
}

---

프로토타입 스코프

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

싱글톤 빈 요청

1. 싱글톤 스코프의 빈을 스프링 컨테이너에 요청한다.
2. 스프링 컨테이너에서 관리하는 스프링 빈을 반환한다.
3. 이후에 같은 요청이 와도 언제나 같은 객체 인스턴스의 스프링 빈을 반환한다.

프로토타입 빈 요청 1

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

3. 컨테이너에서 생성한 프로토타입 빈을 클라이언트에 반환한다. (이 때부터 관리하지 않음)
4. 이후에 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환한다.

정리

• 프로토타입 스코프 빈의 경우 컨테이너가 해주는 것은 빈 생성, 의존관계 주입, 초기화이다.
• 이후 클라이언트에 반환하고 나서는 더이상 관리하지 않는다!
  • @PreDestroy 같은 종료 메소드가 호출되지 않는다.
• 따라서 프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에게 있다.

코드로 확인해보자

싱글톤 스코프 빈 테스트

public class SingletoneTest {
    @Test
    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") //default
    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
org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing
SingletonBean.destroy

• 싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메소드가 실행된다.
• 종료 메소드가 잘 호출되는 것을 볼 수 있다.
• 참고로 SingletonBean에 @Component를 안 붙여줬지만, ApplicationContext를 생성할 때 직접 SingletonBean.class를 넣어줬기 때문에, 컴포넌트 스캔이 되어 괜찮다.

프로토타입 스코프 빈 테스트

public class PrototypeTest {
    @Test
    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")
    static class PrototypeBean {
        @PostConstruct
        public void init() {
            System.out.println("SingletonBean.init");
        }

        @PreDestroy
        public void destroy() {
            System.out.println("SingletonBean.destroy");
        }
    }
}

find prototypeBean1
PrototypeBean.init
find prototypeBean2
PrototypeBean.init
prototypeBean1 = hello.core.scope.PrototypeTest$PrototypeBean@13d4992d
prototypeBean2 = hello.core.scope.PrototypeTest$PrototypeBean@302f7971
org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing

• 프로토타입 스코프 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고, 초기화된다.. (find prototype이후에 init되는 모습)
• 프로토타입 빈을 두 번 호출했기 때문에, init도 두 번 호출되는 모습을 볼 수 있다.
• 클라이언트에게 넘겨준 뒤로 더이상 스프링 컨테이너가 관리하지 않기 때문에, ac.close()이전에 destroy가 실행되지 않는 모습을 볼 수 있다.
  • 필요하다면, 클라이언트가 destroy()를 직접 호출해야한다.

프로토타입 빈의 특징 정리

• 스프링 컨테이너에 요청할 때마다 새로 생성된다.
• 스프링 컨테이너는 빈의 생성과 의존관계 주입, 초기화만 관여한다.
• 종료메소드가 호출되지 않는다.
• 프로토타입 빈은 해당 빈을 조회한 클라이언트가 관리해야한다.

---

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

앞서 배운 것처럼 스프링 컨테이너에 프로토타입 빈을 요청하면 항상 새로운 인스턴스를 생성해서 반환한다. 그러나 싱글톤 빈과 함께 사용할 땐 문제가 발생할 수 있다. 어떤 문제인지 배워보자.

프로토타입 빈 직접 요청

다음과 같은 시나리오를 상정하자.

1. 클라이언트 A는 스프링 컨테이너에 프로토타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환한다. (0x01) 해당 빈에는 count 필드가 있는데, 초기값은 0이다.
3. 클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하여 count필드의 값을 +1 한다.
   • 현재 프로토타입 빈(0x01)의 count는 1이 된다.

1. 이번엔 클라이언트 B가 스프링 컨테이너에 프로토타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환한다. (0x02) 해당 빈에는 count 필드가 있는데, 초기값은 0이다.
3. 클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하여 count필드의 값을 +1 한다.
   • 현재 프로토타입 빈(0x01)의 count는 1이 된다.

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

이번에는 clientBean이라는 싱글톤 빈에서 프로토타입 빈을 주입받아서 사용하는 경우를 살펴보자.

• clientBean은 싱글톤이므로, 스프링 컨테이너가 생성되는 시점에 함께 생성되며, 의존관계 주입도 받는다.
  1. 의존관계 주입 과정에서 clientBean은 스프링 컨테이너에 프로토타입 빈을 요청한다.
  2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 주입한다. 이 때 count의 값은 0이다.
• 이 때 clientBean은 프로토타입 빈을 내부 필드에 보관한다. (정확히는 참조값을 보관)

• 클라이언트 A는 clientBean을 조회한다. clientBean은 싱글톤이므로 항상 같은 clientBean이 반환된다.
• 이제 클라이언트 A는 clientBean.logic()을 호출한다.
  • clientBean.logic()을 호출하면, prototypeBean의 addCount()를 호출해서 prototypeBean의 count를 증가시킨다.
  • count는 1이 된다.

• 클라이언트 B는 clientBean을 조회한다.clientBean은 싱글톤이므로 항상 같은 clientBean이 반환된다.
• 그런데 이 때 주의할 점은 prototypeBean이 새로 생성되는 게 아니라는 점이다. prototypeBean은 이미 과거에 주입이 끝났기 때문이다. clientBean의 의존관계 주입 시점에 스프링 컨테이너에 prototypeBean을 요청해서 생성된 것이지, 사용할 때마다 생성되는 게 아니다.
• 이제 클라이언트 B는 clientBean.logic()을 호출한다.
  • clientBean.logic()을 호출하면, prototypeBean의 addCount()를 호출해서 prototypeBean의 count를 증가시킨다.
  • count는 2가 된다.

정리

• 싱글톤 빈이 프로토타입 빈을 필드로 갖는 경우, 초기 의존관계 주입 시에 프로토타입 빈을 생성받은 뒤로 계속 유지되기 때문에, 다른 클라이언트가 해당 싱글톤 빈을 조회하더라도 필드로 갖는 프로토타입 빈은 유지된다.
• 만약 같은 상황에서 사용할 때마다 프로토타입 빈이 새로 생성되길 원하면 어떻게 해야할까?
  • 무식한 방법으로는 prototypeBean 대신 applicationContext를 주입받고, logic을 호출할 때마다 prototypeBean을 새로 조회하는 방법이 있다.
  • 근데 이건 코드도 너무 복잡하고 직관적이지 않다. (다음 챕터에서 알아봄)

참고: 여러 빈에서 같은 프로토타입 빈을 주입받으면, 주입 받는 시점에 각각 새로운 프로토타입 빈이 생성된다. 예를 들어서 clientBeanA와 clientBeanB가 각각 의존관계 주입을 받으면 각각 다른 인스턴스의 prototypeBean을 주입받게 된다.

clientBeanA → prototypeBean@x01

clientBeanB → prototypeBean@x02

두 clientBean은 서로 다른 인스턴스를 갖게 될 것이다.

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

싱글톤 빈 내의 프로토타입 빈을 사용할 때, 어떻게 하면 사용할 때마다 새로운 프로토타입 빈을 생성할 수 있을까?

스프링 컨테이너에 요청

가장 간단한 방법은 스프링 컨테이너를 주입하고, 매번 새로 getBean하면 된다.

• ac.getBean()을 통해 항상 새로운 프로토타입 빈이 생성된다.
• 의존관계를 외부에서 주입(DI)받는 게 아닌, 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL), 의존관계 탐색이라고 한다.
• 그런데 스프링 컨테이너를 주입받게 되면, 컨테이너에 의존하게 되고 단위테스트도 어려워진다.
• 지금 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 DL 정도의 기능만 제공하는 무언가가 있으면 된다.
  • 그리고 이런 게 이미 스프링에 있다!

ObjectFactory, ObjectProvider

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

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(1);
    }

    @Scope("singleton") //default
    static class ClientBean {

        @Autowired
        private ObjectProvider<PrototypeBean> prototypeBeanProvider;

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

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

• 실행하면 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
• ObjectProvider의 getObject()를 호출하면, 스프링 컨테이너에 해당 빈을 조회하는 것과 같은 효과를 낸다. (DL)
• 스프링이 제공하는 기능을 의존하지만, 기능이 단순해서 단위테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다.
• ObjectProvider는 지금 딱 필요한 DL 정도의 기능만 제공한다.

특징

• ObjectFactory: 기능이 단순하고, 별도 라이브러리 필요없다. 사용하면 스프링에 의존하게 된다.
• ObjectProvider: ObjectFactory를 상속하여 기능을 추가했다. (옵션, 스트림 처리 등) 별도 라이브러리 필요없다. 사용하면 스프링에 의존하게 된다.

JSR-330 Provider

스프링에 의존하지 않는 방법은 없을까? 하면 바로 이것이다.

javax.inject.Provider라는 JSR-330 자바 표준을 사용한다. 이걸 쓰려면 javax.inject:javax.inject:1 라이브러리를 gradle에 추가해야 한다.

@Scope("singleton") //default
static class ClientBean {

    @Autowired
    private Provider<PrototypeBean> provider;	//javax.inject 하위 클래스로 import해야함

    public int logic() {
        PrototypeBean prototypeBean = provider.get();	//컨테이너에 빈 요청
        prototypeBean.addCount();
        return prototypeBean.getCount();
    }
}

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

특징

• get()메소드 하나로 기능이 매우 단순하다.
• 별도의 라이브러리가 필요하다.
• 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.

정리

• 그렇다면 프로토타입 빈은 언제 사용할까?
  • 사용할 때마다 의존관계 주입이 완료된 새로운 객체가 필요하면 쓰면 된다.
  • 근데 사실 이런 걸 써야할 일이 별로 없다. (대부분 싱글톤으로 해결 가능함)
  • 실무에서 자주 쓸 일은 없고, 라이브러리 분석하면서 알아볼 수 있으면 된다.
• ObjectProvider, JSR303 Provider등은 프로토타입 빈에서 뿐만 아니라 DL기능이 필요한 경우엔 언제든지 사용할 수 있다.

참고: 스프링이 제공하는 메소드에 @Lookup 애노테이션을 사용하는 방법도 있지만, 이전 방법들로 충분하고 고려할 내용도 너무 많아서 생략

참고: 실무에서 자바 표준인 JSR-330 Provider를 사용할 것인지, 아니면 스프링이 제공하는 ObjectProvider를 사용할 것인지 고민된다면 다음의 기준을 고려해보자.

• ObjectProvider의 편의 기능이 필요한가?
• 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 하는가? (사실 별로 그럴 일 없음)

스프링을 쓰다보면 자바 표준과 스프링이 제공하는 기능이 겹칠 때가 많이 있다. 대개는 스프링이 더 다양하고 편리한 기능을 제공하기 때문에, 특별히 다른 컨테이너를 사용할 일이 없다면 스프링이 제공하는 기능을 사용하면 된다. 다만 JPA 관련 기능이라면 표준을 쓰는 게 낫다.

---

웹 스코프

지금까지 싱글톤, 프로토타입 스코프를 배웠다. 이번엔 웹 스코프에 대해 알아보자.

웹 스코프의 특징

• 웹 스코프는 웹 환경에서만 동작한다.
• 웹 스코프는 스프링이 해당 스코프의 종료 시점까지 빈을 관리한다. 따라서 종료 메소드가 호출된다.

웹 스코프 종류

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

본 강좌에서는 request 스코프를 예제로 설명하기로 한다. 그러면 나머지는 다~ 이해가 됩니다.

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

• 클라이언트 A와 클라이언트 B는 각각의 request scope를 갖는다.
• 각각 A전용 빈, B전용 빈을 따로 생성해서 사용할 수 있다.
• 각 request scope는 request 응답이 나가면서 destroy된다.

request 스코프 예제 만들기

웹 환경 추가

웹 스코프는 웹 환경에서만 동작하므로 web 환경이 동작하도록 라이브러리를 추가하자.

build.gradle에 web 의존성을 추가한다.

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter'
    ...
}

참고: spring-boot-starter-web 라이브러리를 추가하면 스프링 부트는 내장 톰캣 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.

참고: 스프링 부트는 웹 라이브러리가 없으면 지금까지 우리가 학습한 AnnotationConfigApplicationContext를 기반으로 app을 구동한다. 웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요하므로 AnnotationConfigServletWebServiceApplicationContext를 기반으로 app을 구동한다.

만약 기본 포트인 8080을 이미 다른 용도로 사용 중이라면 포트를 변경하면 된다.

main/resources/application.properties

server.port=9090

request 스코프 예제 개발

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다. 이럴 때 사용하기 좋은 게 request scope이다.

다음과 같이 로그가 남도록 request scope를 활용해서 추가 기능을 개발해보자.

[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

• 기대하는 공통 포맷: [UUID][requestURL]{message}
• UUID를 사용해서 HTTP 요청을 구분하자
• requestURL 정보도 추가로 넣어서 어떤 URL을 요청해서 남은 로그인지 확인하자

MyLogger

@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 msg) {
        System.out.println("[" + uuid + "][" + requestURL + "] " + msg);
    }

    @PostConstruct
    public void init() {
        this.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);
    }
}

• 로그를 출력하기 위한 MyLogger 클래스이다.
• @Scope(value = "request")를 통해 request scope로 지정했다. 이제 이 빈은 HTTP 요청 하나 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.
• 이 빈이 생성되는 시점에 uuid를 생성해서 저장해둔다(init()). 이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 타 요청과 구분할 수 있다.
• 이 빈이 소멸되는 시점에 종료 메시지를 남긴다 (close())
• requestURL은 빈 생성 시점에 알 수 없으므로, 외부에서 입력받을 수 있도록 setter를 만들었다.

LogDemoController

@Controller
@RequiredArgsConstructor
public class LogDemoController {

    private final LogDemoSerivce logDemoSerivce;
    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");
        logDemoSerivce.logic("testId");
        return "OK";
    }
}

• MyLogger가 잘 작동하는지 확인하는 테스트용 컨트롤러다.
• 여기서 HttpServletRequest를 통해 요청 URL을 받을 수 있다.
• requestURL값을 myLogger에 세팅해준다. myLogger가 HTTP 요청 단위로 구분되므로, 다른 HTTP 요청 때문에 requestURL이 오염될 걱정은 하지 않아도 된다.
• "controller test"라는 로그를 남긴다.

참고: requestURL을 myLogger에 저장하는 부분은 컨트롤러보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터같은 곳을 활용하는 게 좋다. 여기서는 예제를 단순화하기 위해 컨트롤러를 사용한 것이다. 스프링 웹에 익숙하면 인터셉터를 사용하는 게 좋다.

LogDemoService

@Service
@RequiredArgsConstructor
public class LogDemoSerivce {

    private final MyLogger myLogger;

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

• 서비스 계층에서도 로그를 출력한다.
• 만약 request scope를 사용하지 않고, paramter로 모든 정보를 서비스 계층에 넘긴다면?
  • parameter가 많기 때문에 지저분해지고
  • 서비스 계층에선 아무 의미가 없는 정보를 처리해야하는 문제가 있다. (유지보수 관점에서 문제)
• 그래서 request scope의 MyLogger 덕분에 이런 부분을 parameter로 넘기지 않고 계층을 깔끔하게 구분할 수 있다.

근데 여기까지만 하고 실행해보면 오류가 발생한다.

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가 request scope에 있는데, HTTP request가 없어서 빈을 생성할 수 없다는 얘기다.
• 생각해보면, 컨테이너가 뜨는 시점엔 당연히 reqeust가 있을 리 만무하므로, 이런 오류가 나는 게 당연하다.
• 이 빈은 실제 고객의 HTTP request(요청)가 와야만 생성할 수 있다.
  • Provider로 해결해보자.

---

스코프와 Provider

첫번째 해결법은 Provider를 사용하는 것이다. ObjectProvider를 사용해보자.

@Controller
@RequiredArgsConstructor
public class LogDemoController {

    private final LogDemoSerivce logDemoSerivce;
    private final ObjectProvider<MyLogger> myLoggerProvider;	//수정

    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request) {
        MyLogger myLogger = myLoggerProvider.getObject();		//추가

        String requestURL = request.getRequestURL().toString();
        myLogger.setRequestURL(requestURL);

        myLogger.log("controller test");
        logDemoSerivce.logic("testId");
        return "OK";
    }
}

@Service
@RequiredArgsConstructor
public class LogDemoSerivce {

    private final ObjectProvider<MyLogger> myLoggerProvider;	//수정

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

[92a0435d...] request scope bean create:hello.core.common.MyLogger@f0f8fce
[92a0435d...][http://localhost:8080/log-demo] controller test
[92a0435d...][http://localhost:8080/log-demo] service id = testId
[92a0435d...] request scope bean close:hello.core.common.MyLogger@f0f8fce

• ObjectProvider 덕분에 ObjectProvider.getObject()를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.
• ObjectProvider.getObject()를 호출하는 시점에서는 HTTP 요청이 진행중이므로 request scope 빈이 잘 생성된다.
• ObjectProvider.getObject()를 LogDemoController, LogDemoSerivce에서 각각 한 번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다!

뭔가 더 간단히 할 수 없나? Provider 없이는 안되는걸까?

된다.

스코프와 프록시

프록시 방식을 사용해보자!

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

• proxyMode = ScopedProxyMode.TARGET_CLASS를 추가해준다.
  • 적용 대상이 클래스면 TARGET_CLASS를 선택
  • 적용 대상이 인터페이스면 INTERFACES를 선택
• 이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관없이 가짜 프록시 클래스를 다른 빈에 미리 주입해둘 수 있다.

Controller와 Service 클래스를 Provider 적용 이전으로 돌려놓고 돌려보면 잘 실행되는 것을 확인할 수 있다.

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

주입된 myLogger가 뭔지 확인해보자

System.out.println("myLogger = " + myLogger.getClass());

myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$b68b726d

• CGLIB이라는 라이브러리로 내 클래스를 상속받은 가짜 프록시 객체를 만들어서 주입한다.
  • 출력 결과를 확인해보면 우리가 만든 순수한 MyLogger 클래스가 아닌 $$EnhancerBySpringCGLIB이라는 클래스로 만들어진 객체가 대신 등록된 것을 확인할 수 있다.
  • 그리고 스프링 컨테이너에 myLogger라는 이름으로 이 가짜 프록시 객체를 등록한다.
  • ac.getBean("myLogger", MyLogger.class)로 빈을 조회해도 가짜 프록시 객체가 조회된다.
  • 의존관계 주입도 이 가짜 프록시 객체로 이루어진다.

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

• 가짜 프록시 빈은 내부에 실제 MyLogger의 참조를 갖고 있다.
• 클라이언트가 myLogger.logic()을 호출하면, 가짜 프록시 객체의 메소드가 호출된다.
• 가짜 프록시 객체는 진짜 myLogger를 찾는 방법을 알고 있다.
• 그래서 호출이 들어올 때 request scope의 진짜 myLogger.logic()을 호출한다.
  • (추측) 이 때 어떤 request냐에 따라 "진짜" myLogger 인스턴스를 찾아가는듯
• 가짜 프록시 객체는 원본 클래스(MyLogger)를 상속받아서 만들어졌기 때문에, 객체를 사용하는 클라이언트 입장에선 가짜인지 진짜인지 알 필요도 없다. (다형성)

동작 정리

• 처음 의존성 주입을 할 때 CGLIB이라는 라이브러리로 내 클래스를 상속받은 가짜 프록시 객체를 만들어서 주입한다.
  • 그렇기 때문에 HTTP request가 없더라도 주입이 가능
• 가짜 프록시 객체는 실제 request가 오면 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.
• 가짜 프록시 객체는 실제 request scope와는 관련이 없고, 내부에 위임 로직이 있을 뿐이다. 가짜 프록시 객체 자체는 싱글톤처럼 작동한다.

특징 정리

• 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope을 사용할 수 있다.
• 사실 Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리한다는 점이다.
• 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다! 다형성과 DI 컨테이너가 가진 장점을 잘 보여준다.
  • 클라이언트 코드의 변경이 필요없다!
• 꼭 웹 스코프가 아니더라도 프록시는 사용할 수 있다.
• AOP도 이와 비슷한 원리로 동작한다.
  • 메소드 로그, 시간 측정 등에 활용 가능

주의점

• 마치 싱글톤을 사용하는 것 같지만, 실제로는 request 마다 따로 생성되기 때문에 주의해서 사용해야 한다.
• 이런 특별한 scope는 필요한 곳에서만 최소한으로 사용해야 한다.

---

사용한 단축키

Ctrl+Alt+N: Inline Variable, 변수할당 없이 리턴하게끔 줄여줌