Chapter 09. 빈 스코프(Bean Scope)

Spring Framework/[인프런] Spring 핵심 원리

Chapter 09. 빈 스코프(Bean Scope)

계란💕 2022. 8. 16. 15:05

9.1 빈 스코프(Bean Scope)

Def) 빈 스코프(Bean Scope)란?

지금까지 스프링 빈은 스프링 컨테이너의 시작과 함께 생성되었다가 스프링 컨테이너가 종료될 때까지 유지된다고 살펴봤다.
이것은 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다.
스코프는 빈이 존재할 수 있는 범위를 뜻한다.
싱글톤: 기본 스코프, 스프링 컨테이너의 시작과 종료 시점까지 유지되는 가장 넓은 범위의 스코프이다.
프로토타입: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프이다.
웹 관련 스코프
- request: 웹 요청이 들어오고 나갈 때까지 유지되는 스코프
- session: 웹 세션이 생성되고 종료될 때까지 유지되는 스코프
- application: 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프

9.2 프로토타입 스코프(Protorype Scope)

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

싱글톤 스코프의 빈을 스프링 컨테이너에 요청한다.
스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환한다.
이후에 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈을 반환한다.

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

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

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

정리

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

Ex) 싱글톤 스코프 빈 테스트

<hide/>
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(Singleton.class);

        Singleton singleton1 = ac.getBean(Singleton.class);
        Singleton singleton2 = ac.getBean(Singleton.class);
        System.out.println("singletonBean1 = " + singleton1);
        System.out.println("singletonBean2 = " + singleton2);
        Assertions.assertThat(singleton1).isSameAs(singleton2);
        ac.close();
    }

    @Scope("singleton")
    static  class Singleton{

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

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

Note) 실행결과

- 초기화 => 같은 인스턴스 빈을 조회(싱글톤 빈의 주소 같음) => 종료 메서드 destroy() 호출

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

- AnnotationConfigApplicationContext() 안에 PrototypeBean.class를 넣어주면 이 클래스가 컴포넌트 스캔 대상처럼 동작한다. 그래서 PrototypeBean클래스 앞에 @Component가 필요없다.

<hide/>
package hello.core.scope;
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;

import static org.assertj.core.api.Assertions.assertThat;
public class PrototypeTest {

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

Note) 실행결과 - bean1, bean2가 다르니까 테스트 성공

- 그런데 close는 호출이 안된다. 프로토타입이라서 만들고 버린 것이다.

싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드가 실행되지만 프로토타입 스코프의 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고 초기화 메서드도 실행된다.
프로토타입 빈을 2번 조회했으므로 완전히 다른 스프링 빈이 생성되고 초기화도 2번 된 것을 알 수 있다.
싱글톤 빈은 컨테이너가 관리하므로 컨테이너가 종료될 때, 빈의 종료 메서드가 실행되지만, 프로토타입 빈은 스프링 컨테이너가 관리하지 않는다.
따라서, 프로토타입 빈은 스프링 컨테이너가 생성과 의존관계 주입, 그리고 초기화까지만 관여하고 더이상 관리하지 않는다.
결국, 프로토 타입 빈은 종료될 때 @PreDestroy가 전혀 실행되지 않는다.

프로토타입 빈 특징

스프링 컨테이너에 요청될 때마다 새로 생성
스프링 컨테이너: 빈 생성 => 의존관계 주입 => 초기화 까지만 관여한다.
종료 메서드 호출되지 않는다
그래서 프로토타입 빈을 조회한 클라이언트가 관리해야한다. 종료 메서드호출도 클라이언트가 직접 해야한다.
- 아래와 같이 직접 호출 가능

prototypeBean1.destroy();

Ex) 클라이언트가 직접 종료 메서드 호출

<hide/>
package hello.core.scope;
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;

import static org.assertj.core.api.Assertions.assertThat;
public class PrototypeTest {

    @Test
    void findPrototypeBean(){
        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);
        prototypeBean1.destroy();
        prototypeBean2.destroy();
        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");
        }
    }
}

Note) 실행 결과

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

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

Ex) 스프링 컨테이너에 프로토타입 빈을 직접 요청하는 경우

<hide/>
package hello.core.scope;
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;
import static org.assertj.core.api.Assertions.assertThat;
public class SingletonWithPrototypeTest1 {

    @Test
    void findPrototype(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);
        PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
        prototypeBean1.addCnt();
        assertThat(prototypeBean1.getCnt()).isEqualTo(1);

        PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);
        prototypeBean2.addCnt();
        assertThat(prototypeBean2.getCnt()).isEqualTo(1);
    }

    @Scope("prototype")
    static class PrototypeBean{
        private int cnt = 0;

        public void addCnt(){
            ++cnt;
        }

        public int getCnt(){
            return cnt;
        }
        
        @PostConstruct
        public void init(){
            System.out.println("PrototypeBean.init " + this);
        }

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

Note) 실행 결과

- 두 프로토타입 빈의 cnt가 1이다.

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

'clientBean'은 싱글톤이므로 보통 스프링 컨테이너 생성 시점에 함께 생성되고 의존관계 주입도 발생한다.
'clientBean'은 의존관계 자동 주입을 사용한다. 주입 시점에 컨테이너에 프로토타입 빈을 요청한다.
스프링 컨테이너는 프로토타입 빈을 생성해서 'clientBean'에 반환한다. 프로토타입 빈의 cnt필드 값은 0이다.
'clientBean'은 프로토타입 빈(참조값)을 내부 필드에 보관한다.

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

클라이언트 A는 'clientBean'을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 'clientBean'이 반환된다.
클라이언트A는 'clientBean.logic()'을 호출한다.
clientBean는 PrototypeBean의 addCnt()를 호출해서 프로토타입 빈의 cnt를 증가시킨다.

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

'clientBean'은 싱글톤이므로 보통 스프링 컨테이너 생성 시점에 함께 생성되고 의존 관계 주입도 발생한다.
'clientBean'은 의존 관계 자동 주입을 사용한다. 주입 시점에 컨테이너에 프로토타입 빈을 요청한다.
스프링 컨테이너는 프로토타입 빈을 생성해서 'clientBean'에 반환한다. 프로토타입 빈의 cnt필드 값은 0이다.
'clientBean'은 프로토타입 빈(참조값)을 내부 필드에 보관한다.

Ex) 싱글톤에서 프로토타입 빈 사용하기

<hide/>
@Test
    void singletonClientUsePrototype(){

        AnnotationConfigApplicationContext ac =
                new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);

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

        ClientBean clientBean2 = ac.getBean(ClientBean.class);
        int cnt2 = clientBean1.logic();
        assertThat(cnt2).isEqualTo(2);
    }


    @Scope("singleton")
    static class ClientBean{
        private final PrototypeBean prototypeBean;

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

        public int logic(){
            prototypeBean.addCnt();
            return prototypeBean.getCnt();
        }
    }

- 클라이언트빈은 싱글톤이다, 따라서 자동으로 스프링 빈에 등록된다.

- @Autowired가 있으니까 PrototypeBean을 달라고 내부적으로 요청한다.

- 그러면 컨테이너가 PrototypeBean을 만들어서 준다. 그 때 만들어진 값이 할당된다.

- 이미 주입된 PrototypeBean을 clientBean1, clientBean2가 같이 쓴다.

Note) 실행결과 - 성공

스프링은 일반적으로 싱글톤 빈을 사용하므로 싱글톤 빈이 프로토타입 빈을 사용하게 된다. 그런데, 싱글톤 빈은 생성 시점에만 의존 관계를 주입 받기 때문에 프로토타입 빈이 새로 생성된다. 하지만, 싱글톤 빈과 프로토타입 빈이 계속 유지되는 것이 문제다.
프로토타입 빈을 주입 시점에만 새로 생성하는 게 아니라 사용할 때마다 새로 생성해서 사용하는하고 싶은데 어떻게 해야할까?

Ex) 싱글톤 빈이 프로토타입 빈 사용

- login()을 호출할 때마다 프로토타입 빈을 만들어서 반환한다.

<hide/>
    @Test
    void singletonClientUsePrototype(){
        AnnotationConfigApplicationContext ac =
                new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);
        ClientBean clientBean1 = ac.getBean(ClientBean.class);
        int cnt1 = clientBean1.logic();
        assertThat(cnt1).isEqualTo(1);

        ClientBean clientBean2 = ac.getBean(ClientBean.class);
        int cnt2 = clientBean1.logic();
        assertThat(cnt2).isEqualTo(2);
    }

    @Scope("singleton")
    static class ClientBean{
        // 제거
//        private final PrototypeBean prototypeBean;  // 생성 시점에 주입이 되버린다.

        @Autowired
        ApplicationContext applicationContext;

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

        public int logic(){

            PrototypeBean prototypeBean = applicationContext.getBean(PrototypeBean.class);    //직접 받는다.
            prototypeBean.addCnt();
            return prototypeBean.getCnt();
        }
    }

Note) 실행결과 - 실패

- 두 번째 값도 1이 되어야하기 때문에 실패

- 다시 수정해서 돌리면 성공

-> 하지만 클라이언트 빈이 ac를 매번 가져오는 것은 코드가 지저분하다.

<hide/>
    @Test
    void singletonClientUsePrototype(){
        AnnotationConfigApplicationContext ac =
                new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);
        ClientBean clientBean1 = ac.getBean(ClientBean.class);
        int cnt1 = clientBean1.logic();
        assertThat(cnt1).isEqualTo(1);

        ClientBean clientBean2 = ac.getBean(ClientBean.class);
        int cnt2 = clientBean1.logic();
        assertThat(cnt2).isEqualTo(1);
    }

    @Scope("singleton")
    static class ClientBean{
        // 제거
//        private final PrototypeBean prototypeBean;  // 생성 시점에 주입이 되버린다.

        @Autowired
        ApplicationContext applicationContext;

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

        public int logic(){

            PrototypeBean prototypeBean = applicationContext.getBean(PrototypeBean.class);    //직접 받는다.
            prototypeBean.addCnt();
            return prototypeBean.getCnt();
        }
    }

여러 빈에서 같은 프로토타입 빈을 주입 받으면, 주입 받는 시점에 각각 새로운 프로토타입 빈이 생성된다. 예를 들어, ClientA, ClientB가 각각 의존 관계 주입 받으면 각각 다른 인스턴스의 프로토타입 빈을 주입 받는다.
물론 사용할 때마다 새로 생성되는 것이 아니다.

Ex) 클라이언트 빈을 두 개 만드는 경우

<hide/>
    @Scope("singleton")
    static class ClientBean{
        private final PrototypeBean prototypeBean;  // 생성 시점에 주입  x01

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

        public int logic(){
            prototypeBean.addCnt();
            return prototypeBean.getCnt();
        }
    }

    @Scope("singleton")
    static class ClientBean2{
        private final PrototypeBean prototypeBean;  // 생성 시점에 주입 x02

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

        public int logic(){
            prototypeBean.addCnt();
            return prototypeBean.getCnt();
        }
    }

- 클라이언트빈을 2개 만든다. ClientBean1, ClientBean2 둘다 PrototypeBean에 대한 의존관계 주입을 요청한다.

- 그러면 PrototypeBean이 각각 두 개 생긴다.

- 주입 받을 때마다 새로 생성된다.

Note) 실행결과 - 성공

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

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

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

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

Ex) ObjectProvider

- 테스트니까 간단하게 필드 주입한다.

- prototypeBeanProvider : 찾아주는 역할만 한다.

- getObject() 를 호출하면 스프링 컨테이너에서 프로토타입 빈을 찾아서 우리한테 반환해준다.

- ObjectProvider는 지금 딱 필요한 DL정도의 기능만 제공한다.

<hide/>
@Test
    void singletonClientUsePrototype(){
        AnnotationConfigApplicationContext ac =
                new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);
        ClientBean clientBean1 = ac.getBean(ClientBean.class);
        int cnt1 = clientBean1.logic();
        assertThat(cnt1).isEqualTo(1);

        ClientBean clientBean2 = ac.getBean(ClientBean.class);
        int cnt2 = clientBean1.logic();
        assertThat(cnt2).isEqualTo(1);
    }

    @Scope("singleton")
    static class ClientBean{

        @Autowired
        public ObjectProvider<PrototypeBean> prototypeBeanProvider;

        public int logic(){
            PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
            prototypeBean.addCnt();
            return prototypeBean.getCnt();
        }
    }

Note) 실행결과

- 프로토타입 빈이 두 개 생성된 걸 알 수 있다.

ObjectProvider, ObjectFactory

지정한 빈을 컨테이너에 대신 찾아주는 DL서비스를 제공하는 것이 바로 'ObjectProvider'
'ObjectFactory'는 과거에 썼지만 최근에는 편의 기능을 추가해서 'ObjectProvider'를 더 많이 쓴다.
'ObjectProvider'에서 getObject()를 호출하면 내부에서 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다.
스프링이 제공하는 기능을 사용하지만 기능이 단순하므로 단위 테스트를 만들거나 mock 코드를 만들기 훨씬 쉬워진다.
'ObjectProvider'는 딱 DL 정도의 기능만 제공한다.
ObjectFactory: 기능이 단순하다. 별도의 라이브러리가 필요 없고 스프링에 의존한다.
ObjectProvider: ObjectFactory를 상속한다. 옵션, 스트림 처리 등 편의 기능이 많고 별도의 라이브러리가 필요 없다. 스프링에 의존한다.(스프링 코드를 그대로 갖다 쓴다.)

JSR-330 Provider

javax.inject.Provider라는 JSR-330 자바 표준을 사용하는 방법이다.
gradle에 'javax.inject:javax.inject:1' 라이브러리를 추가하면 사용 가능하다

Ex) JSR-330 Provider

- 이전의 ClientBean클래스에서 Provider와 get()을 추가해준다.

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

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

<hide/>
 @Scope("singleton")
    static class ClientBean{

        @Autowired
        public Provider<PrototypeBean> prototypeBeanProvider;

        public int logic(){
            PrototypeBean prototypeBean = prototypeBeanProvider.get();
            prototypeBean.addCnt();
            return prototypeBean.getCnt();
        }
    }

Note) 실행결과 - 성공

- 프로토타입 두 개 생성

프로토타입 빈을 언제 사용할까?

매번 사용할 때마다 의존 관계 주입이 완료된 새로운 객체가 필요하면 사용한다.
그런데, 실무에서는 싱글톤 빈으로 대부분의 문제를 해결 가능하다. 그래서 프로토타입 빈을 직접적으로 사용하는 일은 드물다.

JSR-330 Provider vs ObjectProvider

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

9.5 웹 스코프(Web Scope)

웹 스코프(web scope) 특징

웹 스코프는 웹 환경에서만 동작한다.
웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료 시점까지 관리한다. 따라서, 종료 메서드가 호출된다.
- request: HTTP 요청 하나가 들어오고 나올 때까지 유지되는 스코프, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리된다.
- session: HTTP Session과 동일한 생명 주기를 가지는 스코프
- application: 서블릿 컨텍스트(ServletContext - 서블릿 컨테이너와 통신하기 위해 사용되는 메서드를 지원하는 인터페이스)와 동일한 생명 주기를 가지는 스코프
- websocket: 웹 소켓과 동일한 생명 주기를 가지는 스코프

request scope

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분이 어렵다.
이럴 때 request scope를 사용한다.
기대하는 공통 포맷: [UUID], [requestURL], {message}
UUID(전 세계에 딱 하나만 있는 ID)를 사용해서 HTTP 요청을 구분한다.
requestURL 정보도 추가로 넣어서 어떤 URL을 요청해서 남은 로그인지 확인하자.

9.6 request 스코프 예제 만들기

Ex) request scope

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

- builde.gradle에 starter-web라이브러리를 추가한다.

-> 추가하면 스프링 부트는 내장 톰캣 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.

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

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

- 이 빈이 생성되는 시점에 자동으로 @PostConstructor 초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다. 이 빈은HTTP 요청당 하나씩 생성되므로 uuid를 저장해두면 다른 HTTP 요청과 구분 가능하다.

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

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

Ex)

LogDemoController: 로거가 잘 작동하는지 확인하는 컨트롤러
여기서 HttpServletRequest를 통해 요청 URL을 받는다.
받은 URL 값을 myLogger에 저장해둔다. myLogger는 HTTP 요청당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정을 하지 않아도된다.
컨트롤러에서 controller test라는 로그를 남긴다.

<hide/>
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";
    }
}

LogDemoService
request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면 파라미터가 많아서 지저분하다.
- requestURL 같은 웹 관련 정보가 웹과 관련없는 서비스 계층까지 넘어가게 된다는 게 더 큰 문제이다.
- 웹 관련 부분은 컨트롤러까지만 사용해야한다.
- 서비스 계층은 웹 기술에 종속되지 않고 가급적 순수하게 유지해야 유지 보수 관점에서 좋다.
request scope의 MyLogger덕분에 이런 부분을 파라미터로 넘기지 않고 MyLogger의 멤버 변수에 저장해서 코드, 계층을 깔끔하게 유지할 수 있다.

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

Note) CoreApplication 실행결과 - 오류 나는 게 정상

- 서버가 뜨지도 않는다.

- 스프링 컨테이너가 뜰 때, LogDemoController를 스프링 빈에 등록해야하는데 그 때 의존관계 주입이 일어난다.

- 스프링 컨테이너한테 myLogger를 달라고 하는데 문제가 있다. myLogger는 scope이 request scope이다. 그런데, request가 없다.

-> 그런데, 지금 스프링을 띄우는 단계에서는 http request가 들어오지 않은 상태이다. 따라서 오류가 날 수 밖에 없다.

-> 오류: Scope 'request' is not active => 'provider'로 해결한다.

ScopeNotActiveException: Error creating bean with name 'myLogger': Scope 'request' is not active for the current thread; => Scope 가 현재 active되지 않았다는 뜻
IllegalStateException: No thread-bound request found: Are you referring to request attributes outside of an actual web request, or processing a request outside of the originally receiving thread?

9.7 스코프와 Provider

Ex) 해결 방안 (1) - ObjectProvider 사용

- 컨트롤러 클래스를 수정한다.

-> MyLogger를 주입 받는 게 아니라 MyLogger를 찾을 수 있는 Dependency LookUp(DI)할 수 있는 애가 주입된다.

<hide/>
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";
    }
}

Note) 실행결과 - 똑같은 오류 발생

- IllegalStateException: No thread-bound request found: Are you referring to request attributes outside of an actual web request, or processing a request outside of the originally receiving thread?

- LogDemoService 클래스를 다음과 같이 수정한다.

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

Note) 실행 결과

- request scope 빈을 만들고 소멸되는 것이 로그에 남는다.

- 네 개의 uuid(Universally unique identifier - 범용 고유 식별자)가 똑같다. 한 고객의 요청이다

- 여러 번 log-demo를 실행하면

-> 각 요청마다 uuid가 다르게 나온다.

-> 동시에 여러 요청이 오더라도 요청마다 객체를 따로 관리해준다. 멤버변수 관리가 가능하다.

9.8 스코프(scope)와 프록시(proxy)

Ex) 스코프와 프록시

- MyLogger 클래스

-> proxyMode = ScopedProxyMode.TARGET_CLASS

-> proxyMode 적용 대상이 클래스인 경우 => TARGET_CLASS, 인터페이스인 경우 => 'INTERFACES'

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

<hide/>
package hello.core.common;
import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.util.UUID;
@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
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);
    }
}

- LogDemoService

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

- LogDemoController

<hide/>
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) throws InterruptedException {
        String requestURL = request.getRequestURL().toString();
        myLogger.setRequestURL(requestURL);
        myLogger.log("controller test");
        Thread.sleep(1000);
        logDemoService.logic("testId");
        return "OK";
    }
}

Note) 실행결과

- 마치 Provider를 쓰는 것처럼 동작한다.

- MyLogger를 주입 받은 것 처럼 동작

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

<hide/>
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) throws InterruptedException {
        String requestURL = request.getRequestURL().toString();
        System.out.println("myLogger = " + myLogger.getClass());
        myLogger.setRequestURL(requestURL);
        myLogger.log("controller test");
        Thread.sleep(1000);
        logDemoService.logic("testId");
        return "OK";
    }
}

Note) 실행 결과

- 스프링이 조작해서 만든 것이 스프링 빈으로 등록되어 있다. 마치 provider처럼 동작한다.

- 컨트롤러의 멤버 MyLogger는 진짜가 아닌 가짜 MyLogger이다. => 출력된다.

- 기능을 실제로 호출하는 시점 setRequest(), 이 때 진짜를 찾아서 동작한다.

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

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

가짜 프록시 객체는 내부에 실제 MyLogger를 찾는 방법을 알고 있다.
클라이언트가 myLogger.logic()을 호출하면 사실 가짜 프록시 객체의 메서드를 호출한 것이다.
가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic()을 호출한다.
원본 클래스를 상속 받아 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 원본인지 아닌지 모르게 사용가능하다. (다형성)

출처

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/

스프링 핵심 원리 - 기본편 - 인프런 | 강의

스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., - 강의 소개 | 인프런...

www.inflearn.com

저작자표시

'Spring Framework > [인프런] Spring 핵심 원리' 카테고리의 다른 글

Chapter 08. 빈 생명주기(Bean Life Cycle) 콜백 (0)	2022.08.16
Chapter 07. 의존 관계 자동 주입 (0)	2022.08.15
Chapter 06. 컴포넌트 스캔(@ComponentScan) (0)	2022.08.14
Chapter 05. 싱글톤 컨테이너 (0)	2022.08.14
Chapter 04. 스프링 컨테이너와 스프링 빈 (0)	2022.08.12

현재글Chapter 09. 빈 스코프(Bean Scope)

Backend Developer lan4250@naver.com https://github.com/goraneee

코드업, BFS, 스프링, SQL, 프로그래머스, JPA, Java, DB, mysql, 데이터베이스, 알고리즘, Stack, dp, 백준, 자바, GIT, 제로베이스 스쿨, Queue, 제로베이스 백엔드, dfs,

Today :
Yesterday :

일	월	화	수	목	금	토
			1	2	3	4
5	6	7	8	9	10	11
12	13	14	15	16	17	18
19	20	21	22	23	24	25
26	27	28	29	30	31

계란 블로그