(Spring) 빈 스코프

짜스의 하루 ·2024년 2월 27일
김영한 스프링 핵심 원리 - 기본편 참고

빈 스코프란?

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

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

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

컴포넌트 스캔 자동 등록

@Scope("prototype")
@Component
public class HelloBean{}

수동 등록

@Scope("prototype")
@Bean
PropotypeBean HelloBean(){
	return new HelloBean();
    }

지금까지 싱글톤 스코프를 계속 사용해 보았으니, 프로토타입 스코프부터 확인해보자

프로토타입 스코프

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

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

  • 프로토타입 스포크의 빈을 스프링 컨테이너에 요청을 한다.
  • 스프링 컨테이너는 이 시점에 프로토타입 빈을 생성하고, 필요한 의존관계를 주입한다.
  • 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환한다.
  • 이후에 스프링 컨테이너에 같은 요청이 오면, 항상 새로운 프로토타입 빈을 생성해서 반환한다.

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

클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다.
프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다. 따라서 @PreDestroy와 같은 종료 메서드가 호출되지 않는다!

싱글톤 스코프 빈 테스트

public class SingletonTest {

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

        Assertions.assertThat(singletonBean1).isSameAs(singletonBean2);
        ac.close();

    }
    static class singletonBean{

        @PostConstruct
        public void init(){
            System.out.println("singletonBean.init");
        }

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

테스트 실행 결과

  • 빈 초기화 메서드를 실행하고
  • 같은 인스턴스의 빈을 조회하고
  • 종료 메서드까지 정상 호출된 것을 확인할 수 있다.

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

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);

        Assertions.assertThat(prototypeBean1).isNotSameAs(prototypeBean2);
        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");
        }
    }
}

테스트 실행 결과

  • 싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드가 실행되지만, 프로토타입 스코프의 빈은 스프링 컨테이너에서 빈을 조회할 때 생성고, 초기화 메서드도 실행된다.
  • 프로토타입 빈을 2번 조회했으므로, 완전히 다른 스프링 빈이 생성되고, 초기화도 2번 실행된 것을 확인할 수 있다.
  • 싱글톤 빈은 스프링 컨테이너가 관리하기 때문에 스프링 컨테이너가 종료될 때 빈의 종료 메서드가 실행되지만,
    프로토타입 빈은 스프링 컨테이너가 생성과 의존관계 주입, 그리고 초기화 까지만 관여하고, 더는 관리하지 않는다.

프로토타입 빈의 특징 정리

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

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

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

먼저 스프링 컨테이너에 프로토타입 빈을 직접 요청하는 예제를 보자.

프로토타입 빈 직접 요청

  • 클라이언트 A는 스프링 컨테이너에 프로토타입 빈을 요청한다

  • 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x01)한다. 해당 빈의 count 필드 값은 0이다.

  • 클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하면서 count 필드를 +1한다

  • 결과적으로 프로토타입 빈(x01)의 count는 1이다.

  • 클라이언트B는 스프링 컨테이너에 프로토타입 빈을 요청한다.

  • 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x02)한다. 해당 빈의 count 필드 값은 0이다.

  • 클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하면서 count필드를 +1fmf gksek.

  • 결과적으로 프로토타입 빈(x02)의 count는 1이된다.

코드로 확인해보자

public class SingletonWithPrototypeTest1 {

    @Test
    void prototypeFind(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(Prototype.class);
        Prototype prototype1 = ac.getBean(Prototype.class);
        prototype1.addCount();
        assertThat(prototype1.getCount()).isEqualTo(1);

        Prototype prototype2 = ac.getBean(Prototype.class);
        prototype2.addCount();
        assertThat(prototype2.getCount()).isEqualTo(1);




    }

    @Scope("prototype")
    static class Prototype{
        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 " + this);
        }
    }
}

테스트 실행 결과
* 참조값이 다르게 나온 것을 확인할 수 있다

싱글톤 빈에서 프로토타입 빈 사용
이번에는 clientBean이라는 싱글톤 빈이 의존관계 주입을 통해서 프로토타입 빈을 주입받아서 사용해보자.

  • clientBean은 싱글톤이므로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 함께 발생한다.
  • clientBean은 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.
  • 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환한다. 프로토타입 빈의 count 필드 값은 0이다.
  • 클라이언트 A는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean이 반환된다.
  • 클라이언트 A는 clientBean.logic()을 호출한다.
  • clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가한다. count 값이 1이 된다.
  • 클라이언트 B는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean이 반환된다.
  • 여기서 중요한 점이 있는데, clientBean 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다.
    의존 관계 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된것이지, 사용할 때마다 새로 생성되는 것은 아니다.
  • 클라이언트 B는 clientBean.logic()을 호출한다.
  • clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가시킨다. 원래 count 값이 1이었으므로 2가 된다.

테스트 코드를 작성해보자

public class SingletonWithPrototypeTest1 {

    @Test
    void prototypeFind(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);
        PrototypeBean prototype1 = ac.getBean(PrototypeBean.class);
        prototype1.addCount();
        assertThat(prototype1.getCount()).isEqualTo(1);

        PrototypeBean prototype2 = ac.getBean(PrototypeBean.class);
        prototype2.addCount();
        assertThat(prototype2.getCount()).isEqualTo(1);
    }
    @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;

        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 " + this);
        }
    }
}
  • PrototypeBean은 프로토타입 스코프지만 clientBean은 싱글톤 스코프이기 때문에, 싱글톤 빈에서 프로토타입 빈을 사용한다.
    그런데 싱글톤 빈은 생성 시점에만 의존관계 주입을 받기 때문에, 프로토타입 빈이 새로 생성되기는 하지만, 싱글톤 빈과 함께 계속 유지되는 것이 문제다.

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

위에서 싱글톤 빈과 프로토타입 빈을 혼용하는 경우, 프로토타입의 의도대로 동작하지 않는 문제점을 발견했다.
그럼 어떻게 싱글톤 빈과 혼용하더라도 프로토타입 빈을 매번 새롭게 생성하면서 사용할 수 있을까?

간단히 사용해보면 싱글톤 빈에서 프로토타입 빈을 매번 새로 호출해서 사용하는 방법이 있을 것이다.

ClientBean 핵심 코드 수정

static class ClientBean{
		@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) 의존관계 조회(탐색)이라고 한다.
  • 하지만 이렇게 스프링 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너와 종속성이 생기고 테스트도 어려워진다.
  • 지금 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 딱! DL 정도의 기능만 제공하는 무언가가 있으면 된다.
    --> 프로토타입 스코프의 빈을 필요로 하는 코드에서 해당 빈을 매번 새로 생성하고 가져오는 작업을 자동으로 수행해주는 것을 의미

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

 static class ClientBean{
        
        @Autowired
        private ObjectProvider<PrototypeBean> prototypeBeanProvider;

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

테스트 실행 결과

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

특징

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

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

특징

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

정리

  • 그렇다면, 프로토타입 빈은 언제 사용할까?
    매번 사요할 때마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용하면 된다.
    --> 실무에서 웹 애플리케이션을 개발해보면, 싱글톤 빈으로 대부분 문제를 해결할 수 있기 때문에, 프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다.
  • ObjectProvider, JSR330 Privider등은 프로토타이 뿐만 아니라, DL이 필요한 경우는 언제든지 사용할 수 있다.

참고: ObjectProvider는 DL을 위한 편의 기능을 많이
제공해주고 스프링 외에 별도의 의존관계 추가가 필요 없기 때문에 편리하다.

스프링을 사용하다 보면, 이 기능 뿐만 아니라 다른 기능들도 자바 표준과 스프링이 제공하는 기능이 겹칠때가 많이 있다. 대부분 스프링이 더 다양하고 편리한 기능을 제공해 주기 떄문에, 특별히 다른 컨테이너를 사용할 일이 없다면, 스프링이 제공하는 기능을 사용하면 된다

DL이란?

"DL"은 "Dependency Lookup"의 약자로, 의존성 검색을 나타낸다.
주로 프레임워크나 컨테이너에서 빈(Bean)이나 서비스 등을 필요로 하는 객체가 직접 해당 의존성을 찾아오는 패턴을 의미한다.

간단하게 설명하면, 객체가 자신이 필요로 하는 의존성이나 서비스를 직접 찾아서 사용하는 것을 의미한다. 이는 주로 의존성 주입(Dependency Injection)이라는 개념과 대조되는데, 의존성 주입은 외부에서 의존성을 주입받아 사용하는 패턴이다.

웹 스코프

싱글톤 : 스프링 컨ㅌ이너의 시작과 끝까지 함께하는 매우 긴 스코프
프로토타입 : 생성과 의존관계 주입, 초기화까지만 진행하는 특별한 스코프

웹 스코프의 특징

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

웹 스코프의 종류

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

사실 세션이나, 서블릿 컨텍스트, 웹 소켓 같은 용어를 잘 모르는 분들도 있을 것이다. 여기서는 request 스코프를 예제로 설명하겠다. 나머지도 범위만 다르지 동작 방식은 비슷하다.

request 스코프 예제 만들기

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

1.build.gradle에 추가

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

이제 hello.core.Corepplication의 main 메서드를 실행하면 웹 애플리케이션이 실행되는 것을 확인할 수 있다. 

Tomcat started on port(s): 8080 (http) with context path ''
Started CoreApplication in 0.914 seconds (JVM running for 1.528)

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

  • 만약 실행했을 때, 기본 포트인 8080포트가 사용중이라면, main/resources/application.properties에서 다음 내용을 추가해 포트를 변경하자.
server.port = 9090

2. request 스코프 예제 개발
동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다. 이럴때 사용하기 딱 좋은 것이 바로 request 스코프이다.
다음과 같이 로그가 남도록 request 스코프를 활용해서 추가 기능을 개발해보자.

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

MyLogger

@Component
@Scope(value = "request")
@Setter
public class MyLogger {

    private String uuid;
    private String 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);
    }
}
  • 로그를 출력하기 위한 MyLogger 클래스이다.
  • @Scope(value = "request")를 사용해서 request 스코프를 지정했다.
    이제 이 빈은 HTTP요청 당 하나씩 생성되고, HTTP요청이 끝나는 시점에 소멸된다.
  • 이 빈이 생성되는 시점에 자동으로 @PostCOnstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장하고, 이 빈은 HTTP요청당 하나씩 생성되므로uuid를 저장해두면, 다른 HTTP요청과 구분할 수 있다.
  • 이 빈이 소멸되는 시점에 @PreDestory를 사용해서 종료 메시지를 남긴다.
  • requestURL은 이 빈이 생성되는 시점에는 알 수 없으므로 외부에서 setter로 입력 받는다.(롬복 활용)

LogDemoController

@Controller
@RequiredArgsConstructor
public class LogDemoController {
    private final MyLogger myLogger;
    private final LogDemoService logDemoService;

    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request){
        String requestURI =request.getRequestURI();
        myLogger.setRequestURL(requestURI);
        
        myLogger.log("controller test");
        logDemoService.logic("testId");
        return "OK";
    }
}
  • 로거가 잘 작동하는지 확인하는 테스트용 컨트롤러이다.
  • 여기서 HttpServletRequest를 통해서 요청 URL을 받았다.
  • requestURL 값 http://localhost:8080/log-demo
  • 이렇게 받은 requestURL 값을 myLogger에 저장해둔다.
    myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP요청 떄문에 값이 섞이는 걱정은 하지 않아도 된다.
  • 컨트롤러에서 controller test라는 로그를 남긴다.

LogDemoService

@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의 멤버 변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.

3. 실행
테스트를 위해 CoreApplication을 실행시켜보면, 에러가 발생한다.
스프링 애플리케이션을 실행하는 시점에 싱글톤 빈은 생성해서 주입이 가능하지만, request 스코프 빈은 아직 생성되지 않고 실제 고객의 요청이 와야 생성할 수 있기 때문이다.

다시 말해, 해당 프로젝트가 구동될때, 스프링 빈들이 컴포넌트 스캔이 되며 등록 및 의존관계 주입이 되는데, 여기서 웹 스코프인 MyLogger빈의 경우, HTTP request 요청이 올 때 생성이 되는 빈이기 때문에 스프링 구동단계에서는 아직 생성할 수 없다.

마지막으로 정리하자면, 스프링 구동시, MyLogger 스프링 빈을 등록을 요구하는데, 해당 빈은 자신이 생성되어야 할 스코프 범위에 해당되지 않았기 때문에 에러가 발생한다.

그럼 해당 스프링 빈은 스프링 구동시점이아닌 사용자의 HTTP request 요청 시점에 생성될 수 있다는 말인데,
이를 해결하기위한 방법들에 대해 알아보자.

스코프와 Provider

첫번째 해결 방안은 앞서 배운 Provider을 사용하는 것이다.
간단히 ObjectProvider를 사용해보자. 

@Controller
@RequiredArgsConstructor
public class LogDemoController {

    private final LogDemoService logDemoService;
    private final ObjectProvider<MyLogger> myLoggerProvider;

    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request) {
        MyLogger myLogger = myLoggerProvider.getObject();
        String requestURI = request.getRequestURI();
        myLogger.setRequestURL(requestURI);

        myLogger.log("controller test");
        logDemoService.logic("testId");
        return "OK";
    }
}
@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final ObjectProvider<MyLogger> myLoggerProvider;
    public void logic(String id) {
        MyLogger myLogger = myLoggerProvider.getObject();
        myLogger.log("service id = " + id);
    }
}
  • ObjectProvider 덕분에 ObjectProvider.getObject()를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.
    --> ObjectProvider< MyLogger >를 사용함으로써 MyLogger 빈을 런타임에 가져와서 사용함으로써, HTTP 요청이 들어올 때마다 새로운 MyLogger 인스턴스를 생성하고 이를 동적으로 활용할 수 있게 되는 것이다.
  • ObjectProvider.getObject()를 호출하는 시점에는 HTTP오청이 진행중이므로 request scope 빈의 생성이 정상 처리된다.
  • ObjectProvider.getObject()를 LogDemoController, LogDemoService에서 각각 한번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다

스코프와 프록시

이번에는 프록시 방법을 사용해보자

@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
  • 여기가 핵심이다. proxyMode = ScopedProxyMode.TARGET_ClASS를 추가해주자
  • 이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고, HTTP request와 상관없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.

이제 나머지 코드를 Provider사용 전으로 돌려보자

@Controller
@RequiredArgsConstructor
public class LogDemoController {

    private final LogDemoService logDemoService;
    private final MyLogger myLogger;

    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request) {
        String requestURI = request.getRequestURI();
        myLogger.setRequestURL(requestURI);

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

@Service
@RequiredArgsConstructor
public class LogDemoService {

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

실행해보면, 잘 동작하는 것을 확인할 수 있다.
코드를 잘 살펴보면, LogDemoController, LogDemoServicd는 Provider 사용 전과 완전히 동일하다.

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

먼저 주입된 myLogger를 확인해보자

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


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

  • @scope의 proxyMode = ScopedProxyMode.TARGET_CLASS를 설정하면, 스프링 컨테이너는 CGLIB라는 바이트 코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속 받은 가짜 프록시 객체를 생성한다.
  • 결과를 확인해보면 우리가 등록한 순수한 MyLogger 클래스가 아니라 MyLogger$$EnhancerBySpringCGLIB라는 클래스로 만들어진 객체가 대신 등록된 것을 확인할 수 있다.
  • 그리고 스프링 컨테이너에 "myLogger"이라는 이름으로 진짜 대신에 이 가짜 프록시 객체를 등록한다.
  • ac.getBean("myLogger", MyLogger.class)로 조회해도 프록시 객체가 조회되는 것을 확인할 수 있다.
  • 그래서 의존관계 주입도 이 가짜 프록시 객체가 주입된다.

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

동작 정리

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

특징 정리

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

주의점

  • 마치 시글톤을 사용하는 것 같지만 다르게 동작하기 떄문에 결국 주의해서 사용해야 한다
  • 이런 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용하자, 무분별하게 사용하면 유지보수 하기가 어려워진다.
profile
짜스의 하루
2024. 01. 02 ~ 백앤드 공부 시작, 2024. 04.01 ~ 프론트 공부 시작
이전 포스트

(Spring) 빈 생명주기 콜백

다음 포스트

(HTTP) 인터넷 네트워크 - 인터넷 통신, IP(인터넷 프로토콜)

0개의 댓글