빈스코프, 빈스코프란?, 프로토 타입 스코프, 프로토 타입 스코프(싱글톤 빈과 함께 사용시 문제점/싱글톤 빈과 함께 사용시 Provider로 문제 해결)

  출처 : 인프런 - 스프링 핵심원리 - 기본편(유료) / 김영한님  
  유료 강의이므로 정리에 초점을 두고 코드는 일부만 인용  

https://inf.run/kCYMv

---

1. 빈스코프란?

1) 스프링이 지원하는 다양한 스코프

(1) 스코프

• 스코프는 번역 그대로 빈이 존재할 수 있는 범위를 뜻함

(2) 싱글톤

• 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프
• 지금까지 스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어 스프링 컨테이너가 종료될 때까지 유지된다고 학습한 이유가 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문임

(3) 프로토타입

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

(4) 웹 관련 스코프

• request : 웹 요청이 들어오고 나갈 때까지 유지 되는 스코프
• session : 웹 세션이 생성되고 종료될 때 까지 유지되는 스코프
• application : 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프

(5) 스코프 지정 방법

• @Scope애노테이션을 통해서 스코프를 직접 지저어할 수 있음

// 컴포넌트 스캔 자동 등록
@Scope("prototype")
@Component
public class HelloBean {}

// 수동 등록
@Scope("singleton")
@Bean
PrototypeBean HelloBean() {
    return new HelloBean();
}

---

2. 프로토 타입 스코프

1) 소개

(1) 싱글톤 타입 빈과의 차이

• 싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환 하지만 프로토 타입 빈은 항상 새로운 인스턴스를 생성해서 반환함
• 싱글톤 스코프의 빈을 스프링컨테이너에 요청하면 스프링 컨테이너는 본인이 관리하는 스프링빈을 반환하고 이후에 스프링 컨테이너에 같은 요청이와도 같은 객체 인스턴스의 스프링 빈을 반환함

(2) 프로토 타입 빈 요청

좌) 프로토 타입 빈 요청 시 빈이 만들어짐 / 우) 생성된 빈을 반환하고 바로 사라짐

1. 프로토 타입 스코프의 빈을 스프링 컨테이너에 요청
2. 스프링 컨테이너는 요청 시점에 프로토 타입 빈을 생성하고 필요한 의존관계를 주입함
3. 스프링 컨테이너가 생성한 프로토타입 빈을 클라이언트에 반환
4. 이후에 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환

(3) 핵심 정리

• 빈 스코프가 프로토타입이면 스프링 컨테이너가 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리 함
• 클라이언트에 빈을 반환한 이후에는 스프링 컨테이너가 생성된 프로토타입 빈을 관리하지 않으며 프로토타입 빈을 관리할 책임은 반환 받은 클라이언트에 책임이 있음
• 즉, @PreDestroy 같은 종료 메서드가 호출 되지 않음

2) 코드로 확인

(1) SingletonTest 작성 및 실행 - 싱글톤 빈

• test하위에 scope 패키지를 생성 후 작성
• @Scope를 singleton으로 지정하여 명시적으로 스코프의 범위를 지정
• 스프링 컨테이너에 SingletonBean클래스를 스프링빈으로 등록하고 조회해보면 같은 인스턴스의 빈을 조회하며 테스트가 통과됨
• 스프링 컨테이너 생성 시점에 빈이 생성이 되고 빈 초기화 메서드 호출 후 같은 인스턴스의 빈을 조회하며 종료 메서드 까지 정상 호출되는 로그를 확인할 수 있음

package hello.core.scope;

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@2555fff0
singletonBean2 = hello.core.scope.SingletonTest$SingletonBean@2555fff0
16:05:58.831 [Test worker] DEBUG o.s.c.a.AnnotationConfigApplicationContext --
                Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@3fb6cf60, started on Tue Nov 12 16:05:58 KST 2024
singletonBean.destroy
*/

 

(2-1) PrototypeTest 작성 및 실행 - 프로토타입 빈

• SingletonTest와 완전 동일한 테스트 케이스로 스코프의 범위만 prototype으로 변경 후 테스트 실행

package hello.core.scope;

public class PrototypeTest {

    @Test
    public void singletonBeanFind() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);

        PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
        PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);

        System.out.println("singletonBean1 = " + prototypeBean1);
        System.out.println("singletonBean2 = " + 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");
        }
    }
}

 

(2-2) 프로토 타입 테스트 실행 결과

• 싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드가 실행되지만 프로토타입 스코프의 빈은 스프링 컨테이너에서 빈을 조회할 때 빈이 생성이 되고 초기화 메서드도 실행 됨
• 프로토타입 빈을 2번 조회 했으므로 완전히 다른 스프링 빈이 생성되고 초기화도 2번 실행된 것을 로그로 확인할 수 있음
• 프로토 타입 빈은 스프링 컨테이너가 생성과 의존관계주입 그리고 초기화 까지만 관여하고 더는 관리하지 않기때문에 종료 메서드가 실행 되지 않은것을 로그로도 확인할 수 있음

find prototypeBean1
PrototypeBean.init // 초기화
find prototypeBean2
PrototypeBean.init // 초기화
prototypeBean1 = hello.core.scope.PrototypeTest$PrototypeBean@7a56812e // 다른 객체 빈 생성 호출
prototypeBean2 = hello.core.scope.PrototypeTest$PrototypeBean@2a76b80a // 다른 객체 빈 생성 호출
16:23:30.069 [Test worker] DEBUG o.s.c.a.AnnotationConfigApplicationContext --
// 종료 호출 메서드가 없음

 

(3) 프로토타입 빈의 특징 정리

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

---

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

1) 문제점 예제

• 싱글톤 빈과 함께 사용한 프로토타입 스코프의 빈은 항상 새로운 객체 인스턴스를 생성 및 반환 하지 않을 수 있어 주의가 필요함

(1-1) 프로토 타입 빈 직접 요청

• 1. 클라이언트 A가 스프링 컨테이너에 프로토타입 빈을 요청함
• 2. 스프링 컨테이너가 프로토타입 빈을 생성해서 반환(필드값은 0)
• 3. 클라이언트A는 조회한 프로토타입에 addCount()를 호출하면서 값을 증가시킴(필드값 1)
• 클라이언트 B도 동일하게 진행됨 (필드값 1)

(1-2) SingletonWithPrototypeTest1 작성

• 위 예제의 상황을 테스트 코드로 작성
• 테스트코드를 실행해보면 프로토 타입 빈으로 동작하여 조회된 빈의 인스턴스는 각각 다른 객체로 각 1씩 값이 저장됨

package hello.core.scope;

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

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

 

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

• clientBean이라는 싱글톤 빈이 의존관계 주입을 통해서 프로토타입 빈을 주입받아서 사용하는 예제

 

• clientBean은 싱글톤이므로 스프링 컨테이너 생성 시점에 함께 생성 되고 의존관계 주입도 발생함
• 1. 싱글톤 빈인 clientBean은 의존관계 자동 주입으로 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청
• 2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clienBean에 반환(필드값은 0)
• clientBean이(싱글톤 빈) 프로토타입 빈을 내부 필드에 보관(정확히는 참조값을 보관)
• 클라이언트A가 clientBean을 스프링 컨테이너 요청해서 받으면 싱글톤이므로 항상 같은 clientBean이 반환됨
• 3. 클라이언트 A가 clientBean.logic()을 호출
• 4. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가시키며 필드값이 1이 됨
• 클라이언트 B가 clientBean을 스프링 컨테이너에 요청해서 받으면 싱글톤이므로 항상 같은 clientBeand이 반환됨
• 5, 클라이언트 B가 clientBean.logic()을 호출
• 6. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입의 빈의 count를 증가시키며 필드값이 2가됨

좌) 클라이언트A가 로직을 호출하여 값을 증가시킴(값이 1이 됨) / 우) 클라이언트 B가 로직을 사용하여 값을 증가시킴 (값이 2가 됨)

(2-2) 중요한 점

• clienBean이 내부에 가지고 있는 프로토타입 빈은 과거에 이미 주입이 끝난 빈임
• 의존관계 주입 시점에 스프링컨테이너에 요청해서 프로토타입 빈이 생성이 된 것이지 사용 할 때마다 생성되는 것이 아님

(2-3) SingletonWithPrototypeTest1 수정

• 위 예제의 상황을 코드로 구현
• 싱글톤 빈인 ClientBean이 생성자를 통해 PrototypeBean을 주입받고, 클라이언트는 싱글톤 빈인 ClientBean을 사용하여 메서드를 호출
• ClientBean은 싱글톤 빈이기 때문에 getBean으로 두번 호출해도 동일 인스턴스를 반환하여 같은 객체를 호출하고, ClientBean의 내부에 있는 객체는 이미 주입이 끝난 빈이기 때문에 새로 생성되지 않고 기존의 객체가 반환되어 count 변수의 값이 2가 됨

package hello.core.scope;

public class SingletonWithPrototypeTest1 {

    @Test
    void prototypeFind() {
        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  // 싱글톤 빈
    static class ClientBean {
        private final PrototypeBean prototypeBean;  // 생성 시점에 주입

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

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

    // 프로토타입 빈 클래스 코드 동일
}

 

(3) 문제점 정리

• 스프링은 일반적으로 싱글톤 빈을 사용하므로 싱글톤 빈이 프로토타입 빈을 사용하게 됨
• 싱글톤 빈은 생성시점에만 의존관계 주입을 받기 때문에 프로토타입 빈이 새로 생성 되기는 하지만 싱글톤 빈과 함계 계속 유지 되기 때문에 함께 사용했을 때 문제가 발생함
• 싱글톤 빈과 프로토타입 빈을 함께 사용하고자 할때 기대하는 결과는 프로토타입 빈을 사용할 때마다 새로 생성해서 사용하는 것을 원할 것이기에 문제 해결이 필요함

** 참고

• 여러 싱글톤 빈에서 같은 프로토타입 빈을 주입 받으면 주입 받는 시점에 각각 새로운 프로토 타입 빈이 생성 됨
• 즉, clientA, clientB가 각각 의존관계를 주입 받았다면 각각의 싱글톤 빈이기 때문에 주입받은 프로토타입 빈도 다른 인스턴스가 생성되지만 이것도 마찬가지로 사용할 때마다 새로 생성되는 것은 아님
• clientA -> prototypeBean@x01
• clientB -> prototypeBean@x02

---

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

1) 스프링 컨테이너에 새로 요청

(1) PrototypeProviderTest 테스트 생성

• 가장 원초적인 방법으로 싱글톤 빈이 프로토 타입을 사용할 때 마다 스프링 컨테이너에 새로 요청하도록 하면 됨
• 테스트 코드를 실행해보면 logic()메서드 내부의 ac.getBean()을 통해서 항상 새로운 프로토타입 빈이 생성되어 count1과 count2의 값이 모두 1로 테스트가 통과되는 것을 확인할 수 있음
• 의존관계를 외부에서 주입(DI) 받는게 아니라 이렇게 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL) 의존관계 조회(탐색)이라고 함

package hello.core.scope;

public class PrototypeProviderTest {

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

    static class ClientBean {

        @Autowired
        private ApplicationContext ac;
        
        // ClientBean의 logic 메서드가 호출될 때마다 프로토타입의 빈이 조회되어 계속 생성됨
        public int logic() {
            PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
            prototypeBean.addCount();
            return prototypeBean.getCount();
        }
    }

    // 프로토타입 스코프 코드 동일
}

 

(2) 단점

• 그러나 ApplicationContext 전체를 주입 받게 되면 너무 기능도 다양하고 스프링 컨테이너에 종속적인 코드가 되며 단위 테스트가 어려워짐
• 지금 딱 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 딱 DL 정도의 기능만 제공되는 무언가 있으면 해결 됨

2) ObjectFactory, ObjectProvider

(1) PrototypeProviderTest - ClientBean 클래스 수정

• 지정한 빈을 컨테이너에서 대신 찾아주는 DL서비스를 제공하는 기능으로 단순한 ObjectFactory(과거 버전)와 ObjectProvider(새로운 버전)를 상속하고 다양한 옵션과 스트림처리 등의 편의 기능이 추가된 ObjectProvider가 있음
• ObjectProvider의 getObject()를 호출하면 내부에서 스프링컨테이너를 통해 해당 빈을 찾아서 반환하여 딱 DL 정도의 기능을 제공함
• 스프링이 제공하는 기능을 사용하므로 스프링에 의존적이지만 별도의 라이브러리 설정도 필요없고 기능이 단순하므로 단위 테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워짐

// ObjectFactory, ObjectProvider
static class ClientBean {

    @Autowired
    private ObjectProvider<PrototypeBean> prototypeBeanProvider;

    // ClientBean의 logic 메서드가 호출될 때마다 프로토타입의 빈이 조회되어 계속 생성됨
    public int logic() {
        PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
        prototypeBean.addCount();
        return prototypeBean.getCount();
    }
}

3) JSR-330 Provider(자바 표준) 사용

(1) 설정 등록

• 라이브러리를 bulid.gradle에 등록 해줘야함
• 스프링부트 3.0 이상 - jakarta.inject:jakarta.inject-api:2.0.1
• 스프링부트 3.0 미만 - javax.inject:javax:inject:1

implementation 'jakarta.inject:jakarta.inject-api:2.0.1'

 

(2) PrototypeProviderTest - ClientBean 클래스 수정

• Provider를 선언하여 provider.get()을 통해서 상항 새로운 프로토 타입 빈이 생성되는 것을 확인할 수 있음
• provider의 get()을 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환함
• 마찬가지로 딱 DL 정도의 기능만 제공하며 자바 표준이고 기능이 단순하므로 단위테스트나 mock 코드를 만들기가 훨신 쉬워짐
• get()메서드 하나로 기능이 매우 단순하며 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용이 가능하지만 별도의 라이브러리설정이 필요함

// JSR-330 Provider 자바 표준 사용
static class ClientBean {

    @Autowired
    private Provider<PrototypeBean> provider;

    // ClientBean의 logic 메서드가 호출될 때마다 프로토타입의 빈이 조회되어 계속 생성됨
    public int logic() {
        PrototypeBean prototypeBean = provider.get();
        prototypeBean.addCount();
        return prototypeBean.getCount();
    }
}

4) 정리

(1) 프로토타입 빈의 사용 유무

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

** 참고 - ObjectProvider와 JSR-330 Provier(자바표준) 선택 기준

• 스프링이 제공하는 ObjectProvider는 DL을 위한 편의기능을 많이 제공해주고 스프링 외에 별도의 의존관계 추가가 필요없기 때문에 편리하게 사용할 수 있음
• 거의 그럴일은 없겠지만 코드를 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 한다면 JSR-330 Provider를 사용하면 됨
• 스프링을 사용하다 보면 지금처럼 자바 표준과 스프링이 제공하는 기능이 겹칠 때가 많이 있는데 대부분 스프링이 더 다양하고 편리한 기능을 제공해주기 때문에 특별히 다른 컨테이너를 사용할 일이 없다면 스프링이 제공하는 기능을 사용하면 됨
• 스프링이 제공하는 메서드에 @Lookup 애노테이션을 사용하는 방법도 있지만 이전 방법들로도 충분하기에 강의에서 다루지 않았음