빈 스코프

땡글이·2023년 1월 16일
빈빈 스코프스프링스프링부트
0

Spring Framework

목록 보기
4/8

빈 등록을 할 때, 별다른 설정이 없었다면 스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어서 스프링 컨테이너가 종료될 때까지 유지된다. 그것들은 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다. 스코프는 번역 그대로 빈이 존재할 수 있는 범위를 뜻한다.

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

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

프로토타입 스코프

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

아래 그림은 싱글톤 스코프의 빈 동작방식을 나타낸다.

  • 싱글톤 스코프의 빈은 스프링 컨테이너에 등록되어 있으면, 같은 객체 인스턴스의 스프링 빈을 반환한다.

아래 그림은 프로토타입 스코프의 빈의 동작 방식을 나타낸다.

1.프로토타입 스코프의 빈을 스프링 컨테이너에 요청한다.
2.스프링 컨테이너는 이 시점에 프로토타입 빈을 생성하고, 필요한 의존관계를 주입한다.
3.스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환한다.
4.이후에 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환한다.


여기서 핵심은 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다는 것이다. 클라이언트에 빈을 반환하고, 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않는다.
프로토타입 빈을 관리할 책임은 프로토타입 빈을 받은 클라이언트에 있다. 그래서 @PreDestroy 같은 종료
메서드가 호출되지 않는다.

프로토타입 빈의 특징 정리

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

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

싱글톤 빈과 프로토타입 빈을 함께 사용하는 예제 코드

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

위의 그림과 코드를 확인해보자. 위의 그림은 clientBean 이라는 싱글톤 빈에 PrototypeBean 이라는 프로토타입 빈을 주입받아 사용하는 모습을 나타낸다.

앞서 봤듯이 프로토타입 빈은 요청마다 즉, 호출될 때마다 프로토타입 빈 객체가 생성되었다가 사라진다. 하지만, 위처럼 싱글톤 빈과 함께 사용한다면 얘기가 달라진다. 만약, 예시 그림처럼 프로토타입 빈에서 필드 값(count)를 바꾸는 로직이 있다고 가정한다면 싱글톤 빈과 같이 쓸 경우에는 상태가 유지되어 다음 요청이 들어오게 되면 count가 2로 증가하게 된다.

  • 원래라면, addCount() 함수를 통해 count를 증가시켜도 항상 1이여야 한다. (매번 객체가 생성되니까)

이렇게 되는 건 왜일까?

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

단, 여러 빈에서 프로토타입 빈을 주입받는다면 주입 시에 새로운 프로토타입 빈이 생성되는 것이기에 각각의 싱글톤 빈에 주입되는 프로토타입 빈 객체들은 서로 다른 객체들이다.

  • clientA ⇒ prototypeBean@x01
  • clientB ⇒ prototypeBean@x02

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

이제 싱글톤 빈과 함께 사용해도 프로토타입 스코프의 빈의 특성("사용할 때마다 새롭게 생성되는 특징")을 유지하는 방법에 대해 알아보자.

스프링 컨테이너에 요청

	...

	static class ClientBean {
          @Autowired
          private ApplicationContext ac;
          public int logic() {
              PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
              prototypeBean.addCount();
              int count = prototypeBean.getCount();
              return count;
		}
    }
 
 	...

가장 간단한 방법이다. 프로토타입 빈을 사용할 때마다 스프링 컨테이너에 요청하는 방식이다. 이렇게 의존성을 주입받는 방식이 아닌 직접 필요한 의존성을 주입하는 것을 DL(Dependency Lookup) 이라고 한다.

Q. DL(Dependency Lookup) 이란 ?
저장소에 있는 Bean에 접근하기 위해 컨테이너가 제공하는 API를 이용하여 Bean을 lookup하는 방식이다.

하지만 이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다. 또한 코드가 지저분해지고 좋은 방식은 아니다.

지금 필요한 기능은 지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 딱! DL 정도의 기능만 제공하는 무언가가 필요하다.

ObjectFactory, ObjectProvider 클래스

지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하는 것이 바로 ObjectProvider 이다. 참고로 과거에는 ObjectFactory 가 있었는데, 여기에 편의 기능을 추가해서 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.getObject() 함수는 스프링 컨테이너에서 지정한 클래스 타입의 빈을 조회하는 기능이다. (DL)

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

JSR-330 Provider

마지막 방법은 javax.inject.Provider 라는 JSR-330 자바 표준을 사용하는 방법이다. javax.inject:javax.inject:1 라이브러리를 gradle에 추가해야 한다.

해당 방법도 provider.get() 함수를 통해, 항상 새로운 프로토타입 빈이 생성되는 것을 알 수 있고, 스프링 컨테이너에서 빈을 조회해 반환해주는 것을 알 수 있다.

웹 스코프

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

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

스프링 부트는 웹 라이브러리가 없으면 우리가 지금까지 학습한 AnnotationConfigApplicationContext 을 기반으로 애플리케이션을 구동한다. 웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요하므로, AnnotationConfigServletWebServerApplicationContext 를 기반으로 애플리케이션을 구동한다.

Request 스코프


Request 스코프는 클라이언트의 요청이 있을 경우에 생성되는 스코프의 빈을 의미한다. 즉, 위의 그림처럼 클라이언트의 요청마다 다른 request 스코프의 빈을 주입받아 사용하게 되는 것이다.

@Component
@Scope(value = "request")
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 close() {
    	System.out.println("[" + uuid + "] request scope bean close:" + this);
    }
}
  • @Scope(value = "request") 를 사용해서 request 스코프로 지정했다. 이제 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.
  • 이 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 사용해서 uuid를 생성해서 저장해둔다. 이 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.
  • 이 빈이 소멸되는 시점에 @PreDestroy 를 사용해서 종료 메시지를 남긴다.
  • requestURL 은 이 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력 받는다.

requestURL 을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다.

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

위와 같은 오류메시지가 뜨면서 실패하게 된다. 이 말인즉슨 @Service 어노테이션으로 인해 자동으로 싱글톤 빈으로 등록된 LogDemoService 객체에서 MyLogger 객체를 주입 받을 때, MyLogger 객체의 스코프가 request 이므로 아직 요청이 없는 상태에서는 스프링 컨테이너에 스프링 빈으로 등록되지 않았기에 실패하는 것이다.

이제 여기서 아까 배운 Provider 를 활용해 문제를 해결할 수 있다.

@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 를 추가해주자.

  • 적용 대상이 인터페이스가 아닌 클래스면 TARGET_CLASS 를 선택
  • 적용 대상이 인터페이스면 INTERFACES 를 선택

이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.

MyLogger 객체를 주입받는 클래스에서는 Provider 사용 전으로 돌려두자.

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

코드를 잘 보면 LogDemoService 는 Provider 사용 전과 완전히 동일하다. 어떻게 정상작동할 수 있었던 것인지 원리를 파악해보자.

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

myLogger 객체를 불러와 클래스를 출력해보자.

System.out.println("myLogger = " + myLogger.getClass());
myLogger = class hello.core.common.MyLogger$$EnhancerBySpringCGLIB$$b68b726d

출력해보니, @Configuration 어노테이션에서 사용되는 CGLIB 라이브러리가 사용되는 것을 확인할 수 있다.

@Configuration 어노테이션과 바이트조작 라이브러리 포스팅을 참고해주세요.

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

  • @Scope 의 proxyMode = ScopedProxyMode.TARGET_CLASS) 를 설정하면 스프링 컨테이너는 CGLIB 라는 바이트코드를 조작하는 라이브러리를 사용해서, MyLogger를 상속받은 가짜 프록시 객체를 생성한다.
  • 결과를 확인해보면 우리가 등록한 순수한 MyLogger 클래스가 아니라 MyLogger$$EnhancerBySpringCGLIB 이라는 클래스로 만들어진 객체가 대신 등록된 것을 확인할 수 있다.
  • ac.getBean("myLogger", MyLogger.class) 로 조회해도 프록시 객체가 조회되는 것을 확인할 수 있다.

동작 방식은 아래의 그림과 같다.

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

  • 가짜 프록시 객체는 내부에 진짜 myLogger를 찾는 방법을 알고 있다.
  • 클라이언트가 myLogger.logic() 을 호출하면 사실은 가짜 프록시 객체의 메서드를 호출한 것이다. 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic() 를 호출한다.
  • 가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지도 모르게, 동일하게 사용할 수 있다(다형성)

정리

프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope를 사용할 수 있다. 사실 Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 점이다.

단지 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다. 이것이 바로 다형성과 DI 컨테이너가 가진 큰 강점이다. 꼭 웹 스코프가 아니어도 프록시는 사용할 수 있다.

하지만, 이런 scope는 주의해서 사용하고, 최소로 사용해야 한다. 특별한 빈이다 보니, 추후에 유지보수하기 힘들어질 수 있다.

Reference

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
https://m.blog.naver.com/PostView.naver?isHttpsRedirect=true&blogId=wwwkang8&logNo=220985550237

profile
땡글이
꾸벅 🙇‍♂️ 매일매일 한발씩 나아가자잇!
이전 포스트

빈 생명주기 콜백

다음 포스트

동시성 문제와 ThreadLocal

0개의 댓글