[Spring] 빈 스코프(Scope)와 ObjectProvider, proxyMode

 

 

 

 

 

 

빈 스코프

빈 스코프는 빈이 존재할 수 있는 범위를 뜻합니다.

 

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

 

 

• 싱글톤(singleton) : 기본 스코프, 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넒은 범위의 스코프입니다.
• 프로토타입(prototype) : 스프링 컨테이너가 프로토타입 빈의 생성과, 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짦은 범위의 스코프입니다. (초기화 메서드까지만 불러주고 더는 관리하지 않기에 종료 메서드는 호출되지 않습니다.)
• 웹 관련 스코프 :
  • request : 웹 요청이 들어오고 나서 나갈때 까지 유지되는 스코프입니다.
  • session : 웹 세션이 생성되고 종료될 때 까지 유지되는 스코프입니다.
  • application : 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프입니다.

 

 

 

 

 

 

빈 스코프는 다음과 같이 지정할 수 있습니다.

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

 

 

 

 

 

 

 

 

 

 

 

 

 

프로토타입 스코프

싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환해줍니다.

 

반면 프로토타입 스코프를 사용하는 빈을 조회(getBean() 등)하면, 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환합니다.

반환 이후 스프링 컨테이너는 생성된 프로토타입 빈을 관리하지 않으므로, @PreDestroy 같은 종료 메서드가 호출되지 않습니다.

 

싱글톤으로 유지하고 싶지는 않으나, 의존관계 주입과 초기화 메서드 호출이 필요한 경우에 사용합니다.

 

 

 

 

 

 

 

 

 

프로토타입 스코프와 싱글톤 빈을 함께 사용할 시 주의점

프로토타입 빈을 요청하면 스프링 컨테이너는 항상 새로운 객체를 생성해서 반환해줍니다.

그러나 싱글톤 빈과 함께 사용할 때는 의도한 대로 동작하지 않기 때문에 주의할 점이 있습니다.

 

 

 

프로토타입 빈을 주입받아 사용하는 싱글톤 빈이 있다고 생각해보겠습니다. 

아래와 같은 상황입니다.

 

어떤 사용하자 해당 싱글톤 빈을 호출하여, 내부의 프로토타입 빈의 필드를 0에서 1로 변경했다고 가정하겠습니다.

 

이 상태에서 또다른 사용자가 싱글톤 빈을 호출하여 내부의 프로토타입 빈의 상태를 조회한다고 하면, 0이 아니라 이전 사용자에 의해 변경된 1이 조회됩니다.

 

 

우리가 의도한 것은 조회할 때마다 새로운 프로토타입 빈이 생성되어 그것을 사용하는 것이었을겁니다.

그러나 싱글톤 빈의 생성 시점에 프로토타입 빈을 하나 주입받은 후, 그것을 여러 사용자가 공유하므로 프로토타입 빈이 계속 생성되지 않는 것입니다.

 

 

그럼 이 문제를 어떻게 해결할 수 있을까요?

우리가 원하는 것은 싱글톤 빈은 싱글톤으로, 프로토타입 빈은 사용할때마다 새로 생성되게 하는 것입니다.

 

ObjectProvider를 사용하여 해결할 수 있습니다.

 

 

 

 

 

 

 

 

 

 

 

 

ObjectProvider

 

예시 코드를 통해 설명하겠습니다.

@Scope("singleton")
public class ClientBean {

    @Autowired
    private ObjectProvider<PrototypeBean> prototypeBeanProvider;
    
    public int logic() {
    	PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
        prototypeBean.addCount();
        int count = prototypeBean.getCount();
        return count;
    }
    
    @Scope("prototype")
    static class PrototypeBean {
    	private int count;
        
        public void addCount() {
        	this.count ++;
        }
        public int getCount() {
        	return this.count;
        }
    
    }
}

 

실행해보면 prototypeBeanProvider의 getObject()를 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있습니다.

 

ObjcetProvider의 getObjcet()를 호출하면, 스프링 컨테이너를 통해 해당 타입의 빈을 찾아서 반환해줍니다.

 

즉 ObjectProvider는 DL(Dependency Lookup)의 기능을 제공해주는 것입니다.

 

그러나 ObjectProvider는 스프링에 의존적이라는 단점이 있습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

JSR-330 Provider

자바 표준을 사용하는 방법이지만, 이를 사용하려면 라이브러리를 추가해주어야 한다는 단점이 있습니다. 

implementation 'javax.inject:javax.inject:1'

@Scope("singleton")
public class ClientBean {

    @Autowired
    private Provider<PrototypeBean> prototypeBeanProvider;
    
    public int logic() {
    	PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
        prototypeBean.addCount();
        int count = prototypeBean.getCount();
        return count;
    }
    
    @Scope("prototype")
    static class PrototypeBean {
    	private int count;
        
        public void addCount() {
        	this.count ++;
        }
        public int getCount() {
        	return this.count;
        }
    
    }
}

사용 방법은 간단합니다.

(참고로 Provider는 lazy 혹은 optional하게 가져올 때, circular dependencies(순환 참조가 발생할 때) 등의 경우 사용하면 좋습니다.) 

 

 

 

 

 

 

 

 

 

 

 

 

 

ProxyMode

Provider 대신 ProxyMode를 사용하여 이를 해결할 수도 있습니다.

 

proxyMode는 말 그대로 프록시를 이용하여 해결하는데, 해당 프록시 객체의 메서드를 호출할 때 스프링 컨테이너에서 해당 빈을 조회하여(getBean()) 조회된 빈에 로직을 위임하는 방식입니다.

 

예시 코드를 살펴보겠습니다.

@Scope("singleton")
public class ClientBean {

    @Autowired
    private PrototypeBean prototypeBean;
    
    public int logic() {
        prototypeBean.addCount(); // (1) 새로운 PrototypeBean 생성됨
        int count = prototypeBean.getCount(); // (2) 새로운 PrototypeBean 생성됨
        return count; // 결국 0이 반환
    }
    
    @Scope(value = "prototype", proxyMode = ScopedProxyMode.TARGET_CLASS)
    static class PrototypeBean {
    	private int count;
        
        public void addCount() {
            this.count ++;
        }
        public int getCount() {
            return this.count;
        }
    }
}

 

(1)에서 prototypeBean을 사용하며, 이때 해당 빈은 프로토타입 스코프를 가지기 때문에 새로 생성됩니다.

(2)에서 마찬가지로 prototypeBean을 사용하는데, 이때에도 (1)에서 생성된 prototypeBean이 아닌, 새로운 요청이므로 새로운 인스턴스를 생성하여 반환합니다.

 

이로 인해 결국 반환되는 값은 0이 됩니다.

 

이를 해결하기 위해서는 한번의 요청으로 로직을 모두 수행하는 방법 밖에 없습니다.

@Scope("singleton")
public class ClientBean {

    @Autowired
    private PrototypeBean prototypeBean;
    
    public int logic() {
        int count = prototypeBean.addAndGet();
        return count;
    }
    
    @Scope(value = "prototype", proxyMode = ScopedProxyMode.TARGET_CLASS)
    static class PrototypeBean {
    	private int count;
        
        public void addCount() {
            this.count ++;
        }
        
        public int getCount() {
            return this.count;
        }
        
        public int addAndGet() {
            return ++this.count;
        }
    }
}

 

 

proxyMode는 적용 대상이 클래스라면 TARGET_CLASS를, 적용 대상이 인터페이스라면 INTERFACES 를 선택하시면 됩니다.

 

이렇게 하면 TARGET_CLASS는 CGLIB를 통해, INTERFACES는 jdk 동적 프록시를 통해 프록시 객체를 만들어서 주입하는 방법으로 해결합니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

웹 스코프

• 웹 환경에서만 동작합니다.
• 스프링이 해당 스코프의 종료시점까지 관리하므로 종료 메서드가 호출됩니다.

 

 

종류

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

 

 

 

request 스코프는 http 요청 당 로그를 남긴다던지 등의 기능에 사용하실 수 있습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

📔 Reference

스프링 핵심 원리 - 기본편 - 인프런 | 강의

 

[Spring] Spring의 Scope와 ProxyMode 알아보기