Spring WebFlux 동작 원리 알아보기 (DispatcherHandler)

Spring WebFlux가 큰 틀에서 어떤 방식으로 동작하는지 알아보고자 한다.

Spring MVC 의 경우에는 DispatcherServlet 기반으로 요청을 받아 뒷단의 처리가 이루어진다. Spring WebFlux의 경우에도 DispatcherServlet과 같이 front controller 의 역할을 해주는 친구가 존재한다. 

 

일단 결론부터 말하면 대충 분석해본 것들을 요약했을 때 아래 같은 그림이다. (간단하게 표현해서 생략이 많을 수 있다.)

 

 

DispatcherHandler (WebHandler의 구현체)

DispatcherHandler 는 WebHandler 인터페이스의 구현체로 Spring Webflux에서의 front controller 역할을 한다. 

 

아래는 DispatchHandler 클래스이다. Spring MVC와 마찬가지로 DispatcherHandler는 HandlerMapping, HandlerAdapter, 그리고 추가적으로 ResultHandler 와의 연관관계를 가지고 있다.

• handlerMapping : 요청을 어떤 controller가 처리할 지 결정
• handlerAdapter : HandlerMapping 으로 선택된 controller 또는 router 를 호출
• handlerResultHandler : 결과를 처리하고 응답

public class DispatcherHandler implements WebHandler, PreFlightRequestHandler, ApplicationContextAware {

	@Nullable
	private List<HandlerMapping> handlerMappings;
	@Nullable
	private List<HandlerAdapter> handlerAdapters;
	@Nullable
	private List<HandlerResultHandler> resultHandlers;

	public DispatcherHandler() {
	}

	public DispatcherHandler(ApplicationContext applicationContext) {
		initStrategies(applicationContext);
	}

	@Nullable
	public final List<HandlerMapping> getHandlerMappings() {
		return this.handlerMappings;
	}

	@Override
	public void setApplicationContext(ApplicationContext applicationContext) {
		initStrategies(applicationContext);
	}

	protected void initStrategies(ApplicationContext context) {
		Map<String, HandlerMapping> mappingBeans = BeanFactoryUtils.beansOfTypeIncludingAncestors(
				context, HandlerMapping.class, true, false);

		ArrayList<HandlerMapping> mappings = new ArrayList<>(mappingBeans.values());
		AnnotationAwareOrderComparator.sort(mappings);
		this.handlerMappings = Collections.unmodifiableList(mappings);

		Map<String, HandlerAdapter> adapterBeans = BeanFactoryUtils.beansOfTypeIncludingAncestors(
				context, HandlerAdapter.class, true, false);

		this.handlerAdapters = new ArrayList<>(adapterBeans.values());
		AnnotationAwareOrderComparator.sort(this.handlerAdapters);

		Map<String, HandlerResultHandler> beans = BeanFactoryUtils.beansOfTypeIncludingAncestors(
				context, HandlerResultHandler.class, true, false);

		this.resultHandlers = new ArrayList<>(beans.values());
		AnnotationAwareOrderComparator.sort(this.resultHandlers);
	}
    
	@Override
	public Mono<Void> handle(ServerWebExchange exchange) {
		if (this.handlerMappings == null) {
			return createNotFoundError();
		}
		if (CorsUtils.isPreFlightRequest(exchange.getRequest())) {
			return handlePreFlight(exchange);
		}
		return Flux.fromIterable(this.handlerMappings)
				.concatMap(mapping -> mapping.getHandler(exchange))
				.next()
				.switchIfEmpty(createNotFoundError())
				.flatMap(handler -> invokeHandler(exchange, handler))
				.flatMap(result -> handleResult(exchange, result));
	}
    ...
    }

 

1. handle (ServerWebExchange serverWebExchange)

• request 를 받아 handlerMapping 을 통해 컨트롤러를 매핑하고 handlerAdapter를 통해 라우터를 호출 후 response를 반환하는 모든 일련의 과정을 담은 메서드이다.
• serverWebExchange는 요청(ServerHttpRequest)과 응답(ServerHttpResponse) 모두에 대한 컨텍스트를 제공 및 접근 가능하다.

2. initStrategies(ApplicationContext context)

• ApplicationContext의 Bean(HandlerMapping, HandlerAdapter, HandlerResultHandler) 을 찾아 주입해준다.

 

HttpWebHandlerAdapter (HttpHandler 의 구현체)

 

요청에 대한 lowest level 동작을 맡고 있는 HttpHandler 의 구현체로, WebHandler로 요청을 넘기기 전에 내부적으로 동작한다. 

저수준 레벨의 구현체이기 때문에 블랙박스 영역으로 개발자가 접근하고 수정할 일이 있는 클래스는 아니다.

즉, HttpWebHandlerAdapter 는 HTTP 요청을 받아 WebHandler(DispatcherHandler) 로 전달하고 HTTP 응답으로 반환하는 역할을 한다.

그럼에도 불구하고 이 클래스에 대한 언급이 필요한 이유는 DispatcherHandler로 전달 되기 전 FilteringWebHandler를 통해 WebFilter 클래스들의 필터 체인이 실행되기 때문이다.

public class HttpWebHandlerAdapter extends WebHandlerDecorator implements HttpHandler {
	...
    
    @Override
	public Mono<Void> handle(ServerHttpRequest request, ServerHttpResponse response) {
		if (this.forwardedHeaderTransformer != null) {
			try {
				request = this.forwardedHeaderTransformer.apply(request);
			}
			catch (Throwable ex) {
				if (logger.isDebugEnabled()) {
					logger.debug("Failed to apply forwarded headers to " + formatRequest(request), ex);
				}
				response.setStatusCode(HttpStatus.BAD_REQUEST);
				return response.setComplete();
			}
		}
		ServerWebExchange exchange = createExchange(request, response);

		LogFormatUtils.traceDebug(logger, traceOn ->
				exchange.getLogPrefix() + formatRequest(exchange.getRequest()) +
						(traceOn ? ", headers=" + formatHeaders(exchange.getRequest().getHeaders()) : ""));

		return getDelegate().handle(exchange)
				.doOnSuccess(aVoid -> logResponse(exchange))
				.onErrorResume(ex -> handleUnresolvedError(exchange, ex))
				.then(Mono.defer(response::setComplete));
	}
    
    ...
    }

위 코드를 보면 getDelegate().handle(exchange) 부분에서 WebHandler 의 구현체의 handle 메서드가 실행된다.

WebHandler의 구현체로는 DispatcherHandler 이외에도 FilteringWebHandler, ExceptionHandlingWebHandler 등 여러 구현체가 존재한다.

 

아래 코드는 필터체인의 필터 실행 함수인데, 필터를 실행하고 더 이상 실행할 필터가 없으면 다른 webHandler의 handler 메서드로 위임해주는 것을 볼 수 있다. 

	public Mono<Void> filter(ServerWebExchange exchange) {
		return Mono.defer(() ->
				this.currentFilter != null && this.chain != null ?
						invokeFilter(this.currentFilter, this.chain, exchange) :
						this.handler.handle(exchange));
	}

만약 서버에 요청 전에 추가 로직을 덧붙이고 싶다면 WebFilter 인터페이스를 구현한 구현체를 추가해주면 된다.

 

 

 

참고

https://docs.spring.io/spring-framework/reference/web/webflux/dispatcher-handler.html

https://blog.naver.com/PostView.naver?blogId=gngh0101&logNo=221538537388