深入剖析Spring WebFlux:从MethodHandler到反射获取请求信息的源码之旅

本文主要是介绍深入剖析Spring WebFlux:从MethodHandler到反射获取请求信息的源码之旅,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

  • 前言
  • 一、获取请求执行的类、方法信息
  • 二、获取请求url变量
  • 三、获取请求处理数据
  • 总结

前言

最近想写一个代办事项后台服务,底层,选型WebFlux。在操作层面上,针对部分操作,想在不侵入业务代码的前提下,记录操作日志,数据内容包括请求参数、响应结果数据。由于WebFlux,是非阻塞式的,原本Spring Mvc的那套代码,在这里就不适用。后续通过百度、阅读WebFlux相关源码,最终达到预先设想目标。该博文,主要就是为了解决WebFlux环境下,收集请求信息,包括请求参数、响应结果信息等。
通过这篇博文,可以解决如下内容:

  1. 获取请求执行的类、方法等信息。
  2. 获取请求url变量。
  3. 如何获取响应结果数据。

一、获取请求执行的类、方法信息

在介绍这部分内容之前,需要先介绍WebFlux的核心处理程序,DispatcherHandler,其地位,等价于Servlet环境下的DispatcherServlet。大体处理逻辑,请求先通过DispatcherHandler,找到请求处理类,如果找不到,就返回404。然后,进行请求处理,最后,对结果进行加工处理。

// DispatcherHandler.java 内容
@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)// mapping为HandlerMapping类型,通过HandlerMapping.getHandler,找到能够处理该请求的HandlerMethod.concatMap(mapping -> mapping.getHandler(exchange)).next()// 针对请求url,若没有找到对应的HandlerMethod,返回404。.switchIfEmpty(createNotFoundError())// 对请求进行处理.flatMap(handler -> invokeHandler(exchange, handler))// 请求结果处理.flatMap(result -> handleResult(exchange, result));
}// 容器启动时,调用这个方法,用于初始化系统配置的HandlerMapping、HandlerAdapter、HandlerResultHandler。并按照执行规则,进行排序。通过排序,确定调用顺序。
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);
}

DispatcherHandler,大体处理流程介绍完了,这里,开始介绍HandlerMapping,后续获取请求执行方法、类等信息的操作,是以这个为基础。HandlerMapping,在容器启动时,搜集服务的全部请求,并将其装配成RequestMappingInfo,并存储与MappingRegistry.pathLookup,关于这部分内容,不是这里讨论的重点,只是为了大概知道整个流程。后续,请求达到时,通过请求地址,从pathLookup中,找到最合适的HandlerMethod。接下来,就是这里重点关注的内容

// AbstractHandlerMethodMapping.java内容
protected HandlerMethod lookupHandlerMethod(ServerWebExchange exchange) throws Exception {List<Match> matches = new ArrayList<>();// 通过完整路径,进行查找List<T> directPathMatches = this.mappingRegistry.getMappingsByDirectPath(exchange);if (directPathMatches != null) {addMatchingMappings(directPathMatches, matches, exchange);}if (matches.isEmpty()) {// 针对请求路径,进行匹配查找,包括请求方法、consume、请求头、请求参数等信息addMatchingMappings(this.mappingRegistry.getRegistrations().keySet(), matches, exchange);}if (!matches.isEmpty()) {Comparator<Match> comparator = new MatchComparator(getMappingComparator(exchange));matches.sort(comparator);Match bestMatch = matches.get(0);if (matches.size() > 1) {if (logger.isTraceEnabled()) {logger.trace(exchange.getLogPrefix() + matches.size() + " matching mappings: " + matches);}if (CorsUtils.isPreFlightRequest(exchange.getRequest())) {for (Match match : matches) {if (match.hasCorsConfig()) {return PREFLIGHT_AMBIGUOUS_MATCH;}}}else {Match secondBestMatch = matches.get(1);if (comparator.compare(bestMatch, secondBestMatch) == 0) {Method m1 = bestMatch.getHandlerMethod().getMethod();Method m2 = secondBestMatch.getHandlerMethod().getMethod();RequestPath path = exchange.getRequest().getPath();throw new IllegalStateException("Ambiguous handler methods mapped for '" + path + "': {" + m1 + ", " + m2 + "}");}}}// 找到HandlerMethod,将信息,进行存储。handleMatch(bestMatch.mapping, bestMatch.getHandlerMethod(), exchange);return bestMatch.getHandlerMethod();}else {return handleNoMatch(this.mappingRegistry.getRegistrations().keySet(), exchange);}
}// RequestMappingInfoHandlerMapping.java 内容。
// RequestMappingInfoHandlerMapping,为AbstractHandlerMethodMapping实现类
protected void handleMatch(RequestMappingInfo info, HandlerMethod handlerMethod,ServerWebExchange exchange) {super.handleMatch(info, handlerMethod, exchange);PathContainer lookupPath = exchange.getRequest().getPath().pathWithinApplication();PathPattern bestPattern;Map<String, String> uriVariables;Map<String, MultiValueMap<String, String>> matrixVariables;Set<PathPattern> patterns = info.getPatternsCondition().getPatterns();if (patterns.isEmpty()) {bestPattern = getPathPatternParser().parse(lookupPath.value());uriVariables = Collections.emptyMap();matrixVariables = Collections.emptyMap();}else {bestPattern = patterns.iterator().next();PathPattern.PathMatchInfo result = bestPattern.matchAndExtract(lookupPath);Assert.notNull(result, () ->"Expected bestPattern: " + bestPattern + " to match lookupPath " + lookupPath);uriVariables = result.getUriVariables();matrixVariables = result.getMatrixVariables();}// 此处将HandlerMethod、uri变量等信息,存储与ServerWebExchange.attributes。exchange.getAttributes().put(BEST_MATCHING_HANDLER_ATTRIBUTE, handlerMethod);exchange.getAttributes().put(BEST_MATCHING_PATTERN_ATTRIBUTE, bestPattern);exchange.getAttributes().put(URI_TEMPLATE_VARIABLES_ATTRIBUTE, uriVariables);exchange.getAttributes().put(MATRIX_VARIABLES_ATTRIBUTE, matrixVariables);if (!info.getProducesCondition().getProducibleMediaTypes().isEmpty()) {Set<MediaType> mediaTypes = info.getProducesCondition().getProducibleMediaTypes();exchange.getAttributes().put(PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, mediaTypes);}
}

到这里,想必大家已经知道,获取获取key为BEST_MATCHING_HANDLER_ATTRIBUTE的属性,可获取处理该请求的HandlerMethod。那么,要从哪里介入呢?这里就需要引入HandlerAdapter接口,该接口存在两个方法,supports方法,判断能否处理;handle,进行请求处理。spring针对该接口,提供了多个实现类,这里主要介绍RequestMappingHandlerAdapter。

// RequestMappingHandlerAdapter.java 内容
@Override
public boolean supports(Object handler) {return handler instanceof HandlerMethod;
}@Override
public Mono<HandlerResult> handle(ServerWebExchange exchange, Object handler) {HandlerMethod handlerMethod = (HandlerMethod) handler;Assert.state(this.methodResolver != null && this.modelInitializer != null, "Not initialized");InitBinderBindingContext bindingContext = new InitBinderBindingContext(getWebBindingInitializer(), this.methodResolver.getInitBinderMethods(handlerMethod));InvocableHandlerMethod invocableMethod = this.methodResolver.getRequestMappingMethod(handlerMethod);Function<Throwable, Mono<HandlerResult>> exceptionHandler =ex -> handleException(ex, handlerMethod, bindingContext, exchange);return this.modelInitializer.initModel(handlerMethod, bindingContext, exchange)// 进行请求处理。.then(Mono.defer(() -> invocableMethod.invoke(exchange, bindingContext))).doOnNext(result -> result.setExceptionHandler(exceptionHandler)).doOnNext(result -> bindingContext.saveModel()).onErrorResume(exceptionHandler);
}

现在,我们可以实现RequestMappingHandlerAdapter,从而拿到HandlerMethod,并获取请求相关信息。

@Slf4j
@Component
public class RequestLogHandlerAdapter extends RequestMappingHandlerAdapter {@Overridepublic Mono<HandlerResult> handle(ServerWebExchange exchange, Object handler) {HandlerMethod handlerMethod = (HandlerMethod) handler;Method method = handlerMethod.getMethod();log.info("Base on {} request, now found it will used {} method to dispose", exchange.getRequest().getPath().value(), method);return super.handle(exchange, handler);}
}

在这里插入图片描述
到这里,我们完成了,获取请求执行类、方法等信息的动作。

二、获取请求url变量

同样的,我们也是通过HandlerAdapter接口,获取请求url变量信息。获取方式,是在上一步介绍的ServerWebExchange的URI_TEMPLATE_VARIABLES_ATTRIBUTE属性。

@Slf4j
@Component
public class RequestLogHandlerAdapter extends RequestMappingHandlerAdapter {@Overridepublic Mono<HandlerResult> handle(ServerWebExchange exchange, Object handler) {HandlerMethod handlerMethod = (HandlerMethod) handler;Map<String, Object> urlVariables = exchange.getAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE);log.info("Url variable is {}", urlVariables);Method method = handlerMethod.getMethod();log.info("Base on {} request, now found it will used {} method to dispose", exchange.getRequest().getPath().value(), method);return super.handle(exchange, handler);}
}

在这里插入图片描述

三、获取请求处理数据

最开始的时候,我以为,也能通过HandlerAdapter接口,获取响应结果数据,毕竟这个接口返回值返回的是HandlerResult。由于接口定义,大多数是采用Mono、Flux作为请求接口的返回值,那么HandlerResult,存储的返回值类型,也是Mono、Flux。无法直接获取请求结果数据。
在这里,需要借助于ServerHttpResponseDecorator,一个对响应结果进行装饰,通过它,可以获取请求响应结果数据。

// WebFilter接口实现类,完成代码,在下一篇博文提供。
@Override
public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {Method method = this.analysisForRequestMethod(exchange);ServerHttpResponseDecorator decoratedResponse = new ServerHttpResponseDecorator(exchange.getResponse()) {@Overridepublic Mono<Void> writeWith(Publisher<? extends DataBuffer> body) {return super.writeWith(DataBufferUtils.join(body).doOnNext(buffer -> {String respBody = buffer.toString(StandardCharsets.UTF_8);JSONObject responseJson = JSONObject.parseObject(respBody);if (method != null) {requestLogOperator.requestLogOperator(method, exchange, responseJson);}}));}};return chain.filter(exchange.mutate().response(decoratedResponse).build());
}

在这里插入图片描述

总结

DispatcherHandler为WebFlux请求的核心处理程序,首先通过HandlerMapping,找到可以处理请求的HandlerMethod,然后通过HandlerAdapter接口,请求处理,然后在对结果进行处理。

  1. 通过实现RequestMappingHandlerAdapter,对原有行为,进行扩展,用于获取请求处理类、请求uri变量。
  2. 通过实现WebFilter接口,借助ServerHttpResponseDecorator,对响应结果,进行装饰,获取请求结果数据。

将在下一篇博文,专门介绍如何将上述内容,收集请求处理信息,进行请求日志记录管理。

这篇关于深入剖析Spring WebFlux:从MethodHandler到反射获取请求信息的源码之旅的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!


原文地址:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.chinasem.cn/article/864594

相关文章

Java实现删除文件中的指定内容

《Java实现删除文件中的指定内容》在日常开发中,经常需要对文本文件进行批量处理,其中,删除文件中指定内容是最常见的需求之一,下面我们就来看看如何使用java实现删除文件中的指定内容吧... 目录1. 项目背景详细介绍2. 项目需求详细介绍2.1 功能需求2.2 非功能需求3. 相关技术详细介绍3.1 Ja

springboot项目中整合高德地图的实践

《springboot项目中整合高德地图的实践》:本文主要介绍springboot项目中整合高德地图的实践,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一:高德开放平台的使用二:创建数据库(我是用的是mysql)三:Springboot所需的依赖(根据你的需求再

spring中的ImportSelector接口示例详解

《spring中的ImportSelector接口示例详解》Spring的ImportSelector接口用于动态选择配置类,实现条件化和模块化配置,关键方法selectImports根据注解信息返回... 目录一、核心作用二、关键方法三、扩展功能四、使用示例五、工作原理六、应用场景七、自定义实现Impor

SpringBoot3应用中集成和使用Spring Retry的实践记录

《SpringBoot3应用中集成和使用SpringRetry的实践记录》SpringRetry为SpringBoot3提供重试机制,支持注解和编程式两种方式,可配置重试策略与监听器,适用于临时性故... 目录1. 简介2. 环境准备3. 使用方式3.1 注解方式 基础使用自定义重试策略失败恢复机制注意事项

一文深入详解Python的secrets模块

《一文深入详解Python的secrets模块》在构建涉及用户身份认证、权限管理、加密通信等系统时,开发者最不能忽视的一个问题就是“安全性”,Python在3.6版本中引入了专门面向安全用途的secr... 目录引言一、背景与动机:为什么需要 secrets 模块?二、secrets 模块的核心功能1. 基

SpringBoot整合Flowable实现工作流的详细流程

《SpringBoot整合Flowable实现工作流的详细流程》Flowable是一个使用Java编写的轻量级业务流程引擎,Flowable流程引擎可用于部署BPMN2.0流程定义,创建这些流程定义的... 目录1、流程引擎介绍2、创建项目3、画流程图4、开发接口4.1 Java 类梳理4.2 查看流程图4

一文详解如何在idea中快速搭建一个Spring Boot项目

《一文详解如何在idea中快速搭建一个SpringBoot项目》IntelliJIDEA作为Java开发者的‌首选IDE‌,深度集成SpringBoot支持,可一键生成项目骨架、智能配置依赖,这篇文... 目录前言1、创建项目名称2、勾选需要的依赖3、在setting中检查maven4、编写数据源5、开启热

C++中RAII资源获取即初始化

《C++中RAII资源获取即初始化》RAII通过构造/析构自动管理资源生命周期,确保安全释放,本文就来介绍一下C++中的RAII技术及其应用,具有一定的参考价值,感兴趣的可以了解一下... 目录一、核心原理与机制二、标准库中的RAII实现三、自定义RAII类设计原则四、常见应用场景1. 内存管理2. 文件操

Java对异常的认识与异常的处理小结

《Java对异常的认识与异常的处理小结》Java程序在运行时可能出现的错误或非正常情况称为异常,下面给大家介绍Java对异常的认识与异常的处理,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参... 目录一、认识异常与异常类型。二、异常的处理三、总结 一、认识异常与异常类型。(1)简单定义-什么是

SpringBoot项目配置logback-spring.xml屏蔽特定路径的日志

《SpringBoot项目配置logback-spring.xml屏蔽特定路径的日志》在SpringBoot项目中,使用logback-spring.xml配置屏蔽特定路径的日志有两种常用方式,文中的... 目录方案一:基础配置(直接关闭目标路径日志)方案二:结合 Spring Profile 按环境屏蔽关