빈 스코프

Jemin·2023년 10월 19일
Spring
0

백엔드

목록 보기
18/21
post-thumbnail

빈 스코프란

빈의 스코프는 해당 빈(또는 컴포넌트)이 생성되고 유지되는 범위를 나타내며, 이것은 빈 객체의 생명주기와 관련이 있다. 스코프는 빈이 언제 생성되고 언제 소멸되는지를 제어하며, 이는 빈의 동작 및 사용 방식에 영향을 미친다.

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

  • 싱글톤: 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프이다.

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

  • 웹 관련 스코프

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

프로토타입 스코프

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

싱글톤 빈 요청

  1. 싱글톤 스코프의 빈을 스프링 컨테이너에 요청한다.

  2. 스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환한다.

  3. 이후에 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈을 반환한다.

package hello.core.scope;

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") // 싱글톤 스코프
    static class SingletonBean {

        @PostConstruct // 의존관계 주입이 끝나면 호출
        public void init() {
            System.out.println("SingletonBean.init");
        }

        @PreDestroy // 빈이 종료될 때 호출
        public void destroy() {
            System.out.println("SingletonBean.destroy");
        }
    }
}

프로토타입 빈 요청1

  1. 프로토타입 스코프의 빈을 스프링 컨테이너에 요청한다.

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

프로토타입 빈 요청2

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

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

여기서 핵심은 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다는 것이다. 클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다.

프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다. 그래서 @PreDestroy같은 종료 메서드가 호출되지 않는다.

package hello.core.scope;

public class PrototypeTest {
    @Test
    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");
        }
    }
}

프로토타입 빈의 특징과 정리

  • 스프링 컨테이너에 요청할 때 마다 새로 생성된다.

  • 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입 그리고 초기화까지만 관여한다.

  • 종료 메서드가 호출되지 않는다.

  • 프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 한다. 종료 메서드에 대한 호출도 클라이언트가 직접 해야한다.

싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드가 실행 되지만, 프로토타입 스코프의 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고, 초기화 메서드도 실행된다.

프로토타입 빈을 2번 조회했으므로 완전히 다른 스프링 빈이 생성되고, 초기화도 2번 실행된다.

싱글톤 빈은 스프링 컨테이너가 관리하기 때문에 스프링 컨테이너가 종료될 때 빈의 종료 메서드가 실행되지만, 프로토타입 빈은 스프링 컨테이너가 생성과 의존관계 주입, 초기화 까지만 관여하고, 더 이상 관리하지 않는다. 따라서 프로토타입 빈은 스프링 컨테이너가 종료될 때 @PreDestroy 같은 종료 메서드가 전혀 실행되지 않는다.

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

만약 프로토타입 스코프와 싱글톤 빈을 함께 사용하면 어떤 문제가 발생할지 예시를 통해 알아보자.
스프링 컨테이너에 프로토타입 빈을 직접 요청하는 경우.

  1. 클라이언트A가 스프링 컨테이너에 프로토타입 빈을 요청한다.

  2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x01)한다. 해당 빈의 count 필드 값은 0이다.

  3. 클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하면서 count 필드를 +1 한다.

결과적으로 프로토타입 빈(x01)의 count는 1이 된다.
만약 다른 클라이언트가 동일하게 요청하면 어떻게 될까?

  1. 클라이언트B가 스프링 컨테이너에 프로토타입 빈을 요청한다.

  2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x02)한다. 해당 빈의 count 필드 값을 0이다.

  3. 클라이언트는 조회한 프로토타입 빈에 addCount()를 호출해서 count 필드를 +1 한다.

결과적으로 프로토타입 빈(x02)의 count는 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; // count 필드

        public void addCount() { // count +1 하는 메서드
            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");
        }
    }
}

여기까지는 아무런 문제가 없다. 각각의 프로토타입 빈이 생성되고 각각의 프로토타입 빈의 count를 올려줬다.

다른 예시로 clientBean이라는 싱글톤 빈이 의존관계 주입을 통해서 프로토타입 빈을 주입받아서 사용하는 예시를 보자.
clientBean은 싱글톤이므로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 발생한다.

  1. clientBean은 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.

  2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환한다. 프로토타입 빈의 count 필드 값은 0이다.

이제 clientBean은 프로토타입 빈을 내부 필드에 보관한다. (정확히는 참조값을 보관한다.)
클라이언트A는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean이 반환된다.

  1. 클라이언트A는 clientBean.logic()을 호출한다.

  2. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가시킨다. count값이 1이 된다.

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

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

  1. 클라이언트B는 clientBean.logic()을 호출한다.

  2. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가시킨다. 원래 1이었으므로 2가 된다.

package hello.core.scope;

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

        ClientBean clientBean2 = ac.getBean(ClientBean.class);
        int count2 = clientBean2.logic();
        assertThat(count2).isEqualTo(2); // 새로 생성된 프로토타입 빈이 아니기 때문에 2가 된다
    }

    @Scope("singleton") // 싱글톤 스코프
    static class ClientBean {
        private final PrototypeBean prototypeBean; // 생성 시점에 주입

        public ClientBean(PrototypeBean prototypeBean) { // 프로토타입 빈을 의존 관계로 주입받는다
            this.prototypeBean = prototypeBean;
        }

        public int logic() {
            // 주입 받은 프로토타입 빈의 count를 올리고 그 count값을 반환한다
            prototypeBean.addCount();
            return prototypeBean.getCount();
        }
    }


    @Scope("prototype") // 프로토타입 스코프
    static class PrototypeBean {
        private int count = 0; // count 필드

        public void addCount() { // count +1 하는 메서드
            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");
        }
    }
}

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

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

Provider를 사용한 문제 해결

의존관계를 외부에서 주입(DI)받는게 아니라 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL) 의존관계 조회(탐색) 이라 한다.

하지만 이렇게 스프링 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다. 이럴 때 필요한 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 기능을 스프링은 지원해주고 있다.

ObjectFactory, OjbectProvider

지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하는 것이 바로 ObjectProvider다.

과거에는 ObjectFactory가 있었지만, 여기에 편의 기능을 추가해서 ObjectProvider가 만들어졌다.

package hello.core.scope;

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

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

    @Component
    @Scope("singleton") // 싱글톤 스코프
    static class ClientBean {

        @Autowired
        private ObjectProvider<PrototypeBean> prototypeBeanProvider;

        public int logic() {
            // Provider를 사용해서 PrototypeBean을 DL한다
            PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
            prototypeBean.addCount();
            return prototypeBean.getCount();
        }
    }


    @Component
    @Scope("prototype") // 프로토타입 스코프
    static class PrototypeBean {
        private int count = 0; // count 필드

        public void addCount() { // count +1 하는 메서드
            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");
        }
    }
}

실행해보면 prototypeBeanProvider.getObject()를 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
ObjectProvider의 getObject()를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다.

스프링이 제공하는 기능을 사용하지만, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다. ObjectProvider는 지금 딱 필요한 DL 정도의 기능만 제공한다.

JSR-330 Provider

마지막 방법은 자바 표준 라이브러리인 jakarta.inject.Provider를 사용하는 방법이다.

스프링부트 3.0 이상이라면 아래의 라이브러리를 추가한다.

// build.gradle
implementation 'jakarta.inject:jakarta.inject-api:2.0.1'
import jakarta.inject.Provider;

...

    @Component
    @Scope("singleton") // 싱글톤 스코프
    static class ClientBean {

        @Autowired
        private Provider<PrototypeBean> provider;

        public int logic() {
            // Provider를 사용해서 PrototypeBean을 DL한다
            PrototypeBean prototypeBean = provider.get();
            prototypeBean.addCount();
            return prototypeBean.getCount();
        }
    }

실행해보면 ObjectProvider와 동일하게 작동하는 것을 확인할 수 있다.

Provider의 get()을 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. 자바 표준이고, 기능이 단순하므로 단위 테스트를 만들거나 mock 코드를 만들기는 훨씬 쉬워진다.

Provider또한 DL 정도의 기능만 제공한다.

자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.

profile
Jemin
경험은 일어난 무엇이 아니라, 그 일어난 일로 무엇을 하느냐이다.
이전 포스트

Spring Bean 생명 주기 콜백 시점

다음 포스트

스프링부트 Response 만들기

0개의 댓글