[스프링 핵심 원리 - 기본편] #9. 빈 스코프 (2)

[cyzlcyzl]

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

프토토타입 스코프의 빈 요청 ➡️ 항상 새로운 객체 인스턴스 생성해서 반환
싱글톤 빈과 함께 사용할 때는 의도한 대로 잘 동작하지 않음

프로토타입 빈 직접 요청

프로토타입 빈을 직접 요청하면 할 때마다 빈을 새로 생성해서 해당 빈의 count 필드 값은 0이다. 여러번 호출해도 0이다.

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

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

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

• clientBean은 싱글톤이므로 스프링 컨테이너 생성 시점에 생성되고 의존관계 주입도 발생함
• 1. clientBean은 의존관계 자동 주입을 사용함. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청
• 2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환. 프로토타입 빈의 count 필드 값은 0임
• clinetBean은 프로토타입 빈을 내부 필드에 보관함

• 클라이언트 A는 clientBean을 스프링 컨테이너에 요청하면 싱글톤이므로 항상 같은 clientBean이 반환됨
• 3. 클라이언트 A는 clientBean.logic()을 호출
• 4. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가하여 count 값은 1이 됨

• clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다. 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성 된 것이지 사용할 때마다 새로 생성된 것이 아니다.
• 5. 클라이언트 B는 clientBean.logic() 호출
• 6. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가함. 원래 1이었던 값이 공유되어 2가 된다.

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

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

💡 참고 여러 빈에서 같은 프로토타입 빈을 주입 받으면, 주입 받는 시점에 각각 새로운 프로토타입 빈이 생성됨
clientA ➡️ prototypeBean@x01
clientB ➡️ prototypeBean@x02
사용할 때마다 새로 생성되는 것은 아니다.

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

스프링 컨테이너에 요청

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

과거에 ObjectFactory가 있었고 여기에 편의 기능이 추가된 것이 ObjectProvider

• 지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스 제공

@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 코드를 만들기는 훨씬 쉬워짐
• 딱 필요한 DL 정도의 기능만 제공

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

JSR-330 Provider

jakarta.inject.Provider (스프링부트 3.0 이상부터) 라는 JSR-330 자바 표준을 사용하는 방법이다.

• 라이브러리를 추가해야 한다.

@Autowired
private Provider<PrototypeBean> provider;

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

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

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

💡 참고
자바 표준 JSR-330 Provider vs ObjectProvider

• ObjectProvider은 별도의 라이브러리 추가 없이 편리하게 사용할 수 있음
• (그럴일은 거의 없지만) 코드를 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 한다면 자바 표준 사용

웹 스코프

• 웹 환경에서만 동작
• 해당 스코프의 종료 시점까지 관리함 ➡️ 종료 메서드 호출

웹 스코프 종류

• request: HTTP 요청 하나가 들어오고 나갈 때까지 유지되는 스코프
• session: HTTP Session과 동일한 생명주기를 가지는 스코프
• application: 서블릿 컨텍스트와 동일한 생명주기를 가지는 스코프
• web socket: 웹 소켓과 동일한 생명주기를 가지는 스코프

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

request 스코프 예제

웹 스코프는 웹 환경에서만 동작하므로 웹 환경이 동작하도록 라이브러리를 추가해줘야 함

• 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분
  • UUID 사용

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

• 로그를 출력하기 위한 클래스
• @Scope(value="request")를 사용해서 스코프 지정
• 이 빈은 HTTP 요청 당 하나씩 생성되고, 요청이 끝나는 시점에 소멸함
• 이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장
• HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있음
• 이 빈이 종료되는 시점에 @PreDestory를 사용해서 종료 메시지를 남김
• requestURL은 이 빈이 생성되는 시점에는 알 수 없으므로 외부에서 setter로 입력 받음

@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을 받음
• requestURL 값을 myLogger에 저장해두면 HTTP 요청 당 각각 구분되므로 다른 요청과 섞일 일은 없음

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

• 서비스 로직
• 웹과 관련된 부분은 컨트롤러까지만 사용해야함
• 서비스 계층은 웹 기술에 종속되지 않고 가급적 순수하게 유지하는 것이 유지보수 관점에 좋음
• 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";
    } 
}

@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 빈의 생성 지연 (정확히 말하면 빈의 생성을 지연시킨다보다는 빈의 호출 시점을 지연하는 것임)
• 위 메서드를 호출하는 시점에는 HTTP 요청이 진행 중이므로 request scope 빈의 생성이 정상 처리
• 컨트롤러와 서비스에서 각각 한번식 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환됨!

스코프와 프록시

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

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

나머지 코드는 Provider 사용 이전으로 돌림 ➡️ 정상 동작

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

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

• 순수한 MyLogger 클래스가 아니라 프록시 객체가 대신 등록됨을 확인
• 스프링 컨테이너에는 이 가짜 프록시 객체가 "myLogger"라는 이름으로 등록됨
• 의존관계 주입도 가짜 프록시 객체 주입

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

• 가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게 동일하게 사용할 수 있음 (다형성)

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

• 무엇을 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리함

• 애코테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있음

• 웹 스코프가 아니어도 프록시는 사용할 수 있음

💡 주의

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