Bean Scope

황상익·2024년 4월 11일

Spring 기본

목록 보기
10/10

빈 스코프란??

싱글톤 : 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프
프로토타입 : 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여, 더는 관여 X

웹 관련 스코프

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

컴포넌트 스캔 자동 등록

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

수동 등록

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

프로토타입 스코프

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


1. 싱글톤 스코프의 빈을 스프링 컨테이너에 요청
2. 스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환
3. 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈을 반환


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


3. 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환
4. 스프링 컨테이너에 같은 요청이 오면 새로운 프로토타입 빈을 생성해서 반환

핵심은 스프링컨테이너는 프로토타입 빈을 생성하고, 의존관계주입, 초기화 까지만 관여
이후에는 관여 X
프로토타입 빈을 관리할 책임은 클라이언트에게 있음.
@PreDestory 같은 메서드 호출 X

싱글톤 스코프 빈 Test

public class SingletonTest {

    @Test
    void singleton(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SingletonBeanTest.class);
        SingletonBeanTest bean = ac.getBean(SingletonBeanTest.class);
        System.out.println("bean = " + bean);
        SingletonBeanTest bean1 = ac.getBean(SingletonBeanTest.class);
        System.out.println("bean1 = " + bean1);
        Assertions.assertThat(bean).isEqualTo(bean1);

        ac.close();

    }

    @Scope("singleton")
   static class SingletonBeanTest {
        @PostConstruct
        public void init(){
            System.out.println("SingleTon init");
        }

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

빈 초기화 메서드 실행, 같은 인스턴스의 빈을 조회, 종료 메서드 까지 정상 호출

프로토타입 스코프 빈 Test

public class PrototypeTest {

    @Test
    void protoType(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ProtoTypeBean.class);
        System.out.println("findBean1");
        ProtoTypeBean bean = ac.getBean(ProtoTypeBean.class);
        System.out.println("findBean2");
        ProtoTypeBean bean1 = ac.getBean(ProtoTypeBean.class);
        System.out.println("bean = " + bean);
        System.out.println("bean1 = " + bean1);
        Assertions.assertThat(bean).isNotSameAs(bean1);
        ac.close();
    }

    @Test
    void protoTypeFind(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ProtoTypeBean.class);
        ProtoTypeBean bean = ac.getBean(ProtoTypeBean.class);
        bean.addCnt();
        Assertions.assertThat(bean.getCnt()).isEqualTo(1);
    }

    @Scope("prototype")
    static class ProtoTypeBean {

        private int cnt = 0;

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

        @PreDestroy
        public void destory(){
            System.out.println("파괴");
        }

        public void addCnt(){
            cnt ++;
        }

        public int getCnt(){
            return cnt;
        }
    }
}

싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드 실행, 프로토타입 스코피 빈의 경우 스프링 컨테이너에서 빈을 조회할 때 생성, 초기화 메서드 실행
빈을 초기화 할때 마다 완전히 다른 빈 생성, 초기화도 2번 실행
싱글톤의 경우 스프링 컨테이너가 종료될 때 빈의 종료 메서드 실행, 프로토타입은 스프링 컨테이너가 생성과 의존관계 주입 그리고 초기화 까지만 관여.

프로토타입 빈의 특징

스프링 컨테이너에 요청할 때 마다 새로 생성
프로토타입 빈의 생성, 의존관계 주입, 초기화 까지만 관여
종료 메서드 호출 X
클라이언트가 직접 호출하고 빈 관리


스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환, 해당 빈의 cnt = 0
클라이언트는 조회한 프로토타입 빈에 addCtn를 호출하면서 cnt + 1
따라서 프로토타입 빈의 cnt = 1


스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환, 해당 빈의 cnt = 0
클라이언트는 조회한 프로토타입 빈에 addCtn를 호출하면서 cnt + 1
따라서 프로토타입 빈의 cnt = 1

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


1. clientBean은 싱글톤이므로, 스프링 컨테이너 생성 시점에 함께 생성, 의존관계 주입도 발생
2. clientBean은 의존관계 자동 주입 사용, 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청
3. 스프링 컨테이너는 프로토타입 빈을 생성, clientBean에 반환, 프로토타입 빈의 cnt 필드 값은 0
4. clientBean은 프로토타입 빈을 내부 필드에 보관 (참조값 보관)


clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글통이므로 항상 같은 clientBean 반환
클라이언 A는 clientBean.logic 호출
clientBean은 prototypeBean의 addCnt를 호출해서 프로토타입 빈의 cnt 값 증가
cnt --> 1


클라이언트 B는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean이 반환
clientBean이 내부에 갖고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈.
주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성된 것, 사용 할때마다 새로 생성 되는 것 X

클라이언트 B는 clientBean.logic() 을 호출한다.
clientBean 은 prototypeBean의 addCount() 를 호출해서 프로토타입 빈의 count를 증가한다.
원래 count 값이 1이었으므로 2가 된다

public class SingletonWithPrototypeTest1 {

    @Test
    void singleWithPrototype(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ClinetBean.class, PrototypeBean.class);
        ClinetBean bean = ac.getBean(ClinetBean.class);
        int cnt1 = bean.logic();
        assertThat(cnt1).isEqualTo(1);

        ClinetBean bean2 = ac.getBean(ClinetBean.class);
        int cnt2 = bean2.logic();
        assertThat(cnt2).isEqualTo(2);

    }

    static class ClinetBean {
        private final PrototypeBean prototypeBean;

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

        public int logic(){
            prototypeBean.addCnt();
            int cnt = prototypeBean.getCnt();
            return cnt;
        }
    }

    static class PrototypeBean {
        private int cnt= 0;

        public void addCnt(){
            cnt++;
        }

        public int getCnt() {
            return cnt;
        }

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

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

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

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

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

public class ProviderTest {
    @Test
    void providerTest(){
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);
    }

    static class ClientBean {
        @Autowired
        //private ApplicationContext ac;
        private ObjectProvider<PrototypeBean> prototypeBeans;

        public int logic(){
            PrototypeBean bean = prototypeBeans.getObject();
            bean.addCnt();
            int cnt = bean.getCnt();
            return cnt;
        }
    }

    static class PrototypeBean {
        private int cnt = 0;

        public void addCnt(){
            cnt++;
        }

        public int getCnt(){
            return cnt;
        }

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

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

실행 -> ac.getBean()을 통해서 항상 새로운 프로토타입 빈 생성
의존관계를 외부에서 주입X , 직접 필요한 의존관계를 찾는 것을 DL (의존관계 조회)
스프링 애플리케이션 컨텍스트에 전체를 주입, 스프링 컨테이너에 종속적 code, 단위 test 어려움
지금은 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 딱, DL 정도의 기능만 제공

ObjectFactory, ObjectProvider

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

@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanProvider;

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

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

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

JSR-330 Provider

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

그렇다면 프로토타입 빈은 언제 사용???
실무에서는 사용 가능성 희박

웹 스코프

웹 환경에서만 작동
웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프 종료시점 까지 관리, 따라서 종료 메서드 호출

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

request scope 예제
build.gradle에 추가

implementation 'org.springframework.boot:spring-boot-starter-web'

참고: spring-boot-starter-web 라이브러리를 추가하면 스프링 부트는 내장 톰켓 서버를 활용해서 웹서버와 스프링을 함께 실행시킨다.
참고: 스프링 부트는 웹 라이브러리가 없으면 우리가 지금까지 AnnotationConfigApplicationContext 을 기반으로 애플리케이션을 구동한다. 웹 라이브러리가
추가되면 웹과 관련된 추가 설정과 환경들이 필요하므로
AnnotationConfigServletWebServerApplicationContext 를 기반으로 애플리케이션을 구동한다.

request scope 예제 개발
동시에 여러 HTTP 요청이 오면 어떤 로그인지 구분 하기 어려움
기대하는 공통 포멧 : : [UUID][requestURL] {message}
UUID를 사용해서 HTTP 구분

@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {
    private String uuid;
    private String requestURL;

    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();
        System.out.println("[" + uuid + "] request scope bean create: " + this);
    }

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

    }
}

@Scope(value = "request")를 사용해서 request 스코프로 지정, 빈은 HTTP 요청 당 하나씩 새성, 요청이 끝나는 시점에 소멸
@PostConstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장, 빈은 HTTP 요청당 하나씩 생성, uuid를 저장, 다른 HTTP 요청과 구분

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

이 빈은 실제 고객의 요청이 와야 생성 가능

Provider를 사용

@Controller
@RequiredArgsConstructor
public class LogDemoController {
 private final LogDemoService logDemoService;
 private final ObjectProvider<MyLogger> myLoggerProvider;
 @RequestMapping("log-demo")
 @ResponseBody
 public String logDemo(HttpServletRequest request) {
 String requestURL = request.getRequestURL().toString();
 MyLogger myLogger = myLoggerProvider.getObject();
 myLogger.setRequestURL(requestURL);
 myLogger.log("controller test");
 logDemoService.logic("testId");
 return "OK";
 }
}
@Service
@RequiredArgsConstructor
public class LogDemoService {
 private final ObjectProvider<MyLogger> myLoggerProvider;
 public void logic(String id) {
 MyLogger myLogger = myLoggerProvider.getObject();
 myLogger.log("service id = " + id);
 }
}

ObjectProvider 덕분에 ObjectProvider.getObject()를 호출하는 시점까지 request scope 생성을 지연
ObjectProvider.getObject()를 호출 시점에는 HTTP 요청이 진행, request scope 빈의 생성이 정상 처리

스코프와 프록시

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

proxyMode = ScopedProxyMode.TARGET_CLASS
적용 대상이 인터페아스면 -> INTERFACE 선택
이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 관계 없이 가짜 프록시 클래스를 다른 빈에 미리 주입

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

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

        logger.log("controller test");
        logDemoService.logic("testID");
        return "ok";
    }
}
@Service
@RequiredArgsConstructor
public class LogDemoService {
    private final MyLogger logger;

    public void logic(String id){
        logger.log("service id :" + id);
    }
}

웹 스코프와 프록시 동작 원리

System.out.println("myLogger = " + myLogger.getClass());

출력 결과

myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$b68b726d

CGLIB라는 라이브러리로 내 클래스를 상속 받는 가짜 프록시 객체를 만들어서 주입
@Scope의 proxyMode = ScopedProxyMode.TARGET_CLASS), CGLIB라는 바이트코드를 조작하는 라이브러리를 사용해서 MyLogger를 상속받은 가짜 프록시 객체를 생성

결과 확인시, 순수한 MyLogger 클래스가 아니라, 가짜 프록시 값이 대신 등록
그리고 스프링 컨테이너에 myLogger라는 이름으로 진짜 대신 가짜 프록시 객체를 등록
ac.getBean("myLogger", MyLogger.class) -> 프록시 객체 조회


가짜 프록시 객체는 요청이 오면 그때 내부에서 진짜 빈을 요청하는 위임 로직 들어있다.
가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있다.
클라이언트가 myLogger.logic을 호출하면 사실은 가짜 프록시 객체의 메서드 호출
가짜 프록시 객체는 request scope의 진짜 myLogger.logic을 호출
가짜 프록시 객체는 원본 클래스를 상속 받아서 형성, 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지 모르게 사용

동작 원리

CGLIB라는 라이브러리로 내 클래스를 상속받은 가짜 프록시 객체 만들어서 주입
가짜 프록시 객체는 실제 요청이 오면 내부에서 실제 빈을 요청하는 위임 로직

특정 정리

프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯 편라히게 request scope를 사용
사실 provider를 사용하던 프록시를 사요하던 핵심은 진짜 객체 조회를 필요한 시점까지 지연처리

주의점

마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 결국 주의해서 사용해야 한다.
이런 특별한 scope는 꼭 필요한 곳에만 최소화해서 사용하자, 무분별하게 사용하면 유지보수하기
어려워진다

profile
개발자를 향해 가는 중입니다~! 항상 겸손

0개의 댓글