Spring

[스프링] 스프링 핵심 원리 기본편 정리: 9. 빈 스코프

아윤_ 2023. 9. 13. 01:33

빈 스코프

 

 

빈 스코프란?

 

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

 

스프링은 싱글톤 스코프 이외에도 다양한 스코프를 지원하는데, 이는 다음과 같다.

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

 

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

 

 

컴포넌트 스캔 자동 등록

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

 

 

수동 등록

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

 

 

 

프로토타입 스코프

 

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

 

 

싱글톤 빈 요청

 

싱글톤 빈을 요청할 때의 동작 과정은 다음과 같다.

 

싱글톤 빈 요청

 

 

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

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

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

 

 

프로토타입 빈 요청 1

 

프로토타입 빈을 요청할 때의 동작 과정은 다음과 같다.

 

프로토타입 빈 요청 1

 

 

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

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

 

프르토타입 빈 요청 2

 

 

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

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

 

 

정리

 

핵심은, 프로토타입 빈일 경우 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계, 초기화까지만 처리한다는 것이다. 클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다. 프로토타입 빈을 관리할 책임은 클라이언트에게 있다. 그래서 @PreDestroy 종료 메서드가 호출되지 않는다.

 

 

싱글톤 스코프 빈 테스트

package hello.core.scope;

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 javax.annotation.PostConstruct;
import javax.annotation.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();
    }

    @Scope("singleton")
    static class SingletonBean {

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

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

 

실행 결과는 다음과 같다.

SingletonBean.init
singletonBean1 = hello.core.scope.PrototypeTest$SingletonBean@54504ecd
singletonBean2 = hello.core.scope.PrototypeTest$SingletonBean@54504ecd org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing SingletonBean.destroy

 

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

 

 

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

package hello.core.scope;

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 javax.annotation.PostConstruct;
import javax.annotation.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
        void init() {   //빈 생성, 의존관계 주입 이후 초기화
            System.out.println("PrototypeBean.init");
        }

        @PreDestroy
            // 빈 소멸 전 호출
        void destroy() {
            System.out.println("PrototypeBean.destroy");
        }

    }
}

 

실행 결과는 다음과 같다.

find prototypeBean1
PrototypeBean.init
find prototypeBean2
PrototypeBean.init
prototypeBean1 = hello.core.scope.PrototypeTest$PrototypeBean@13d4992d
prototypeBean2 = hello.core.scope.PrototypeTest$PrototypeBean@302f7971 org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing

 

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

 

프로토타입 빈을 2번 조회했기 때문에 각각 다른 빈이 생성되고, 초기화도 2번 실행된 것을 확인할 수 있다.

 

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

 

 

프로토타입 빈의 특징 정리

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

 

 

 

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

 

싱글톤 빈과 프로토타입 빈을 함께 사용할 때 문제가 발생하게 된다. 먼저, 스프링 컨테이너에 프로토타입 빈을 직접 요청하는 예제를 보자.

 

스프링 컨테이너에 프로토타입 빈 직접 요청 1

 

 

 

  1. 클라이언트 A는 스프링 컨테이너에 프로토타입 빈을 요청한다.
  2. 스프링 컨테이너는 프로로타입 빈을 생성해서 반환(x01)한다. 이때, 해당 빈의 count 필드 값은 0이다.
  3. 클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하여 count를 1 증가시킨다.

 

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

 

 

스프링 컨테이너에 프로토타입 빈 직접 요청 2

 

 

 

  1. 클라이언트 B는 스프링 컨테이너에 프로토타입 빈을 요청한다.
  2. 스프링 컨테이너는 새로운 프로토타입 빈을 생성(x02)해서 반환한다. 해당 빈의 count 값은 0이다.
  3. 클라이언트 B는 조회한 프로토타입 빈에 addCount()를 호출해서 count를 1 증가시킨다.

 

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

 

 

코드로 확인

package hello.core.scope;

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 javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

public class SingletonWithPrototypeTest1 {

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

        PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);
        prototypeBean2.addCount();
        Assertions.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");
        }
    }
}

 

그림에서 살펴봤던 대로 결과가 나오는 것을 확인할 수 있다.

 

 

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

 

 

 

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

 

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

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

 

clientBean은 프로토타입 빈을 내부 필드에 보관한다. (참조값을 보관한다.) 

 

 

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

 

 

 

클라이언트 A는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean이 반환된다.

 

3. 클라이언트 A는 clientBean.logic()을 호출한다.

4. clientBean은 prototypeBean의 addCount()를 호출해서 count를 1 증가시킨다. count는 1이 된다.

 

 

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

 

 

 

클라이언트 B는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 빈이 반환된다. 

 

여기서 중요한 점은 clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다. 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 생성된 것이지, 사용할 때마다 새로 생성되는 것이 아니다!

 

5. 클라이언트 B는 clientBean의 logic()을 호출한다.

6. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 1 증가한다. 원래 count 값이 1이었으므로, count 값은 2가 된다.

 

 

테스트 코드

package hello.core.scope;

import org.assertj.core.api.Assert;
import org.assertj.core.api.Assertions;
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 javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

public class SingletonWithPrototypeTest1 {

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

        PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);
        prototypeBean2.addCount();
        Assertions.assertThat(prototypeBean2.getCount()).isEqualTo(1);
    }

    @Test
    void singletonClientUsePrototype() {
        AnnotationConfigApplicationContext ac =
                new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);

        ClientBean clientBean1 = ac.getBean(ClientBean.class);
        int count1 = clientBean1.logic();
        Assertions.assertThat(count1).isEqualTo(1);

        ClientBean clientBean2 = ac.getBean(ClientBean.class);
        int count2 = clientBean2.logic();
        Assertions.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();
            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");
        }
    }
}

 

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

 

우리가 원하는 것은 이게 아니다. 프로토타입 빈을 주입 시점에만 새로 생성하는 게 아니라 사용할 때마다 새로 생성하는 것을 원한다.

 

 

 

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

 

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

 

의존관계를 외부에서 주입(DI) 받는 게 아니라 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL) 의존관계 조회(탐색)라 한다. 우리는 현재 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 DL 정도의 기능만 제공하는 무언가만 있으면 된다.

 

스프링에는 이미 모든 게 준비되어 있다.

 

 

ObjecctFactory, ObjectProvider

 

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

 

@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 코드를 만들기는 훨씬 쉬워진다. 또한, ObjcetProvider는 지금 필요한 DL 정도의 기능만 제공한다.

 

 

특징

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

 

 

JSR-330 Provider

 

마지막 방법은 javax.inject.Provider라는 JSR-330 자바 표준을 사용하는 방법이다. 스프링 부트 3.0 미만의 경우에 이를 사용하며, 버전에 따라 조금씩 차이가 있다.

 

해당 방법을 사용하기 위해서는 다음 라이브러리를 gradle에 추가해야 한다.

 

javax.inject.Provider 참고용 코드 - 스프링부트 3.0 미만

package javax.inject;
public interface Provider<T> {
	T.get()
}

 

 @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 코드를 만들기 훨씬 쉬워지며, 지금 딱 필요한 DL 정도의 기능만 제공한다.

 

 

특징

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

 

 

정리

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

 

 

 

웹 스코프

 

지금까지 싱글톤 스코프와 프로토타입 스코프에 대해 알아보았다. 이번에는 웹 스코프에 대해 알아보도록 하자.

 

 

특징

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

 

 

웹 스코프 종류

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

 

여기서는 request 스코프를 예제로 설명하도록 한다. 나머지도 범위만 다르지 동작 방식은 비슷하다.

 

 

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

 

 

 

클라이언트 A가 HTTP request를 요청하면 Controller에서 request 스코프와 관련된 객체를 조회한다. 이때 A 클라이언트 전용의 객체가 만들어진다. Service 객체에서 해당 객체를 조회할 경우 HTTP request가 같으면 같은 객체 인스턴스를 바라보게 된다.

 

클라이언트가 B가 동시에 HTTP request를 요청한다. 이때 HTTP request는 다른 request이기 때문에 B 클라이언트 전용 객체가 만들어진다.

 

 

 

request 스코프 예제 만들기

 

 

웹 환경 추가

 

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

 

build.grade에 추가

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

 

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

 

 

request 스코프 예제 개발

 

동시에 여러 HTTP request 요청이 올 경우, 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다. 이때 request 스코프를 사용하면 된다.

 

다음과 같이 로그가 남도록 request 스코프를 활용해서 추가 기능을 개발해 보자.

[d06b992f...] request scope bean create
[d06b992f...][http://localhost:8080/log-demo] controller test
[d06b992f...][http://localhost:8080/log-demo] service id = testId
[d06b992f...] request scope bean close

 

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

 

 

MyLogger

package hello.core.common;

import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
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 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를 사용해서 종료 메시지를 남긴다.

 

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

 

 

LogDemoController

package hello.core.web;

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

import javax.servlet.http.HttpServletRequest;

@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에 저장해 둔다. MyLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 섞이지 않는다. 또한, 컨트롤러에서 controller test라는 로그를 남긴다.

 

 

LogDemoService 추가

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를 사용하지 않고 파라미터로 모든 정보를 서비스 계층에 넘긴다면, 파라미터가 많아서 지저분해진다. 더 문제는 requestURL 같은 웹과 관련된 정보가 웹과 관련 없는 서비스 계층까지 넘어가게 된다는 점이다.

 

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

 

request scope의 MyLogger 덕분에 이런 부분을 파라미터로 넘기지 않고, MyLogger의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.

 

이제 실행을 해보자. 기대하는 출력은 다음과 같다.

[d06b992f...] request scope bean create
[d06b992f...][http://localhost:8080/log-demo] controller test
[d06b992f...][http://localhost:8080/log-demo] service id = testId
[d06b992f...] request scope bean close

 

 

기대와 다르게 애플리케이션 실행 시점에 오류 발생

 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 scope를 주입하려 했는데 아직 request 자체가 오지 않았기 때문이다. 이 빈은 실제 고객 요청이 와야 생성할 수 있다. 

 

 

 

스코프와 Provider

 

오류를 해결하는 방법으로 앞서 배운 Provider를 사용하는 방법이 있다. 간단히 ObjectProvider를 사용해 보자.

 

코드

package hello.core.web;

import hello.core.common.MyLogger;
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;

import javax.servlet.http.HttpServletRequest;

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

}

 

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를 입력하면, 다음과 같은 실행 결과가 나온다.

[d06b992f...] request scope bean create
[d06b992f...][http://localhost:8080/log-demo] controller test
[d06b992f...][http://localhost:8080/log-demo] service id = testId
[d06b992f...] request scope bean close

 

ObjectProvider 덕분에 ObjectProvider.getObject()를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.

 

ObjectProvider.getObject()를 호출하는 시점에는 HTTP 요청이 진행 중이므로 request scope 빈의 생성이 정상 처리된다. 또한, ObjectProvider.getObject()를 LogDemoController, LogDemoService에서 각각 한 번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다.

 

 

 

스코프와 프록시

 

프록시 방식을 사용해도 이전의 문제를 해결할 수 있다. 프록시 방식을 사용하는 방법은 다음과 같다.

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

 

proxyMode = ScopedProxyMode.TARGET_CLASS를 추가하면 된다.

  • 적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS를 선택한다.
  • 적용 대상이 인터페이스면 INTERFACES를 선택한다.

 

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

 

나머지 코드를 Provider 사용 이전으로 돌려두고 잘 작동하는지 확인하자.

 

package hello.core.web;

import hello.core.common.MyLogger;
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;

import javax.servlet.http.HttpServletRequest;

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

}

 

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

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

 

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

 

 

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

 

먼저 주입된 MyLogger를 확인해보자.

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

 

출력 결과는 다음과 같다.

myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$b68b726d

 

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

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

 

 

 

 

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

  • 클라이언트가 myLogger.logic()을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다.
  • 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic()을 호출한다.
  • 가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있다(다형성)

 

 

동작 정리

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

 

 

특징 정리

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

 

 

주의점

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

 

 

저작자표시 비영리 동일조건

'Spring' 카테고리의 다른 글

[스프링부트] 스프링부트 프로젝트의 구조  (1) 2023.10.19
[스프링부트] 스프링부트란 무엇인가  (0) 2023.09.28
[스프링] 스프링 핵심 원리 기본편 정리: 8. 빈 생명주기 콜백  (0) 2023.09.08
[스프링] 스프링 핵심 원리 기본편 정리: 7. 의존관계 자동 주입  (0) 2023.09.04
[스프링] 스프링 핵심 원리 기본편 정리: 6. 컴포넌트 스캔  (0) 2023.09.01

'Spring'의 다른글

  • 현재글[스프링] 스프링 핵심 원리 기본편 정리: 9. 빈 스코프

관련글

댓글

티스토리툴바