빈 스코프

인프런 스프링 핵심 원리 기본편을 정리한 글입니다.

 

 

스코프 : 빈이 존재할 수 있는 범위

 

스프링 지원 스코프

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

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

웹 관련

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

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

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

 

 

싱글톤 스코프

스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환

SingletonBean.init
singletonBean1 = ~.SingletonTest$SingletonBean@12bcd0c0
singletonBean2 = ~.SingletonTest$SingletonBean@12bcd0c0
SingletonBean.destory

 

 

 

프로토타입 스코프

스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환

프로토타입 스코프의 빈을 스프링 컨테이너에 요청 → 스프링 컨테이너는 프로토타입 빈 생성, 필요한 의존관계 주입, 초기화

이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리 X (프로토타입 빈을 받은 클라이언트가 관리) → 종료 메서드(@PreDestory) 자동 호출 X

find prototypeBean1
SingletonBean.init
find prototypeBean2
SingletonBean.init
prototypeBean1 = com.sunny.item_service.scope.PrototypeTest$PrototypeBean@12bcd0c0
prototypeBean2 = com.sunny.item_service.scope.PrototypeTest$PrototypeBean@4879f0f2

 

 

싱글톤 빈과 프토타입 빈을 함께

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

  @Scope("singleton")
  static class ClientBean {
    private final PrototypeBean prototypeBean; //생성 시점에 주입

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

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

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

싱글톤 빈은 생성 시점에만 의존관계 주입을 받기 때문에,

프로토타입 빈이 새로 생성되기는 하지만 싱글톤 빈과 함께 계속 유지되는 것이 문제

프로토타입 빈을 주입 시점에만 새로 생성하는게 아니라 사용할 때마다 새로 생성해서 사용하고 싶을 땐,

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

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

  @Scope("singleton")
  static class ClientBean {
    @Autowired
    private ObjectProvider<PrototypeBean> prototypeBeanProvider;

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

  @Scope("prototype")
  static class PrototypeBean {...}
}

2. ObjectFactory, ObjectProvider (기능 차이)

build.gradle 추가
dependencies {
  implementation 'jakarta.inject:jakarta.inject-api:2.0.1'
}

import jakarta.inject.Provider;

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

  @Scope("singleton")
  static class ClientBean {
    @Autowired
    private Provider<PrototypeBean> prototypeBeanProvider;

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

  @Scope("prototype")
  static class PrototypeBean { ... }
}

3. JSR-330 Provider

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

JSR-330 Provider : 코드를 스프링이 아닌 다른 컨테이너에서도 사용할 수 있어야 한다면 사용
ObjectProvider : DL을 위한 편의 기능을 많이 제공, 스프링 외 별도의 의존관계 추가가 필요없기 때문에 편리
특별히 다른 컨테이너를 사용할 일이 없다면, 스프링이 제공하는 기능을 사용하자! (ObjectProvider)

 

 

매번 사용할 때마다 의존관계 주입이 완료된 새로운 객체가 필요할 때 프로토타입 빈 사용
실무에서는 싱글톤 빈으로 대부분의 문제 해결 가능

 

 

 

웹 스코프

웹 환경에서만 동작, 스프링이 해당 스코프의 종료시점까지 관리 → 종료 메서드 호출

• request : HTTP 요청 하나가 들어오고 나갈 때까지 유지되는 스코프, 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리된다
• session : HTTP Session과 동일한 생명주기를 가지는 스코프
• application : 서블릿 컨텍스트(ServletContext)와 동일한 생명주기를 가지는 스코프
• websocket : 웹 소켓과 동일한 생명주기를 가지는 스코프

build.gradle 추가
dependencies {
  //web 라이브러리 추가
  implementation 'org.springframework.boot:spring-boot-starter-web'
}

@Component
@Scope(value = "request") //빈 스코프: HTTP 요청당 하나씩 생성, HTTP 요청이 끝나는 시점에 종료
public class MyLogger {
  private String uuid;
  private String requestURL;

  //빈이 생성되는 시점에는 requestURL를 알 수 없으므로 외부에서 setter로 입력받음
  public void setRequestURL(String requestURL) {
    this.requestURL = requestURL;
  }

  public void log(String message) {
    System.out.println("[" + uuid + "][" + requestURL + "] " + message);
  }

  @PostConstruct
  public void init() {
    uuid = UUID.randomUUID().toString(); //HTTP 요청당 하나씩 생성
    System.out.println("[" + uuid + "] request scope bean create: " + this);
  }

  @PreDestroy
  public void close() {
    System.out.println("[" + uuid + "] request scope bean close: " + this);
  }
}

@Controller
@RequiredArgsConstructor
public class LogDemoController {
  private final LogDemoService logDemoService;
  private final MyLogger myLogger;

  @RequestMapping("log-demo")
  @ResponseBody
  public String logDemo(HttpServletRequest request) {
    String requestURL = request.getRequestURL().toString();
    myLogger.setRequestURL(requestURL);

    myLogger.log("controller test");
    logDemoService.logic("testId");

    return "ok";
  }
}

@Service
@RequiredArgsConstructor
public class LogDemoService {
  private final MyLogger myLogger;
  
  public void logic(String id) {
    myLogger.log("service id = " + id);
  }
}

ERROR!
Caused by: org.springframework.beans.factory.support.ScopeNotActiveException: Error creating bean with name 'myLogger': Scope 'request' is not active for the current thread; consider defining a scoped proxy for this bean if you intend to refer to it from a singleton

request scope는 하나의 요청이 들어오고 나갈 때까지 유지되는 스코프인데 들어온 요청이 없어서 발생한 에러

LogDemoController, LogDemoService 코드 변경
private final MyLogger myLogger; → private final ObjectProvider<MyLogger> myLoggerProvider; 변경
MyLogger myLogger = myLoggerProvider.getObject(); 추가

1. Provider (ObjectProvider) 사용

@Scope의 proxyMode 추가
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {}

2. 프록시 방식 : MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관없이 가짜 프록시 클래스를 다른 빈에 미리 주입

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

마치 싱글톤을 사용하는 것 같지만 다르게 동작하므로 주의해서 사용! 무분별한 사용 금지!

[4cd29588-ab10-42b9-990c-4524da84f3bd] request scope bean create: ~.MyLogger@6d1ab145 [4cd29588-ab10-42b9-990c-4524da84f3bd][http://localhost:8080/log-demo] controller test
[4cd29588-ab10-42b9-990c-4524da84f3bd][http://localhost:8080/log-demo] service id = testId
[4cd29588-ab10-42b9-990c-4524da84f3bd] request scope bean close: ~.MyLogger@6d1ab145