본문 바로가기
BackEnd/Spring

[스프링 기본] 빈 스코프

by 개발 Blog 2024. 7. 10.

공부 내용을 정리하고 앞으로의 학습에 이해를 돕기 위해 작성합니다.

 

빈 스코프란?

스프링 빈의 생명주기 범위를 정의하며, 기본적으로 싱글톤 스코프를 사용한다. 스코프는 빈이 존재할 수 있는 범위를 뜻한다.

 

스프링의 다양한 스코프

싱글톤: 기본 스코프로, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프.

프로토타입: 스프링 컨테이너는 빈의 생성과 의존관계 주입까지만 관여하고 이후에는 관리하지 않는 매우 짧은 범위의 스코프.

웹 관련 스코프 :

- request: 웹 요청이 들어오고 나갈 때까지 유지되는 스코프.

- session: 웹 세션이 생성되고 종료될 때까지 유지되는 스코프.

- application: 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프.

 

 

빈 스코프 지정 방법

컴포넌트 스캔 자동등록

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

 

수동 등록

@Scope("prototype")
@Bean
public PrototypeBean helloBean() {
    return new HelloBean();
}

 

프로토타입 스코프

싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환한다.

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

1. 싱글톤 스코프의 빈을 스프링 컨테이너에 요청한다.

2. 스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환한다.

3. 이후에 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈을 반환한다.

 

1. 프로토타입 스코프의 빈을 스프링 컨테이너에 요청한다.

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

 

3. 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환한다.

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

 

정리

스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다. 이후 프로토타입 빈의 관리는 클라이언트에 맡기며, 스프링 컨테이너는 더 이상 관리하지 않는다. 따라서 @PreDestroy 같은 종료 메서드가 호출되지 않는다.

 

싱글톤 스코프 빈 테스트

package hello.core.scope;

import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;

import static org.assertj.core.api.Assertions.*;

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

        assertThat(singletonBean1).isSameAs(singletonBean2);

        ac.close();
    }

    @Scope("singleton")
    static class SingletonBean {
        @PostConstruct
        public void init() {
            System.out.println("SingletonBean.init");
        }

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

}

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

 

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

package hello.core.scope;

import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;

import static org.assertj.core.api.Assertions.*;

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("prototypeBean.init");
        }

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

- 싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드가 실행된다. 반면, 프로토타입 스코프의 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고, 그때 초기화 메서드도 실행된다.
- 프로토타입 빈을 두 번 조회하면 각각 다른 스프링 빈이 생성되고, 초기화도 두 번 실행된다.

- 싱글톤 빈은 스프링 컨테이너가 관리하기 때문에, 스프링 컨테이너가 종료될 때 빈의 종료 메서드가 실행된다. 그러나 프로토타입 빈은 스프링 컨테이너가 생성, 의존관계 주입, 초기화까지만 관여하고 더는 관리하지 않는다. 따라서 프로토타입 빈은 스프링 컨테이너가 종료될 때 @PreDestroy 같은 종료 메서드가 실행되지 않는다.

 

프로토타입 빈의 특징

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

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

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

- 프로토타입 빈의 관리는 빈을 조회한 클라이언트가 해야 하며, 종료 메서드 호출도 클라이언트가 직접 해야 한다.

 

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

스프링 컨테이너에 프로토타입 스코프의 빈을 요청하면 항상 새로운 객체 인스턴스를 생성해서 반환한다.

하지만 싱글톤 빈과 함께 사용할 때는 의도한 대로 잘 동작하지 않으므로 주의해야 한다.

 

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

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

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

 

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

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

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

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

 

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

 

package hello.core.scope;

import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;

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

    @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)이 의존관계 주입을 통해서 프로토타입 빈을 주입받아서 사용하는 예를 보자

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

- clientBean은 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.

- 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환한다. 프로토타입 빈의 count 필드 값은 0이다.

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

 

- 클라이언트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가 된다.

 

package hello.core.scope;

import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
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 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 singletonClientUsePrototype() {
        AnnotationConfigApplicationContext ac
                = new AnnotationConfigApplicationContext(PrototypeBean.class, ClientBean.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;

        @Autowired
        public ClientBean(PrototypeBean prototypeBean) {
            this.prototypeBean = prototypeBean;
        }

        public int logic() {
            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");
        }
    }
}

싱글톤 빈이 프로토타입 빈을 사용하게 되면, 싱글톤 빈은 생성 시점에만 의존관계 주입을 받기 때문에, 프로토타입 빈이 새로 생성되더라도 싱글톤 빈과 함께 계속 유지되는 문제가 발생한다. 프로토타입 빈을 주입 시점에만 새로 생성하는 것이 아니라, 사용할 때마다 새로 생성해서 사용하는 것이 필요하다.

 

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

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

@Autowired
 private ApplicationContext ac;
 
 public int logic() {
    PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
    prototypeBean.addCount();
    int count = prototypeBean.getCount();
    return count;
}

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

- 실행해보면 ac.getBean()을 통해 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.

- 의존관계를 외부에서 주입받는 대신 직접 필요한 의존관계를 찾는 것을 Dependency Lookup (DL) 의존관계 조회라고 한다.

- 그러나 이렇게 하면 스프링 컨테이너에 종속적인 코드가 되어 단위 테스트가 어려워진다.

- 지금 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 간단한 DL 기능만 제공하는 무언가 있으면 된다.

 

ObjectFactory, ObjectProvider

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

@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanProvider;

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

- prototypeBeanProvider.getObject()를 통해 항상 새로운 프로토타입 빈이 생성된다.
- ObjectProvider의 getObject()를 호출하면 내부에서 스프링 컨테이너를 통해 해당 빈을 찾아 반환한다 (DL)
- 스프링의 단순한 기능을 사용하여 단위 테스트와 mock 코드 작성을 쉽게 할 수 있다.
- ObjectProvider는 필요한 DL 정도의 기능만 제공한다.

 

특징

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

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

 

JSR-330 Provider

마지막 방법은 jakarta.inject.Provider라는 JSR-330 자바 표준을 사용하는 방법이다.

 

사용하기 위해 gradle에 라이브러리를 추가한다.

implementation 'jakarta.inject:jakarta.inject-api:2.0.1'
@Autowired
private Provider<PrototypeBean> prototypeBeanProvider;

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

- provider.get()을 통해 항상 새로운 프로토타입 빈이 생성된다.
- provider의 get()을 호출하면 내부에서 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다 (DL)
- 자바 표준이고, 기능이 단순하여 단위 테스트와 mock 코드 작성이 쉽다.
- Provider는 필요한 DL 기능만 제공한다.

 

특징

- get() 메서드 하나로 기능이 매우 단순하다.

- 별도의 라이브러리가 필요하다.

- 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.

 

참고 : 실무에서 자바 표준인 JSR-330 Provider를 사용할지, 스프링이 제공하는 ObjectProvider를 사용할지 고민될 수 있다. ObjectProvider는 DL을 위한 편의 기능을 많이 제공하고, 스프링 외 별도의 의존관계 추가가 필요 없어 편리하다. 만약 코드를 스프링이 아닌 다른 컨테이너에서도 사용해야 한다면 JSR-330 Provider를 사용해야 한다.

스프링을 사용하다 보면 자바 표준과 스프링 기능이 겹칠 때가 많다. 대부분 스프링이 더 다양하고 편리한 기능을 제공하므로, 특별히 다른 컨테이너를 사용할 일이 없다면 스프링 기능을 사용하는 것이 좋다.

 

웹 스코프


웹 스코프 특징

- 웹 환경에서만 동작한다.

- 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다. 따라서 종료 메서드가 호출된다.

 

웹 스코프 종류

- request: HTTP 요청 하나가 들어오고 나갈 때까지 유지되는 스코프. 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리된다.

- session: HTTP 세션과 동일한 생명주기를 가지는 스코프.

- application: 서블릿 컨텍스트(ServletContext)와 동일한 생명주기를 가지는 스코프.

- websocket: 웹 소켓과 동일한 생명주기를 가지는 스코프.

request 스코프 예제 만들기

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

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

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

 

참고 : 스프링 부트는 웹 라이브러리가 없을 때 AnnotationConfigApplicationContext를 기반으로 애플리케이션을 구동한다.

웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경이 필요하므로 AnnotationConfigServletWebServerApplicationContext를 기반으로 애플리케이션을 구동한다.

 

request 스코프 예제 개발

동시에 여러 HTTP 요청이 오면 어떤 요청이 남긴 로그인지 구분하기 어렵다.

이럴 때 사용하기 좋은 것이 request 스코프이다.

 

request 스코프를 활용해서 추가 기능을 개발해보자.

package hello.core.common;

import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

import java.util.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 been create:" + this);
    }

    @PreDestroy
    public void close() {
        System.out.println("[" + uuid + "] request scope been close:" + this);
    }
}

- 로그를 출력하기 위한 클래스다.

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

- 이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성 후 저장한다.

- HTTP 요청 당 하나씩 생성되므로 uuid를 저장해 두면 다른 HTTP 요청을 구분할 수 있다.

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

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

 

package hello.core.web;

import hello.core.common.MyLogger;
import jakarta.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@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.getRequestURI().toString();
        myLogger.setRequestURL(requestURL);

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

    }
}

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

- HttpServletRequest를 통해 요청 URL을 받아 requestURL 값을 myLogger에 저장한다.

- myLogger는 HTTP 요청마다 구분되므로 값이 섞일 걱정이 없다.

- 컨트롤러에서 "controller test"라는 로그를 남긴다.

 

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final MyLogger myLogger;

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

- 서비스 계층에서도 로그를 출력할 때 request scope의 MyLogger를 사용하면, 파라미터가 많아지지 않아 코드가 깔끔해진다.

- requestURL 같은 웹 관련 정보가 서비스 계층까지 넘어가지 않도록 하여 서비스 계층을 웹 기술에 종속되지 않고 순수하게 유지할 수 있다.

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

MyLogger의 스코프는 request 스코프이기 때문에 아직 생성되지 않았으며, 스프링 컨테이너에 없다. 요청이 와야 생성된다.

 

스코프와 Provider

package hello.core.web;

import hello.core.common.MyLogger;
import jakarta.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@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의 지연로딩 기능 덕분에 실제 빈의 인스턴스가 필요할 때까지 생성을 지연시킬 수 있다.

- myLoggerProvider.getObject(); 에서 myLogger 빈을 생성한다.

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final ObjectProvider<MyLogger> myLoggerProvider;

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

 

이제 스프링을 실행 후 http://localhost:8080/log-demo를 입력해 보면 아래와 같은 결과가 나온다.

 

전체 흐름

 

1. HTTP 요청 수신

  • 클라이언트가 http://localhost:8080/log-demo로 요청을 보낸다.
  • 이 요청은 Spring의 DispatcherServlet에 의해 받아들여진다.

2. LogDemoController가 요청 처리

  • Spring MVC는 이 요청을 LogDemoController의 logDemo 메서드로 라우팅 한다.
  • logDemo 메서드는 HttpServletRequest 객체를 통해 요청 정보를 받는다.
  • 이 시점에서 ObjectProvider <MyLogger>를 사용하여 MyLogger 빈을 지연 로딩한다.

3. Request Scope 빈 생성

  • ObjectProvider.getObject()를 호출하면 MyLogger 빈이 생성된다.
  • 이 빈은 request scope로 정의되어 있기 때문에 현재 HTTP 요청 동안에만 유효하다.
  • MyLogger 빈은 requestURL을 설정하고 "controller test" 로그를 남긴다.

4. LogDemoService 호출

  • logDemo 메서드는 LogDemoService의 logic 메서드를 호출한다.
  • LogDemoService에서도 ObjectProvider.getObject()를 호출하여 MyLogger 빈을 가져온다.
  • 이 시점에도 같은 HTTP 요청이기 때문에 동일한 MyLogger 빈이 반환된다.
  • logic 메서드는 추가적인 로깅을 수행한다.

5. HTTP 응답 반환

  • LogDemoController는 클라이언트에게 응답을 반환한다. (Completed 200 OK)

6. Request Scope 빈 소멸:

  • 요청이 완료되면 request scope 빈의 생명 주기가 끝난다.
  • 이 시점에 MyLogger의 @PreDestroy 메서드가 호출되어 request scope bean close를 출력한다.

정리

1. ObjectProvider를 사용한 지연 로딩

- ObjectProvider.getObject()를 호출할 때까지 request scope 빈의 생성을 지연할 수 있다.

2. HTTP 요청 중 request scope 빈 생성

- ObjectProvider.getObject()가 호출되는 시점에 HTTP 요청이 진행 중이므로 request scope 빈이 정상적으로 생성된다.

3. 같은 HTTP 요청에서 동일한 빈 반환

- LogDemoController와 LogDemoService에서 각각 ObjectProvider.getObject()를 호출하더라도 같은 HTTP 요청이라면 동일한 request scope 빈이 반환된다.

 

이와 같이, ObjectProvider는 빈 생성을 필요할 때까지 지연시켜 성능을 최적화하고, 동일한 HTTP 요청에서 동일한 request scope 빈을 반환함으로써 일관성을 유지하는 데 유용하다.

 

스코프와 프록시

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

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

- 적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS, 인터페이스면 INTERFACES를 선택

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

 

컨트롤러와 서비스는 Provider 이전 코드로 돌려놓는다.

package hello.core.web;

import hello.core.common.MyLogger;
import jakarta.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

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

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

        myLogger.setRequestURL(requestURL);

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

    }
}

 

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class LogDemoService {
    private final MyLogger myLogger;

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

- 로그 찍은 부분을 보면 순수한 MyLogger 클래스가 아니라 가짜 프록시 객체가 찍힌 것을 볼 수 있다. (MyLogger@5f79c5e5)

 

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

 

Scoped Proxy 설정

  •  @Scope(proxyMode = ScopedProxyMode.TARGET_CLASS) 설정을 사용하면 Spring 컨테이너는 CGLIB 라이브러리를 이용해 가짜 프록시 객체를 생성한다.

프록시 객체 생성

  •  MyLogger를 상속받은 가짜 프록시 객체가 생성되며, 이는 MyLogger$EnhancerBySpringCGLIB 같은 이름으로 만들어진다.

프록시 객체 등록

  •  Spring 컨테이너는 실제 MyLogger 대신 이 가짜 프록시 객체를 "myLogger"라는 이름으로 등록한다.

Bean 조회

  •  ac.getBean("myLogger", MyLogger.class)으로 조회하면 진짜 MyLogger가 아닌 프록시 객체가 반환된다.

의존관계 주입

  •  의존관계 주입 시에도 진짜 객체 대신 이 가짜 프록시 객체가 주입된다.

 

 

가짜 프록시 객체

- 가짜 프록시 객체는 내부에 진짜 `myLogger`를 찾는 방법을 알고 있다.

- 클라이언트가 `myLogger.log()`를 호출하면, 실제로는 가짜 프록시 객체의 메서드를 호출하게 된다.

- 이 프록시 객체는 request 스코프의 진짜 `myLogger.log()`를 호출한다.

- 가짜 프록시 객체는 원본 클래스를 상속받아 만들어지기 때문에, 클라이언트는 원본 클래스인지 프록시 클래스인지 구분하지 않고 동일하게 사용할 수 있다(다형성).

동작 원리

- CGLIB 라이브러리는 내 클래스를 상속받은 가짜 프록시 객체를 생성하여 주입한다.

- 이 프록시 객체는 요청이 오면 내부에서 실제 빈을 요청하는 위임 로직을 포함하고 있다.

- 가짜 프록시 객체는 request scope와는 관계없이 단순한 위임 로직만 가지고 싱글톤처럼 동작한다.

 

특징 

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

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

- 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다.

- 이는 다형성과 DI 컨테이너의 큰 강점이다.

- 프록시는 웹 스코프 외의 상황에서도 사용할 수 있다.

 

주의점

- 마치 싱글톤을 사용하는 것처럼 보이지만, 다르게 동작하기 때문에 주의해서 사용해야 한다. 

- 꼭 필요한 곳에만 최소화하여 사용하고, 무분별하게 사용하면 유지보수하기 어려워진다.