[Spring] 빈 스코프

kdkdhoho·2022년 3월 2일
Spring
0

Spring

목록 보기
13/26

이 글은 인프런 - 스프링 핵심 원리 기본편을 보고 공부한 것을 정리한 글입니다.

1. 빈 스코프란?

일단 스코프란, 번역 그대로 범위라는 뜻을 가진다.

그렇다면 빈 스코프란, 스프링 빈이 존재할 수 있는 범위를 뜻한다.

스프링은 아래와 같은 여러 스코프를 지원한다.

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

빈 스코프 등록은 자동과 수동 모두 @Scope("prototype") 을 붙여 사용한다.

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

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

2. 프로토타입 스코프

기존 싱글톤 스코프는 클라이언트가 요청한 스프링 빈을 하나의 인스턴스로 클라이언트에게 제공한다.

반면에 프로토타입 스코프는, 요청이 들어오면 스프링 컨테이너는 새로운 프로토타입 스프링 빈을 하나 만들어 DI까지 해주고, 클라이언트에게 제공 후 더이상 관여하지 않는다.
그래서 @PreDestroy 같은 종료메서드가 호출되지 않는다.

public class SingletonTest {

    @Test
    public 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");
        }
    }
}
SingletonBean.init
singletonBean1 = hello.core.scope.SingletonTest$SingletonBean@3899782c
singletonBean2 = hello.core.scope.SingletonTest$SingletonBean@3899782c
public class PrototypeTest {
    @Test
    public 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");
        }
    }
}
find prototypeBean1
PrototypeBean.init
find prototypeBean2
PrototypeBean.init
prototypeBean1 = hello.core.scope.PrototypeTest$PrototypeBean@3899782c
prototypeBean2 = hello.core.scope.PrototypeTest$PrototypeBean@1603cd68

싱글톤과 프로토타입의 테스트코드의 코드와 출력을 잘 비교해보자

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

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

	@Test
    void singletoneClientUseProtoType() {
        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);
    }

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

위 코드와 같이 싱글톤 빈 내부에 프로토타입이 주입되어 사용되는 경우, 프로토타입이 싱글톤 빈 내부에서 계속해서 유지한다.

프로토타입 빈은 이런 식으로 사용되기 보다, 사용할 때마다 새로 생성하기 위해 사용하는 경우가 맞는 경우일 것이다.

참고
clientA, clientB가 각각 프로토타입 빈을 의존관계 주입 받으면 각각 다른 인스턴스의 프로토타입 빈을 주입받는다.

4. Provider로 문제 해결

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

가장 간단한 방법은 싱글톤 빈이 프로토타입 빈을 사용할 때마다 요청하는 것이다.

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

의존관계를 외부에서 주입받는 것이 아닌 직접 찾는 것을 Dependency Lookup(DL). 의존관계 조회(탐색)이라고 한다.
하지만 이렇게 스프링의 어플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다.
지금 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 찾아주는 기능만 필요하다.

ObjectProvider

이 기능으로 ObjectFactory, ObjectProvider 가 있다.
ObjectFactory는 과거형이고, 현재는 편의 기능을 추가한 ObjectProvider를 사용한다.

@Scope("singleton")
static class ClientBean {
    @Autowired
    private ObjectProvider<PrototypeBean> prototypeBeanObjectProvider;

    public int logic() {
        PrototypeBean prototypeBean = prototypeBeanObjectProvider.getObject(); // 필요한 빈을 컨테이너에서 찾아 가져온다.
        prototypeBean.addCount();
        return prototypeBean.getCount();
    }
}
PrototypeBean.init hello.core.scope.SingletonWithPrototypeTest1$PrototypeBean@554e218
PrototypeBean.init hello.core.scope.SingletonWithPrototypeTest1$PrototypeBean@7cf6a5f9

특징

  1. ObjectFactory: 기능이 단순하며, 별도 라이브러리 필요가 없다. 스프링에 의존한다.
  2. ObjectProvider: ObjectFactory 상속받아 여러 편의기능을 추가. 별도 라이브러리 필요 없으며 스프링에 의존한다.

JSR-330 Provider

마지막 방법으로, javax.inject.Provider라는 JSR-330 자바 표준을 사용하는 방법이다.
이 방법을 사용하려면 javax.inject:javax.inject:1 라이브러리를 gradle에 추가해야한다.

5. 웹 스코프

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

종류로는

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

가 있다.

request 스코프의 경우 동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어려운 경우에 사용하기 좋다.
이제 HTTP에서 요청이 올 경우 로그를 남기는 예제를 보자.

@Component
@Scope(value = "request")
public class MyLogger {

    private String uuid;
    private String requestURL;

    @PostConstruct
    public void init() {
        String uuid = UUID.randomUUID().toString();
        System.out.println("[" + uuid + "]" + "request scope bean create:" + this);
    }

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

    public void setRequestURL(String requestURL) {
        this.requestURL = requestURL;
    }

    public void log(String message) {
        System.out.println("[" + uuid + "]" + "[" + requestURL + "] " + message);
    }
}
@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";
    }
}
@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final MyLogger myLogger;

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

기존에 배웠던 @RequiredArgsConstructor, @PostConstruct, @PreDestroy, @RequestMapping, @ResponseBody를 잘 상기시켜보자.

Mylogger 클래스와, Service, Controller를 이용해 HTTP 요청이 오면 Mylogger 빈이 request 스코프로 생성되고, 생성되는 시점에 uuid와 빈이 생성되었음을 출력한다.

Controller를 통해 request URL을 myLogger에 저장한다.
그리고 Service를 통해 log를 uuid와 저장된 request URL을 출력한다.

requestURL을 MyLogger에 저장하는 부분은 컨트롤러보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다.

여기서 중요한 점은, request scope(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 빈은 HTTP 요청이 들어오지 않아 생성되지 않아 발생하는 오류이다.
따라서 이 문제를 해결해주기 위해 바로 위에 있는 Provider를 이용하자.

스코프와 프록시

Provider를 사용해도 꽤나 훌륭하게 동작한다. 하지만 프록시 방식을 이용하면 Provider를 사용하지 않아도 오류없이 동작할 수 있다.

바로 request scope에 @scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS) 를 추가해주자.
(만약 적용 대상이 class가 아닌 interface면 TARGET_INTERFACE를 넣어주자)

동작원리는 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관없이 가짜 프록시 클래스를 미리 주입해두는 것이다.
그리고 진짜 request가 들어오면 그제서야 실제 myLogger를 꺼내오는 것과 같다.

출력을 통해 확인해보면
myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$a7983285 가 뜨는데,
CGLIB라는 스프링이 조작하는 라이브러리를 통해 클래스 내 상속받은 가짜 프록시 객체를 만들어 주입되는 것을 확인할 수 있다.

특징 정리

Provider, 프록시 둘의 핵심 아이디어는, 진짜 객체 조회를 필요한 시점까지 delay시켜준다는 것이다.

request scope가 마치 싱글톤처럼 동작되는거 같지만, 결국 HTTP 요청마다 다른 객체들이 생성되는 것이기에 이 점을 유념해야 한다.
이런 특별한 scope는 무분별하게 사용하면 유지보수가 굉장히 힘들어지기에, 꼭 필요한 곳에서 최소한으로 사용하자.

profile
kdkdhoho
newBlog == https://kdkdhoho.github.io
이전 포스트

[Spring] 스프링 빈 생명주기와 콜백

다음 포스트

Maven vs Gradle

0개의 댓글