[Spring/기본편] 빈 스코프

 

빈 스코프

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

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

컴포넌트 스캔 자동 등록

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

 

수동 등록

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

 

 

프로토타입 스코프

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

항상 새로운 인스턴스를 생성해서 반환한다.

싱글톤은 같은 인스턴스를 반환했었다.

 

 

 

public class PrototypeTest {

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

• 스프링 컨테이너에 요청할 때 마다 새로 생성된 것을 볼 수 있다.
•  ac.close()  해도 종료 메서드가 호출되지 않는다. (초기화 까지만 관여)

특징

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

 

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

• 프로토타입 빈 직접 요청

 

 

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

 

 

 

 

 

 

프로토타입 스코프 - 싱글톤 빈과 함께 사용시 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;
}
}

•  ac.getBean()  을 통해서 항상 새로운 프로토타입 빈이 생성되는 것을 확인할 수 있다.
• 이렇게 외부에서 의존관계를 주입(DI) 받는게 아니라 직접 의존관계를 찾는 것을 Dependency Lookup (DL) 의존관계 조회(탐색) 이라한다.

 

ObjectFactory, ObjectProvider

지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하는 것이 ObjectProvider 이다. 과거에는 ObjectFactory 에서 기능을 추가한 ObjectProvider 가 만들어짐

JSR-330 Provider

스프링 부트 3.0 이상

implementation 'jakarta.inject:jakarta.inject-api:2.0.1' 라이브러리를 gradle에 추가해서 사용한다.

정리

• 그러면 프로토타입 빈을 언제 사용할까? 매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용하면 된다. 그런데 대부분 싱글톤 빈으로 문제를 해결할 수 있기 때문에 직접적으로 사용하는 일은 드물다.
• ObjectProvider , JSR330 Provider 등은 프로토타입 뿐만 아니라 DL이 필요한 경우는 언제든지 사용가능하다.

 

---

 

웹 스코프

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

 

종류

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

request 스코프

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵기 때문에 이때 request 스코프를 사용하여 해결할 수 있다.

다음과 같이 로그가 남도록 request 스코프를 활용해보자

[d06b992f...] request scope bean create
[d06b992f...][http://localhost:8080/log-demo] controller test
[d06b992f...][http://localhost:8080/log-demo] service id = testId
[d06b992f...] request scope bean close

• [UUID] [requestURL] {message}

MyLogger (로그를 출력하기 위한 클래스)

@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")  를 사용하여 HTTP 요청 당 하나씩 생성하고 요청이 끝나는 시점에 소멸된다.
• 이 빈이 생성되는 시점에 자동으로  @PostConstruct  초기화 메서드를 사용하여 uuid를 생성해서 저장해준다.
• 이 빈이 소멸되는 시점에  @PreDestroy  를 사용해서 종료 메시지를 남긴다.
•  requestURL  은 빈이 생성되는 시점에는 알 수 없으므로, 외부에서 setter로 입력 받는다.

 

LogDemoController (로거 확인 컨트롤러)

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

•  HttpServletRequest  통해서 요청 URL을 받는다.
  • requestURL 값 http://localhost:8080/log-demo

LogDemoService 추가

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

 

실행했을때 기대하는 출력이 아래와 같다.

[d06b992f...] request scope bean create
[d06b992f...][http://localhost:8080/log-demo] controller test
[d06b992f...][http://localhost:8080/log-demo] service id = testId
[d06b992f...] request scope bean close

하지만 애플리케이션 실행 시점에 오류가 발생한다.

스프링 애플리케이션을 실행하는 시점에 싱글톤 빈은 생성해서 주입이 가능했지만, request 스코프 빈은 아직 생성되지 않는다. 이 빈은 실제 고객의 요청이 와야 생성할 수 있다!

해결방안은 다음과 같다.

 

스코프와 Provider

LogDemoController 수정

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

 

LogDemoService 수정

@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 빈의 생성이 정상 처리된다.
•  ObjectProvider.getObject()  를  LogDemoController  ,  LogDemoService  에서 각각 한번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다.