BackEnd/Spring

[Spring] 빈 스코프

샤아이인 2022. 2. 8.

내가 공부한것을 올리며, 중요한 단원은 저 자신도 곱씹어 볼겸 상세히 기록하고 얕은부분들은 가겹게 포스팅 하겠습니다.

1. 빈 스코프란?

빈 스코프란 말 그대로 빈이 생존할 수 있는 범위(기간)을 의미한다.

지금까지 공부했던, 스프링 컨테이너가 생성될때 같이 생성되서 ~ 스프링 컨테이너가 종료될때 까지 유지되는 범위는 싱글톤 범위이다.

스프링은 다음과 같은 다양한 스코프를 지원하고 있다.

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

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

웹 관련 스코프

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

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

- application: 웹의 Servlet Context와 같은 범위로 유지되는 스코프이다.

빈 스코프는 다음과 같이 지정할 수 있다.

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

2. 프로토타입 스코프

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

1. Client가 프로토타입의 빈을 스프링 컨테이너에 요청합니다.

2. 요청을 받고서야 비로소 스프링 컨테이너가 프로토타입 빈을 생성하고, 필요한 의존관계를 주입합니다.

3. 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환합니다. (다음 사진 참고)

4. 이후 스프링 컨테이너에 같은 요청이 들어오면 새로운 프로토 타입 빈을 생성하여 반환한다.

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

이후 클라이언트에게 빈을 반환하면, 이후부터는 스프링컨테이너가 아닌 클라이언트가 직접 관리해야한다.

따라서 @PreDestroy 같은 종료 메서드는 자동으로 호출되지 않는다.

다음 테스트 코드를 확인해 봅시다!

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

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

실행 결과는 다음과 같습니다.

프로토타입의 빈이 2번 생성된것을 확인할 수 있습니다. 또한 빈의 참조값을 보면 @3697186 과 @1583741e 로 서로 다른 빈임을 알수 있습니다.

마지막으로 스프링 컨테이너 종료 전 @PreDestroy 같은 빈들의 종료 작업이 이루어지지 않았음을 알수있습니다.

● 프로토타입 빈의 특징 정리

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

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

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

- 그래서 프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 한다. 종료 메서드에 대한 호출도 클라이언트가 직접 해야한다.

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

프로토타입의 빈을 싱글톤 빈과 함께 사용할때는 의도한 대로 잘 동작하지 않을 수 있다.

clientBean 이라는 싱글톤 빈이 의존관계 주입(DI)를 이용하여 프로토타입 빈을 주입받아 사용하는 예를 살펴봅시다.

위의 그림을 보면 녹색의 clientBean은 싱글톤 빈 이다. 스프링 컨테이너가 생성될때 함께 생성되고, 의존관계 주입도 된다.

clientBean이 생성될 시점의 상황을 정리해 보면

1. clientBean은 의존관계 주입을 사용하기 때문에 스프링 컨테이너에 프로토타입 빈을 요청하게 됩니다.

2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환합니다. 프로토타입의 빈의 count 필드값이 0인 상태입니다.

이제 싱글톤 빈인 clientBean의 내부에 프로토타입 빈을 보관하고 있는 상황인것 이죠! (정확하게는 주소, 참조값 이겠군요)

이제 외부의 사용자A가 clientBean에 요청을 보낸다고 해봅시다. 싱글톤 이므로 항상 같은 clientBean을 반환하게 됩니다.

1. 사용자A가 clientBean.logic()을 호출하게 됩니다.

2. clientBean은 자신이 갖고있는 prototypeBean의 addCount() 메서드를 호출하여 프로토타입 빈의 count 필드값을 1 증가시킵니다.

이때 사용자B가 등장하여 사용자A와 같이 clientBean을 요청한다면, 싱글톤 이므로 같은 clientBean이 반환되게 됩니다.

여기서 중요한 점이 있는데, clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈 이라는 점 입니다.

주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것이지, 사용 할 때마다 새로 생성되는 것이 아닙니다!

따라서 사용자B 가 clientBean.logic()을 호출하면, addCount()를 통하여 count값 1을 2로 증가시키게 됩니다.

이를 테스트 코드로 작성하면 다음과 같습니다.

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 singletonClientUserPrototype() {
        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;

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

하지만 이는 원하던 기능이 아닐것 이다. 이럴거면 그냥 싱글톤 쓰면되지 왜 복잡하게 사용하겠는가?

실제 원하는 기능은 호출할때마다 새로운 프로토타입의 빈을 받길 원할 것 이다. 어떻게 해야할까? 다음 단락에서 알아보자.

(인텔리제이 단축키 command + option + N : 인라인 만들기)

4. 싱글톤 빈과 함께 사용시 Provider로 문제 해결

싱글톤 빈과 프로토타입의 빈을 함께 사용하려 할때 어떻게 해야 항상 새로운 프로토타입의 빈을 받을 수 있을까?

1. 그냥 직접 getBean으로 가져오는 방식

싱글톤이 빈이 프로토타입을 사용할때마다 스프링 컨테이너에 새로 요청하는 것 이다. 다음 코드를 살펴보자.

static class ClientBean {

    @Autowired
    private ApplicationContext ac;

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

위에서 봤었던 코드에서 ClientBean 부분만 바꾼 코드이다.

실행할때마다 ac.getBean()을 통해 항상 새로운 빈을 직접 끌어온다.

이렇게 의존관계를 주입받는 것이 아니라, 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL) 이라고 부른다.

이렇게 스프링의 ApplicationContext 자체를 주입받은후 사용하면, 스프링 컨테이너에 종속적인 코드가 되어버린다.

우리에게 지금 필요한것은 딱 DL 정도의 기능만을 제공하는 무엇인가 이다.

2. 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() 을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.

getObject()를 호출하면 내부에서는 스프링컨테이너를 통해 해당 빈을 찾아서 반환한다. (DL)

● 특징

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

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

3. JSR-330 Provider

이 방식은 javax.inject.Provider라는 JSR-330 자바 표준을 따르는 방식이다. 사용하려면 gradle에 의존성 추가를 해주어야 한다.

다음 코드를 살펴보자.

@Autowired
private Provider<PrototypeBean> provider;

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

provider.get() 을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.

get()을 호출하면 내부에서는 스프링컨테이너를 통해 해당 빈을 찾아서 반환한다. (DL)

● 특징

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

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

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

5. 웹 스코프

웹 스코프는 웹 환경에서만 동작한다. 위에서 배운 프로토타입과는 다르게 해당 스코프의 종료시점까지 관리한다.

대표적으로 request 스코프가 있다.

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

이외에도 session, application(ServletContext와 동일한 생명주기), websocket 스코프가 있다.

request 스코프 의 경우 처음 사용자A의 요청이 들어오면, A 전용의 빈을 생성하게 된다. 이후 A에게 response가 보내질때까지 계속 유지된다.

6. request 스코프 예제 만들기

이번시간에는 request 스코프의 빈을 생성해볼것 이다.

스프링 부트는 웹 라이브러리가 추가되면 추가 설정요인들이 필요함AnnotationConfigServletWebServerApplicationContext 를 기반으로 애플리케이션을 구동한다.

동시에 여러 Client로부터 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구별하기가 어렵다.

이를 request 스코프를 이용하여 해결해 보자.

먼저 Log정보 자체를 저장할 MyLoger 클래스를 만들어 보자.

스코프가 request 범위이기 때문에 HTTP 요청이 없다면 생성되지 않게됩니다.

@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() {
        String uuid = UUID.randomUUID().toString();
        System.out.println("[" + uuid + "] MyLogger.init : " + this);
    }

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

요청받은 URL 과 uuid 라는 유저의 고유값을 저장하게 된다.

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

(정확하게 스프링컨테이너에 요청하는 시점에 생성되는 빈이다)

이 빈이 생성되된 이후 초기화 과정에서 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다.

이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP request와 구분할 수 있다.

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

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 값으로 http://localhost:8080/log-demo 를 지정할 예정이다.

이렇게 받은 requestURL 값을 myLogger에 저장해둔다.

myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.

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

서비스는 다음과 같다.

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final MyLogger myLogger;

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

서비스는 단순하게 출력해주는 역할을 한다.

여기서 중요한점이 있다. request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면, 파라미터가 많아서 지저분해진다.

더 문제는 requestURL 같은 웹과 관련된 정보가 웹과 관련없는 서비스 계층까지 넘어가게 된다.

웹과 관련된 부분은 컨트롤러까지만 사용해야 한다. 서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관점에서 좋다.

하지만 아직 실행하면 오류가 발생한다.

다음과 가은 오류가 발생한다.

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;

스프링 어플리케이션을 실행할때 싱글톤 빈은 생성하여 의존성 주입이 가능하지만, request 빈은 사용자의 요청이 없었기 때문에 생성되지 않는다. 따라서 아직 실행될 수 없다.

문제가 되는 상황을 순서대로 설명해보았다.

1) 맨 처음 스프링 컨테이너가 만들어진다. 컨테이너가 생성되고 빈이 등록될때 LogDemoController 에서는 myLogger의 의존관계 주입을 받고 있다.

2) LogDemoController에서 스프링컨테이너 한태 myLogger 빈을 달라고 요청한다.

3) 문제는 MyLogger가 request 범위이다.

4) MyLogger 빈을 스프링 컨테이너가 반환하려고 하는데, 아직 request가 없어서 MyLogger 빈이 만들어지지 않았다.

5) 현재 스프링컨테이너가 처음 생성되는 시점이기 때문에 당연하게 request를 받은적이 없다.

6) 의존관계 주입단계가 아니라, 실제 고객의 요청이 왔을때까지 생성을 지연시켜야 한다!

7) 이전에 배운 provider를 사용하면 해결 가능하다!

7. 스코프와 Provider

이전에 발생한 문제를 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";
    }
}

이번에는 MyLogger를 의존성 주입받는 것 이 아니라, ObjectProvider<MyLogger> 를 의존성 주입받는다.

이는 컨테이너가 생성될때 받을 수 있는 주입이다.

이후 코드에서 myLoggerProvider.getObject()를 호출할때 비로서 myLogger 빈이 생성된다. Provider 덕분에 빈의 생성을 지연할 수 있었다. 이때 init()이 호출되면서 uuid값을 지정한다.

다음은 서비스 코드 부분이다.

@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 덕분에 ObjectProvider.getObject() 를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있게되었다!

ObjectProvider.getObject() 를 호출하시는 시점에는 HTTP 요청이 진행중이므로 request scope 빈의 생성이 정상 처리된다.

ObjectProvider.getObject() 를 LogDemoController , LogDemoService 에서 각각 한번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다!

하지만 개발자의 욕심은 끝이 없으니... 그냥 기존의 MyLogger를 등록해서 사용하는 방식이 없을까?

8. 스코프와 프록시

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

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

기존의 코드에서 proxyMode = ScopedProxyMode.TARGET_CLASS 를 추가해준다.

적용 대상이 클래스면 TARGET_CLASS, 인터페이스면 INTERFACES 를 선택하면 된다.

이렇게 하면 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 requestURL = request.getRequestURL().toString();
        System.out.println("myLogger.getClass() = " + myLogger.getClass());
        myLogger.setRequestURL(requestURL);

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

이번에는 System.out.println("myLogger.getClass() = " + myLogger.getClass()); 를 통해서 클래스 정보를 출력해 보았다.

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

@Scope 의 proxyMode = ScopedProxyMode.TARGET_CLASS) 를 설정하면 스프링 컨테이너는 CGLIB 이라는 바이트코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받은 가짜 프록시 객체를 생성한다.

결과를 확인해보면 우리가 등록한 순수한 MyLogger 클래스가 아니라 MyLogger$$EnhancerBySpringCGLIB 이라는 클래스로 만들어진 객체가 대신 등록된 것을 확인할 수 있다. 그리고 스프링 컨테이너에 "myLogger"라는 이름으로 진짜 대신에 이 가짜 프록시 객체를 등록한다.

ac.getBean("myLogger", MyLogger.class) 로 조회해도 프록시 객체가 조회되는 것을 확인할 수 있다.

그래서 의존관계 주입도 이 가짜 프록시 객체가 주입된다.

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

가짜 프록시 객체는 실제 request scope와는 관계가 없다. 그냥 가짜이고, 내부에 단순한 위임 로직만 있고, 싱글톤 처럼 동작한다.

가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있다. 따라서 클라이언트가 myLogger.logic() 을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.

가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic() 를 대신 호출한다.

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

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

(주의: 마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 결국 주의해서 사용해야 한다.

프록시 MyLoger에 대한 각 요청(request)마다 새로운 MyLoger가 생성되기 때문이다.

단지 대표역할을 하는 프록시가 싱글톤처럼 될 뿐이다. 이 프록시(싱글톤) 에게 요청을 하면 이때마다 MyLoger가 각각 생성되게 된다.)

저작자표시

'BackEnd > Spring' 카테고리의 다른 글

[Spring] Transaction 동작 원리 (@Transactional 원리) (0)	2022.03.09
[Spring] @SpringBootTest (0)	2022.03.07
[Spring] 빈 생명주기 콜백 (0)	2022.02.07
[Spring] 의존관계 자동 주입 (0)	2022.02.05
[Spring] 컴포넌트 스캔 (0)	2022.02.04