빈 스코프

빈 스코프란?

- 스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어 스프링 컨테이너가 종료될 때 까지 유지된다고 알고 있음

- 이것은 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문

- 스코프는 번역 그대로 빈이 존재할 수 있는 범위를 의미

 

 

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

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

2. 프로토타입: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프 (초기화 까지만 하므로, 생성 메서드 호출 O, 종료 메서드 호출 X)

3. 웹 관련 스코프

- request: 웹 요청이 들어오고 나갈때 까지 유지되는 스코프

- sessioin: 웹 세션이 생성되고 종료될 때 까지 유지되는 스코프

- application: 웹의 서블릿 컨텍스와 같은 범위로 유지되는 스코프

 

컴포넌트 스캔 자동 등록

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

수동 등록

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

 

 

 

프로토타입 스코프

- 싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 신스턴스의 스프링 빈을 반환

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

 

 

싱글톤 빈 요청

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

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

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

 

 

프로토타입 빈 요청

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

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

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

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

 

 

정리

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

클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않음

프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 존재

@PreDestroy 같은 종료 메서드가 호출되지 않음

 

 

 

싱글톤 스코프 빈 테스트 및 실행 결과

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.PrototypeTest$SingletonBean@54504ecd
singletonBean2 = hello.core.scope.PrototypeTest$SingletonBean@54504ecd
org.springframework.context.annotation.AnnotationConfigApplicationContext -
Closing SingletonBean.destroy

- 빈 초기화 메서드 실행 

- 같은 인스턴스의 빈을 조회

- 종료 메서드까지 정상 호출 된 것 확인

 

 

프로토타입 스코프 빈 테스트 및 실행 결과

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

find prototypeBean1
PrototypeBean.init
find prototypeBean2
PrototypeBean.init
prototypeBean1 = hello.core.scope.PrototypeTest$PrototypeBean@13d4992d
prototypeBean2 = hello.core.scope.PrototypeTest$PrototypeBean@302f7971
org.springframework.context.annotation.AnnotationConfigApplicationContext -
Closing

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

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

- 싱글톤 빈은 스프링 컨테이너가 관리하기 때문에 스프링 커네팅너가 종료될 때 빈의 종료 메서드가 실행되지만, 프로토타입 빈은 스프링 컨테이너가 생성고 의존관계 주입 그리고 초기화 까지만 관여하고 더이상 관리X

- 따라서 프로토타입 빈은 스프링 컨테이너가 종료될 때 @PreDestroy 같은 종료 메서드가 전혀 실행되지 않음

 

 

프로토타입 빈의 특징 정리

- 스프링 컨테이너에서 요청할 때 마다 새로 생성됨

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

- 종료 메서드 호출X

- 프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 함

- 종료 메서드에 대한 호출도 클라이언트가 직접 해야함

 

 

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

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

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

 

 

스프링 컨테이너에 프로토타입 빈 직접 요청1

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

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

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

결과적으로 프로토타입 빈(x01)의 count는 1이 됨 (count: 0->1)

 

 

스프링 컨테이너에 프로토타입 빈 직접 요청2

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

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

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

결과적으로 프로토타입 빈(x02)의 count는 1이 됨 (count:0->1)

 

 

 

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

- clientBean은 싱글톤이므로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 발생

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

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

 

- clientBean은 프로토타입 빈을 내부 필드에 보관 (정확히는 참조값을 보관)

- 클라이언트A는 clinetBean을 스프링 컨테이너에 요청해서 받음. 싱글톤이므로 항상 clientBean이 반환됨

3. 클라이언트A는 clientBean.logic() 호출

4. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가 count값은 1이 됨

 

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

여기서 중요한 점! clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈임.

주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것. 사용 할 때마다 새로 생성 X

5. 클라이언트B는 clientBean.logic을 호출

6. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가.

원래 count값은 1이었으므로 2로 증가됨

 

 

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

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

 

- 아마 원하는 것이 프로토타입 빈을 주입 시점에만 새로 생성하는 것이 아닌, 사용할 때 마다 새로 생성하는 것일 것임

 

※ 참고: 여러 빈에서 같은 프로토타입 빈을 주입 받으면, 주입 받는 시점에 각각 새로운 프로토타입 빈이 생성됨.

ex) clientA, clientB가 각각 의존관계 주입을 받으면 각각 다른 인스턴스의 프로토타입 빈을 주입 받음

clientA -> prototypeBean@x01

clientB -> prototypebean@x02

 

 

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

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

 

 

스프링 컨테이너에 요청

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

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;
    public int logic() {
      PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
      prototypeBean.addCount();
      int count = prototypeBean.getCount();
      return count;
    }
  }
  @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");
    }
  }
}

핵심 코드

@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, ObjectProvider

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

- 과거에는 ObjectFactory가 있었는데 여기에 편의 기능 추가해서 ObjectProvider가 만들어짐

@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanProvider;

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

- prototypeBeanProvider.getObject()를 통해서 항상 새로운 프로토타입 빈이 생성됨을 확인

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

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

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

 

 

※ 특징

- ObjectFactory: 기능이 단순, 별도의 라이브러리 필요X, 스프링에 의존

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

 

 

JSR-330 Provider

- 마지막 방법은 javax,inject.Provider 라는 JSR-330 자바 표준을 사용하는 방법

- 이 방법을 사용하기 위해서는 javax.inject:javax.inject:1 라이브러리를 gradle에 추가해야 함

 

javax.inject.Provider 참고용 코드

package javax.inject;
public interface Provider<T> {
     T get();
}

//implementation 'javax.inject:javax.inject:1' gradle 추가 필수

@Autowired
private Provider<PrototypeBean> provider;

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

- provider.get() 을 통해서 항상 새로운 프로토타입 빈이 생성됨을 확인 가능

- provider의 get()을 호출하면 내부에서 스프링 컨테이너를 통해 해당 빈을 찾아서 반환 (DL)
- 자바 표준이고, 기능이 단순하므로 단위 테스트를 만들거나 mock 코드를 만들기 쉬움

- Provider는 지금 필요한 DL 정도의 기능만 제공

 

 

※ 특징

- get() 메서드 하나로 기능이 매우 단순

- 별도의 라이브러리 필요

- 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용 가능

 

 

정리

- 프로토타입 빈은 언제 사용?

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

- 그런데 실무에서 웹 애플리케이션을 개발해보면, 싱글톤 빈으로 대부분의 문제를 해결 가능하기 때문에

프로토타입 빈을 직접접으로 사용하는 일은 적음

- ObjectProvider, JSR330 Provider 등은 프로토타입 뿐만 아니라 DL이 필요한 경우 언제든 사용 가능

 

 

※ 참고: 스프링이 제공하는 메서드에 @Lookup 애노테이션을 사용하는 방법도 있지만, 이전 방법들로 충분하고 고려해야할 내용이 많음

 

 

웹 스코프

- 싱글톤은 스프링 컨테이너의 시작과 끝까지 함께하는 매우 긴 스코프

- 프로토타입은 생성과 의존관계 주입, 그리고 초기화까지만 진행하는 특별한 스코프

 

 

웹 스코프의 특징

- 웹 스코프는 웹 환경에서만 동작

- 웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리

- 따라서 종료 메서드 호출됨

 

 

웹 스코프 종류

- request: HTTP 요청 하나가 들어오고 나갈 때 까지 유지되는 스코프, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리됨

- session: HTTP Session과 동일한 생명주기를 가지는 스코프

- application: 서블릿 컨텍스트(ServletContext)와 동일한 생명주기를 가지는 스코프

- websocket: 웹 소켓과 동일한 생명주기를 가지는 스코프

 

 

request 스코프는 HTTP 요청이 있어야 하지만, spring 실행시점에는 HTTP 요청이 존재할 수 없기 때문에 오류 발생

-> 이전에 배운 Provider를 통해 spring 실행 후에 HTTP 요청을 받을 수 있도록 지연시킴

-> 좀더 간결한 방법

-> 프록시 사용 @Scope(value="request", proxyMode=ScopedProxyMode.TARGET_CLASS)

-> 가짜 프록시 클래스를 만들어두고 HTTP request와 상관없이 가짜 프록시 클래스를 다른 빈에 미리 주입 가능

 

 

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

- 가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있음

- 클라이언트가 myLogger.logic()을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것

- 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic()을 호출

- 가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지 모르게 동일하게 사용 가능(다형성)

 

 

동작 정리

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

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

- 가짜 프록시 객체는 실제 request scope와 관계 X, 그냥 가짜이고, 내부에 단순한 위임 로직만 있고, 싱글톤 처럼 동작

 

 

특징 정리

- 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope를 사용 가능

- 사실 Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 점 (진짜 HTTP 요청이 들어올 때 까지 버팀, 요청오면 그제서야 진짜 메서드를 호출해줌)

- 단지 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체 가능, 이것이 다형성과 DI 컨테이너가 가진 장점

- 꼭 웹 스코프가 아니어도 프록시 사용 가능

 

 

주의점

- 마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 떄문에 결국 주의해서 사용해야 함

- 이런 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용해야함. 무분별히 사용하면 유지보수 힘듬

 

 

 

출처 : 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