모르지 않다는 것은 아는것과 다르다.

Spring

빈 스코프

채마스 2022. 2. 26. 02:35

빈 스코프란?

  • 보통 스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어서 스프링 컨테이너가 종료될 때 까지 유지된다고 알고있다.
    • 그 이유는 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다.
    • 스코프는 번역 그대로 빈이 존재할 수 있는 범위를 뜻한다.
  • 스프링은 다음과 같은 다양한 스코프를 지원한다.
    • 싱글톤: 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프이다.
    • 프로토타입: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프이다.
    • 웹 관련 스코프
      • request: 웹 요청이 들어오고 나갈때 까지 유지되는 스코프이다.
      • session: 웹 세션이 생성되고 종료될 때 까지 유지되는 스코프이다.
      • application: 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프이다.





프로토타입 스코프

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

    1. 프로토타입 스코프의 빈을 스프링 컨테이너에 요청한다.
    1. 스프링 컨테이너는 이 시점에 프로토타입 빈을 생성하고, 필요한 의존관계를 주입한다.
    1. 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환한다.
    1. 이후에 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환한다.
    • 핵심은 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다는 것이다.
    • 클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다. 프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다.
  • 그래서 @PreDestroy 같은 종료 메서드가 호출되지 않는다.





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

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

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

        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");
            }
        } 
    }
  • 클라이언트 A 가 logic을 호출할때도 1을 반환되기를 원하고, 클라이언트 B 가 logic을 호출할때도 1을 반환되기를 원하지만 싱글톤으로 구현돤 ClientBean 안에 선언된 PrototypeBean은 프로토타입 빈이지만 요청할 때마다 새로 생성되지 않아서 1을 반환할 수 없게 된다.
  • clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다.
  • 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것이지, 사용 할 때마다 새로 생성되는 것이 아니다!
  • 프로토타입빈을 사용했다는 것은 프로토타입 빈을 주입 시점에만 새로 생성하는게 아니라, 사용할 때 마다 새로 생성해서 사용하는 것을 원할 것이다.
    • 이럴땐 Provider 로 해결할 수 있다. -> 많이 사용하지 않는다. (ObjectProvider를 더 많이 사용하기 때문)
       public int logic() {
        PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
        prototypeBean.addCount();
        int count = prototypeBean.getCount();
        return count;
      }
    • 의존관계를 외부에서 주입(DI) 받는게 아니라 이렇게 직접 필요한 의존관계를 찾는 것을 Dependency Lookup (DL) 의존관계 조회(탐색) 이라한다.
    • 그런데 이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다.
    • 그렇기 때문에 스프링에서 지원하는 ObjectFactory, ObjectProvider를 사용해서 DL 기능을 처리할 수도 있다.
      public int logic() {
        PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
        prototypeBean.addCount();
        int count = prototypeBean.getCount();
        return count;
      }
    • 지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하는 것이 바로 ObjectProvider 이다.
    • 실행해보면 prototypeBeanProvider.getObject() 을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
    • ObjectProvider 의 getObject() 를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. (DL)
    • 스프링이 제공하는 기능을 사용하지만, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다.
    • ObjectProvider 는 지금 딱 필요한 DL 정도의 기능만 제공한다.





웹 스코프

  • 웹 스코프의 특징
    • 웹 스코프는 웹 환경에서만 동작한다.
    • 웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다. 따라서 종료 메서드가 호출된다.
  • 웹 스코프 종류
    • request: HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고, 관리된다.
    • session: HTTP Session과 동일한 생명주기를 가지는 스코프
    • application: 서블릿 컨텍스트( ServletContext )와 동일한 생명주기를 가지는 스코프
    • websocket: 웹 소켓과 동일한 생명주기를 가지는 스코프
  • request 스코프 예제 개발
    @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);
        }
    }
  • 로그를 출력하기 위한 MyLogger 클래스이다.
  • @Scope(value = "request") 를 사용해서 request 스코프로 지정했다. 이제 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.
  • 이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다. 이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.
  • 이 빈이 소멸되는 시점에 @PreDestroy 를 사용해서 종료 메시지를 남긴다.
    @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";
        } 
    }
  • 로거가 잘 작동하는지 확인하는 테스트용 컨트롤러다.
  • 여기서 HttpServletRequest를 통해서 요청 URL을 받았다.
  • myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.
  • 컨트롤러에서 controller test라는 로그를 남긴다.
  • 하지만 위의 코드는 오류가 발생한다.
    • private final LogDemoService logDemoService; , private final MyLogger myLogger; 에서 의존성을 주입 받아야하는데, MyLogger 는 스코프가 request이기 때문에 컨트롤러를 주입하는 시점에서는 할당될 수 없다.
    • 위의 문제를 아래와 같이 Provider를 통해서 해결할 수 있다.
      @Controller
      @RequiredArgsConstructor
      public class LogDemoController {
          private final LogDemoService logDemoService;
          private final ObjectProvider<MyLogger> myLoggerProvider;
    
          @RequestMapping("log-demo")
          @ResponseBody
          public String logDemo(HttpServletRequest request) {
              String requestURL = request.getRequestURL().toString();
              MyLogger myLogger = myLoggerProvider.getObject();
              myLogger.setRequestURL(requestURL);
              myLogger.log("controller test");
              logDemoService.logic("testId");
              return "OK";
          } 
      }
    • ObjectProvider 덕분에 ObjectProvider.getObject() 를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.
    • ObjectProvider.getObject() 를 호출하시는 시점에는 HTTP 요청이 진행중이므로 request scope 빈의 생성이 정상 처리된다.
    • 하지만 Provider 조차도 안쓰고 해결할 수도 있다. -> 프록시를 이용하면된다.





스코프와 프록시

    @Component
    @Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
    public class MyLogger {
    }
  • 위와 같이 proxyMode = ScopedProxyMode.TARGET_CLASS 를 추가한다.
    • 용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS 를 선택한다.
    • 적용 대상이 인터페이스면 INTERFACES 를 선택한다.
  • 프록시를 사용하면 굳이 provider를 사용하지 않아도 된다.
  • 이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.
  • 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope를 사용할 수 있다.
  • 사실 Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 점이다.
  • 단지 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다. 이것이 바로 다형성과 DI 컨테이너가 가진 큰 강점이다.
  • 꼭 웹 스코프가 아니어도 프록시는 사용할 수 있다.
  • 마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 결국 주의해서 사용해야 한다.
  • 이런 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용하자, 무분별하게 사용하면 유지보수하기 어려워진다.



REFERENCES

  • 김영한님의 스프링 핵심 원리 - 기본편

'Spring' 카테고리의 다른 글

서블릿 구조  (0) 2022.02.26
서블릿 예외처리  (0) 2022.02.26
빈 생명주기와 콜백  (0) 2022.02.26
Transactional Propagation  (0) 2022.02.26
SpringMVC  (0) 2022.02.26