[SpringBoot] 빈 스코프 (싱글톤과 프로토타입 스코프)

빈 스코프란?

기본적인 스프링 빈은 싱글톤 스코프로 생성이 됩니다.

싱글톤 스코프란, 스프링 컨테이너의 시작과 함께 생성되어 스프링 컨테이너가 종료될 때까지 유지되는 빈입니다.

스코프는 번역 그대로 빈이 존재할 수 있는 범위를 뜻합니다.

스프링은 다음과 같은 다양한 스코프를 지원합니다.

빈의 종류

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

범위 지정 방법

빈 자동 등록 (컴포넌트 스캔)

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

빈 수동 등록

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

먼저 프로토타입 스코프에 대해 자세히 알아보도록 하겠습니다.

프로토타입 스코프

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

반면에, 프로토타입 스코프를 스프링 컨테이너에 조회화면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환합니다.

싱글톤 빈 요청

싱글톤 스코프의 빈을 스프링 컨테이너에게 요청한다.
스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환한다.
이후에 스프링 컨테이너에게 다른 클라이언트가 같은 요청을 하면 같은 객체 인스턴스의 스프링 빈을 반환한다.

프로토타입 빈 요청

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

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

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

정리

핵심은 스프링 컨테이너는 프로토타입 빈을 생성, 의존관계 주입, 초기화까지만 처리한다는 것입니다.

클라이언트에 빈을 반환한 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않습니다.

따라서 @PreDestory 같은 종료 메서드가 호출되지 않습니다.

프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있습니다. 따라서 프로토타입 빈을 사용 후에 명시적으로 소멸시켜줘야 합니다.

참고
프로토타입 빈은 스프링 컨테이너가 관리하지 않으므로, 서버가 종료되면 해당 인스턴스는 가비지 컬렉션에 의해 메모리에서 해제될 수 있습니다.

싱글톤 스코프 빈 테스트

먼저 싱글톤 스코프의 빈을 조회하는 singletonBeanFind() 테스트를 통해 여러 요청시에 같은 인스턴스를 반환하는지 확인해 봅시다.

public class SingletonTest {

    @Scope("singleton")
    static class SingletonBean {

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

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

    @Test
    public void singletonBeanFind() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SingletonBean.class);
        System.out.println("Find SingletonBean1");
        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();     // 종료
    }
}

실행 결과

SingletonBean.init
Find SingletonBean1
singletonBean1 = hello.core.scope.SingletonTest$SingletonBean@186f8716
singletonBean2 = hello.core.scope.SingletonTest$SingletonBean@186f8716
21:15:18.504 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@2ea6137, started on Sun Jul 02 21:15:18 YAKT 2023
SingletonBean.destroy

getBean() 전에 컨테이너가 생성될 때, bean도 함께 생성되어 초기화되었습니다.
같은 인스턴스가 리턴됐습니다.
컨테이너가 종료되자, 종료 메서드가 호출됐습니다.

프로토타입 스코프 테스트

프로토타입 스코프의 빈을 조회하는 prototypeBeanFind() 테스트를 통해 차이점을 알아보겠습니다.

public class PrototypeTest {

    @Scope("prototype")
    static class PrototypeBean {

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

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

    @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);
        Assertions.assertThat(prototypeBean1).isNotSameAs(prototypeBean2);
        ac.close();
    }
}

실행 결과

find prototypeBean1
PrototypeBean.init
find prototypeBean2
PrototypeBean.init
prototypeBean1 = hello.core.scope.PrototypeTest$PrototypeBean@186f8716
prototypeBean2 = hello.core.scope.PrototypeTest$PrototypeBean@1d8bd0de
16:04:42.669 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - 
Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@2ea6137, started on Fri Jun 30 16:04:42 YAKT 2023

싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드가 실행되지만, 프로토타입 빈은 스프링 컨테이너에서 빈을 조회할 때 생성 및 초기화가 실행됩니다.
프로토타입 빈을 2번 조회했으므로 완전히 다른 스프링 빈이 생성되고 초기화도 2번 실행된 것을 확인할 수 있습니다.
싱글톤 빈은 스프링 컨테이너가 관리하기 때문에, 스프링 컨테이너가 종료될 때 빈의 종료 메서드가 실행되지만, 프로토타입 빈은 스프링 컨테이너가 생성, 의존관계 주입, 초기화까지만 관여하기 때문에 @PreDestroy 같은 종료 메서드가 실행되지 않습니다.
prototypeBean1.destroy() 같이 명시적으로 호출해야 합니다. 해당 함수를 호출하면 PrototypeBean.destroy가 출력되는 것을 확인할 수 있습니다.

프로토타입 빈의 특징 정리

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

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

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

하지만, 싱글톤 빈과 함께 사용한다면 의도한 대로 항상 새로운 객체 인스턴스를 생성하여 반환하지 않으므로 주의해야 합니다.

예시를 통해 살펴봅시다.

먼저, 스프링 컨테이너에 프로토타입 빈을 직접 요청하는 예제를 봅시다.

프로토타입 빈 직접 요청 - 정상 결과

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

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

해당 테스트 코드

public class SingletonWithPrototypeTest1 {

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

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

싱글톤 빈에서 프로토타입 빈 사용 - 문제 발생

이번에는 clientBean이라는 싱글톤 빈을 생성합니다.

해당 빈은 의존관계 주입을 통해 프로토타입 빈을 주입받아 사용합니다.

ClientBean은 싱글톤이므로, 스프링 컨테이너 생성 시점에 함께 생성 및 의존관계 주입이 발생합니다.

1. ClientBean은 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에게 프로토타입 빈을 요청한다.
2. 스프링 컨테이너는 프로토타입 빈을 생성하여 ClientBean에 반환한다. 이때 프로토타입 빈의 count 필드 값은 0이다.
3. 이제 clientBean은 프로토타입 빈을 내부 필드에 보관한다. (정확히는 참조값을 보관한다.)

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

4. 클라이언트 A는 ClientBean.logic()을 호출한다.
5. ClientBean은 prototypeBean의 addCount()를 호출하여 프로토타입 빈의 count를 증가시킨다. count 빈의 값은 1이 된다.

ClientBean.logic()

public int logic() {
    prototypeBean.addCount();    // count 1 증가
    int count = prototypeBean.getCount();
    return count;
}

이번엔 클라이언트 B가 ClientBean을 스프링 컨테이너에게 요청하여 받습니다. 싱글톤이므로 항상 같은 ClientBean이 반환됩니다.

여기서 중요한 점이 있는데, ClientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈입니다.

주입 시점에 스프링 컨테이너에게 요청해 프로토타입 빈이 새로 생성이 된 것이지, ClientBean이 사용될 때마다 새로 생성되는 것이 아닙니다!

6. 클라이언트 B는 ClientBean.logic()을 호출한다.
7. ClientBean은 prototypeBean의 addCount() 를 호출하여 프로토타입 빈의 count를 증가시킨다. 원래 count값이 1이었으므로 2가 된다. (본래 의도대로라면 프로토타입은 새로 생성되어 count 값은 0으로 초기화가 되고, 1 증가했을 때 1이 되어야 합니다.)

해당 테스트 코드

public class SingletonWithPrototypeTest1 {

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

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

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

정리

스프링 빈은 일반적으로 싱글톤 빈을 사용하므로 싱글톤 빈이 프로토타입 빈을 의존하는 형태입니다.

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

아마 원하는 것은 이런 것이 아닐 것입니다.

프로토타입 빈을 주입 시점에만 새로 생성하는 것이 아니라, 사용할 때마다 새로 생성하여 사용하는 것을 원할 것입니다. (이럴거면 프로토타입 빈이 아니라 싱글톤 빈을 주입했지...)

참고
여러 다른 싱글톤 빈이 같은 프로토타입 빈을 주입받으면, 각각 새로운 프로토타입 빈이 생성됩니다.

예를 들어, 서도 다른 싱글톤 빈인 ClientA와 ClientB가 각각 의존관계를 주입받으면 각각 다른 인스턴스의 프로토타입 빈을 주입받습니다.
ClientA → prototypeBean@x01
ClientB → prototypeBean@x02

물론 위와 같이 프로토타입 빈을 사용할 때마다 새로 생성되는 것은 아닙니다.

여기에는 해결책이 하나 있습니다.

해결책: 스프링 컨테이너에게 요청

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

public class PrototypeProviderTest {

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

    static class ClientBean {

        @Autowired
        private ApplicationContext ac;

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

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

핵심 코드

@Autowired
private ApplicationContext ac;

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

결과

ac.getBean을 통해 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있습니다.
의존관계를 외부에서 주입(DI) 받는게 아니라 이렇게 직접 필요한 의존관계를 찾아 주입받는 것을 Dependency Lookup(DL) 의존관계 조회(탐색)이라고 합니다.

문제점

그런데, 이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고 단위테스트가 어려워집니다.
현재는 지정한 프로토타입 빈을 필요한 시점에 컨테이너에게 대신 찾아주는 딱 DL 역할만을 제공하는 무언가가 필요합니다.

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

ObjectFactory, Object Provider
JSR-330 Provider

출처

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/dashboard

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

스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., 스프링 핵심 원리를 이해하고, 성장하는 백엔드 개발자가 되어보세요! 📢

www.inflearn.com

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

[SpringBoot] 웹 스코프 (Request 스코프) (0)	2023.07.10
[SpringBoot] DL (ObjectProvider, JSR-330 Provider) (0)	2023.07.10
[SpringBoot] 초기화 및 소멸전 콜백 메서드 (0)	2023.07.02
[SpringBoot] @Autowired 매칭한 빈이 2개 이상일 때 해결방안 (0)	2023.06.24
[SpringBoot] 롬복(@RequiredArgsContructor), 적용 방법(gradle) (0)	2023.06.24

2245

[SpringBoot] 빈 스코프 (싱글톤과 프로토타입 스코프)

빈 스코프란?

빈의 종류

범위 지정 방법

프로토타입 스코프

싱글톤 빈 요청

프로토타입 빈 요청

정리

싱글톤 스코프 빈 테스트

프로토타입 스코프 테스트

프로토타입 빈의 특징 정리

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

프로토타입 빈 직접 요청 - 정상 결과

싱글톤 빈에서 프로토타입 빈 사용 - 문제 발생

정리

해결책: 스프링 컨테이너에게 요청

결과

문제점

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

티스토리툴바

« 2024/11 »
일	월	화	수	목	금	토
					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

[SpringBoot] 빈 스코프 (싱글톤과 프로토타입 스코프)

빈 스코프란?

빈의 종류

범위 지정 방법

프로토타입 스코프

싱글톤 빈 요청

프로토타입 빈 요청

정리

싱글톤 스코프 빈 테스트

프로토타입 스코프 테스트

프로토타입 빈의 특징 정리

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

프로토타입 빈 직접 요청 - 정상 결과

싱글톤 빈에서 프로토타입 빈 사용 - 문제 발생

정리

해결책: 스프링 컨테이너에게 요청

결과

문제점

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

관련글

티스토리툴바