[Spring] 빈 스코프 2) 프로토타입 스코프

728x90

빈 스코프 - 빈 스코프란?
빈 스코프 - 프로토타입 스코프
빈 스코프 - 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 문제점
빈 스코프 - 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 Provider로 문제 해결
빈 스코프 - 웹 스코프
빈 스코프 - request 스코프 예제 만들기
빈 스코프 - 스코프와 Provider
빈 스코프 - 스코프와 프록시

프로토타입 스코프

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

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

싱글톤 빈의 요청 vs 프로토타입 빈의 요청

프로토타입 스코프의 빈을 스프링 컨테이너에 요청
요청을 받으면, 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계를 주입함
스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환(끝, 더 이상 관리하지 않음)
이후에 스프링 컨테이너는 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환한다.

<정리>

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

위의 상황을 코드로 테스트 해보자

싱글톤 스코프 빈 테스트

싱글톤 스코프 이므로, 같은 빈을 다른 변수명으로 호출해 사용해도 같은 빈이어야 할 것이다.

singletonBeanTest

package hello.core.scope;

import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
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 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")//default값
    static class SingletonBean{

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

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


    }
}

테스트 성공(Same) + 같은 빈 출력까지 확인

빈 초기화 메서드를 실행
같은 인스턴스의 빈을 조회
종료 메서드까지 정상 호출

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

프로토타입 스코프 이므로, 호출을 아무리 해도 서로 다른 빈이어야 할 것이다.

PrototypeTest

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 prototypeBeanFind(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class); //컴포넌트 클래스가 파라미터(자동으로 파라미터로 들어간 클래스가 컴포넌트 스캔됨->@Component안써도 )

        System.out.println("find prototypeBean1");
        PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class); //호출 시 생성됨(init호출)

        System.out.println("find prototypeBean2");
        PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class); //호출 시 생성됨(init호출)

        System.out.println("prototypeBean1 = " + prototypeBean1);
        System.out.println("prototypeBean2 = " + prototypeBean2);
        assertThat(prototypeBean1).isNotSameAs(prototypeBean2); //1과 2가 같지 않음이 true여야함

        //만약 destroy가 꼭 필요한 일이 있으면 수동호출 해주어야함
//        prototypeBean1.destroy();
//        prototypeBean2.destroy(); 

        ac.close();
    }


    @Scope("prototype")//default값
    static class PrototypeBean{

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

        @PreDestroy
        public void destroy(){// 호출되지 않음
            System.out.println("PrototypeBean.destroy");
        }


    }



}

테스트 성공(notSame) + 서로 다른 객체

초기화(init)2번 실행
destroy 실행되지 않음
완전히 다른 스프링 빈이 생성됨

차이점

싱글톤 빈

스프링 컨테이너 시점에 초기화 메서드(init)이 실행됨
스프링 컨테이너가 빈을 관리하기 때문에 스프링 컨테이너가 종료될 때 빈의 종료 메서드가 실행됨

프로토타입 빈

스프링 컨테이너에서 빈을 조회할 때 생성되며, 초기화 메서드도 실행
스프링 컨테이너가 생성과 의존관계 주입 초기화 까지만 관여하고, 더이상 관리하지 않음, 컨테이너가 종료되어도 @PreDestroy가 실행되지 않음

프로토타입 빈의 특정

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

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

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

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

스프링 컨테이너에 프로토타입 빈을 직접 요청하는 예제

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

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

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

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

이제 이를 코드로 보면, 다음과 같다.

SingletonWithPrototypeTest1

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 prototypeFind(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);

        //각자 다른 prototypeBean의 count field가 1인지
        
        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++;
        }

        private 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 이 반환된다.

3. 클라이언트 A는 clientBean.logic() 을 호출한다.
4. clientBean 은 prototypeBean의 addCount() 를 호출해서 프로토타입 빈의 count를 증가한다. count값이 1이 된다.

클라이언트 B는 clientBean 을 스프링 컨테이너에 요청해서 받는다.

싱글톤이므로 항상 같은 clientBean 이 반환된다.

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

5. 클라이언트 B는 clientBean.logic() 을 호출한다.
6. clientBean 은 prototypeBean의 addCount() 를 호출해서 프로토타입 빈의 count를 증가한다. 원래 count 값이 1이었으므로 2가 된다.

코드로 확인해보자.

package hello.core.scope;

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;

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

public class SingletonWithPrototypeTest1 {

	//생략

    @Test
    void singletonClientUsePrototype(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class); //매개변수에 있는것 스프링 빈으로 자동등록


        ClientBean clientBean1 = ac.getBean(ClientBean.class);
        int count1 = clientBean1.logic();
        assertThat(count1).isEqualTo(1); //count 0->1


        ClientBean clientBean2 = ac.getBean(ClientBean.class);
        int count2 = clientBean2.logic();
        assertThat(count2).isEqualTo(2);//count 1->2


    }


    @Scope("singleton")
    static class ClientBean{

        private final PrototypeBean prototypeBean;

        @Autowired
        public ClientBean(PrototypeBean prototypeBean){ //이때 스프링 컨테이너에 PrototypeBean을 요청-> 그떄 만들어져서 ClientBean(싱글톤)에 할당  (생성시점에 주입)
            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++;
        }

        private int getCount(){
            return count;
        }


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

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


    }


}

위의 그림과 마찬가지의 결과가 나온다.

이는, 프로토타입 스코프를 사용하는 의미가 전혀 없는 결과이다.

프로토타입 스코프 빈을 사용한다는 것은 생성시 마다 새로 빈을 만들어 제공받아 둘다 count가 1을 돌려받는 것을 기대했을 것이다.

이의 원인은 ClientBean의 생성자가 호출될 때, 스프링 컨테이너에 PrototypeBean을 만들어 할당하여, 생성시점에 주입이 끝났기 때문이다.

따라서, 단순하게 해결하기 위해서는 프로토타입을 생성시에 주입하지 않고 원할 때 마다 호출하여 할당해야 할 것이다.

@Scope("singleton")
    static class ClientBean{

        @Autowired
        ApplicationContext applicationContext;

        public int logic(){
            PrototypeBean prototypeBean = applicationContext.getBean(PrototypeBean.class); //이 처럼 logic이 실행될 때 마다 항상 요청하면 원하는 대로 만들 수 있다
            prototypeBean.addCount();
            int count = prototypeBean.getCount();
            return count;
        }




    }

다음과 같이 수정하면, 둘다 1이 반환된다.

목적은 달성했지만 좋은 방법은 아니다.

스프링은 일반적으로 싱글톤 빈을 사용하므로, 싱글톤 빈이 프로토타입 빈을 사용하게 된다.

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

목적은 "프로토타입 빈을 주입 시점에만 새로 생성하는게 아니라, 사용할 때 마다 새로 생성해서 사용하는 것"

참고: 여러 빈에서 같은 프로토타입 빈을 주입 받으면, 주입 받는 시점에 각각 새로운 프로토타입 빈이 생성된다. 예를 들어서 clientA, clientB가 각각 의존관계 주입을 받으면 각각 다른 인스턴스의 프로토타입 빈을 주입 받는다.

clientA → prototypeBean@x01
clientB → prototypeBean@x02
물론 사용할 때 마다 새로 생성되는 것은 아니다.

예를 들어 다음과 같이 클라이언트 1,2가 존재할 때, 둘은 생성 시점에 각각 주입받기 때문에

서로 다른 인스턴스의 프로토타입 빈을 주입받는다.

하지만, 이 또한 각자 다를 뿐이지 사용시 마다 생성되는 것은 아니다

    @Scope("singleton")
    static class ClientBean1{

        private final PrototypeBean prototypeBean;

        @Autowired
        public ClientBean1(PrototypeBean prototypeBean){ //생성 시점에 주입
            this.prototypeBean = prototypeBean;
        }


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

    }


    @Scope("singleton")
    static class ClientBean2{

        private final PrototypeBean prototypeBean;

        @Autowired
        public ClientBean2(PrototypeBean prototypeBean){ //생성 시점에 주입
            this.prototypeBean = prototypeBean;
        }


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

    }

프로토타입 스코프
-
Provider

프로토타입 스코프를 싱글톤 빈과 함께 사용시 문제점에 대해 알아보았다.

둘을 함께 사용해도, 사용할 때 마다 항상 새로운 프로토타입 빈을 생성할 수 있어야 한다.

방법에는 두가지가 있다

싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청
Provider 사용

싱글톤 빈이 프로토타입을 사용할 때 마다 스프링 컨테이너에 새로 요청

이미 위에서 살펴봤듯이 다음과 같이 사용시마다 새로 요청하면, 이 문제를 해결할 수 있다

SingletonWithPrototypeTest1

@Scope("singleton")
    static class ClientBean{

        @Autowired
        ApplicationContext applicationContext;

        public int logic(){
            PrototypeBean prototypeBean = applicationContext.getBean(PrototypeBean.class); //이 처럼 logic이 실행될 때 마다 항상 요청하면 원하는 대로 만들 수 있다
            prototypeBean.addCount();
            int count = prototypeBean.getCount();
            return count;
        }




    }

ac.getBean()을 통해 항상 새로운 프로토타입 빈이 생성된다.

이는 의존관계를 외부에서 주입받는 DI가 아니라, 직접 필요한 의존관계를 확인하는 방법으로 Dependecncy Lookup(DL) 의존관계 탐색(조회)라고 한다.

하지만, 이렇게 스프링 애플리케이션 컨텍스트 전체를 주입받게되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위테스트가 어려워진다.

지금 필요한 기능은 단지 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 단순한 DL의 기능이다.

스프링에는 이런 기능을 제공해 주는 것이 있다.

Provider (ObjectFactory, ObjectProvider)

지정한 빈을 컨테이너에서 찾아주는 DL서비스를 제공한다.

ObjectFactory : getObject()메소드 만을 제공
ObjectProvider : ObjectFactory를 상속받은 인터페이스로 getObject()이외에도 다양한 편의 메소드를 제공

SingletonWithPrototypeTest1

    @Scope("singleton")
    static class ClientBean{

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

*Provider는 prototypeBean에 특화된 기능이 아니다. 새로운 프로토타입 생성에 초점이 아니라,

"스프링 컨테이너를 직접 조회하지 않고, 대리로 조회해주는 것(DL)"이다.

조회가 되니까 prototype 빈이 생성될 뿐이다.

특징

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

스프링이 제공하는 기능을 사용하지만, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다.

* ObjectProvider , JSR330 Provider 등은 프로토타입 뿐만 아니라 DL이 필요한 경우는 언제든지 사용할 수 있다.

여러개의 인스턴스를 검색
순환참조 발생시(circular dependencies) : 두 가지가 서로 필요한 시점을 조절해서 순환참조를 break할 수 있음
등등..(클래스 정의 참조)

JSR-330 Provider

javax.inject.Provider라는 JSR-330 자바 표준을 사용하는 방법

사용을 위해서는 gradle에 라이브러리를 추가해주어야 한다.

라이브러리 추가

dependencies {
	//inject 
	implementation 'javax.inject:javax.inject:1'
}

SingletonWithPrototypeTest1

    @Scope("singleton")
    static class ClientBean{

        @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 코드를 만들기는 훨씬 쉬워진다.

Provider 는 지금 딱 필요한 DL 정도의 기능만 제공한다. (장점, 단점 너무 simple)

특징

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

프로토타입 빈을 사용하는 때

매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용하면 된다.

그런데 실무에서 웹 애플리케이션을 개발해보면, 싱글톤 빈으로 대부분의 문제를 해결할 수 있기 때문에 프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다.

JSR-330 Provider vs ObjectProvider

ObjectProvider는 DL을 위한 편의 기능을 많이 제공해주고 스프링 외에 별도의 의존관계 추가가 필요 없기 때문에 편리하다. 만약(정말 그럴일은 거의 없겠지만) 코드를 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 한다면 JSR-330 Provider를 사용해야한다.

스프링을 사용하다 보면 이 기능 뿐만 아니라 다른 기능들도 자바 표준과 스프링이 제공하는 기능이 겹칠때가 많이 있다.

대부분 스프링이 더 다양하고 편리한 기능을 제공해주기 때문에, 특별히 다른 컨테이너를 사용할 일이 없다면, 스프링이 제공하는 기능을 사용하면 된다.

(jpa에서는 표준을 거의 사용하고, 스프링에서는 스프링 기능을 사용함)

→ 표준사용을 권장할 때는 스프링에서 알아서 권장함

728x90

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

spring project를 spring 으로 인지하지 못한다! (0)	2022.08.10
[Spring] 빈 스코프 3) 웹 스코프 (0)	2021.10.07
[Spring] 빈 스코프 1) 빈 스코프란? (0)	2021.10.07
[Spring] 빈 생명주기 콜백 (0)	2021.10.07
[Spring] 의존관계 자동 주입 3) List & Map (0)	2021.10.06

IagreeBUT

[Spring] 빈 스코프 2) 프로토타입 스코프

목차

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

티스토리툴바

[Spring] 빈 스코프 2) 프로토타입 스코프

목차

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

'Backend/Spring' Related Articles

티스토리툴바