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

news2024/11/24 19:53:49

文章目录

  • 前言
  • 一、获取请求执行的类、方法信息
  • 二、获取请求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 {

    @Override
    public 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 {

    @Override
    public 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()) {
        @Override
        public 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,对响应结果,进行装饰,获取请求结果数据。

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

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

使用 Seq2Seq 模型进行文本摘要

目录 引言 1 导入数据集 2 清洗数据集 3 确定允许的最大序列长度 4 选择合理的文本和摘要 5 对文本进行标记 6 删除空文本和摘要 7 构建模型 7.1 编码器 7.2 解码器 8 训练模型 9 测试模型 10 注意 11 整体代码 引言 文本摘要是指在捕捉其本质的同时缩短长文本的…

主从复制与读写分离

前言&#xff1a; 在企业应用中&#xff0c;成熟的业务通常数据量都比较大&#xff0c;单台MySQL在安全性、高可用性和高并发方面 都无法满足实际的需求&#xff1f; 配置多台主从数据库服务器以实现读写分离 目录 一 主从复制的工作原理 ①MySQL的复制类型 ②主从复制过…

Netty组件优化之FastThreadLocal

ThreadLocal:CSDNhttps://mp.csdn.net/mp_blog/creation/editor/132995427 Netty中的FastThreadLocal是对Java中的FastThreadLocal的优化主要是为了解决ThreadLocal中线性查找 带来的性能下降同时实现快速查找和赋值 FastThreadLocal构建这里的index代表一个编号&#xff0c;从…

【Web应用技术基础】CSS(4)——背景样式

第1题&#xff1a;背景颜色 .html <!DOCTYPE html> <html><head><meta charset"utf-8"><title>Hello World</title><link rel"stylesheet" href"step1/CSS/style.css"> </head><body>&…

预训练大模型最佳Llama开源社区中文版Llama2

Llama中文社区率先完成了国内首个真正意义上的中文版Llama2-13B大模型&#xff0c;从模型底层实现了Llama2中文能力的大幅优化和提升。毋庸置疑&#xff0c;中文版Llama2一经发布将开启国内大模型新时代。 作为AI领域最强大的开源大模型&#xff0c;Llama2基于2万亿token数据预…

[机器学习]练习闵可斯基距离

闵可斯基距离&#xff08;Minkowski distance&#xff09;是一种用于衡量向量空间中两点之间距离的方法。它是曼哈顿距离和欧几里得距离的一般化形式。闵可斯基距离使用一个参数 p 来调整计算方法&#xff0c;其中 p 是一个大于 0 的实数值。 在二维空间中&#xff0c;闵可斯基…

二. CUDA编程入门-Stream与Event

目录 前言0. 简述1. 执行一下我们的第九个CUDA程序2. Stream是什么3. Streams实验(单流vs多流)4. 如何隐藏延迟(memory)5. 如何隐藏延迟(kernel)6. 如何隐藏延迟(kernelmemory)7. 代码分析总结参考 前言 自动驾驶之心推出的 《CUDA与TensorRT部署实战课程》&#xff0c;链接。记…

HWOD:提取不重复的整数

一、题目 1、描述 输入一个int型整数&#xff0c;按照从右向左的阅读顺序&#xff0c;返回一个不含重复数字的新的数字。保证输入的整数最后一位不是0 2、数据范围 1< n <10^8&#xff1b; 3、输入 输入一个int型整数 4、输出 按照从右向左的阅读顺序&#xff0c…

vue3 视频播放功能整体复盘梳理

回顾工作中对视频的处理&#xff0c;让工作中处理的问题的经验固化成成果&#xff0c;不仅仅是完成任务&#xff0c;还能解答任务的知识点。 遇到的问题 1、如何隐藏下载按钮&#xff1f; video 标签中的controlslist属性是可以用来控制播放器上空间的显示&#xff0c;在原来默…

文件上传失败原因分析与解决

图片文件上传失败 问题描述&#xff1a;在前端开发时&#xff0c;需要通过表单元素上传图片或其他文本&#xff0c;但是上传不成功&#xff0c;后端接口也没问题 html <!--onChange用来绑定数据 handleUpload用来提交数据--><form onSubmit{handleUpload}><…

比KMP简单的Manacher

P3805 【模板】manacher - 洛谷 | 计算机科学教育新生态 (luogu.com.cn) “没时间悼念KMP了&#xff0c;接下来上场的是Manacher&#xff01;” 什么是Manacher? 历史背景&#xff1a; 1975 年&#xff0c;一个叫 Manacher 的人发明了这个算法&#xff0c;所以叫Manacher 算…

npm镜像源证书过期问题解决

title: npm镜像源证书过期 search: 2024-02-29 文章目录 Failed to check for updates 问题ERR_PNPM_NO_PKG_MANIFESTnpm缓存清除指令权限不足导致删除不了解决方案npm创建基础配资文件 Failed to check for updates 问题 错误描述如上 检查完 node,vue,npm 的版本后都没啥问…

瑞吉外卖实战学习--8、人员禁用和启用

前言 1、通过前端页面查看接口 会发现请求方式是put 请求接口是employee 2、检查页面传值 根据浏览器的请求可以看到传值为id和status 2、写put请求&#xff0c;添加修改时间和修改人的id然后传回给后台 /*** 启用和禁用员工账号* param request* param employee* return…

Linux:ip协议

文章目录 ip协议基本认识ip协议的报头 ip协议基本认识 前面对于TCP的内容已经基本结束了&#xff0c;那么这也就意味着在传输层也已经结束了&#xff0c;那么下一步要进入的是的是网络层&#xff0c;网络层中也有很多种协议&#xff0c;这里主要进行解析的是ip协议 前面的TCP…

【应用笔记】LAT1413+快速开关蓝牙导致设备无广播

1. 问题背景 客户使用 BlueNRG-345MC 开发了一个 BLE 外设&#xff0c;和手机连接。在测试中发现&#xff0c;手机连接上外设之后&#xff0c;不断地在手机上点击蓝牙的开关按钮&#xff0c;造成设备不断地断开、重连&#xff1b;少则几次&#xff0c;多则几十次。点击之后&am…

【前端面试3+1】07vue2和vue3的区别、vue3响应原理及为什么使用proxy、vue的生命周期中在什么时期给接口发请求、【找出数组最大公约数】

一、vue2和vue3的区别 1.性能优化&#xff1a; Vue 3在性能方面有很大的提升&#xff0c;主要是通过虚拟DOM的优化和响应式系统的改进实现的。 虚拟 DOM 重构&#xff1a;Vue 3 中对虚拟 DOM 进行了重构&#xff0c;使得更新算法更加高效&#xff0c;减少了更新时的开销&#x…

【电路笔记】-快速了解数字逻辑门

快速了解数字逻辑门 文章目录 快速了解数字逻辑门1、概述2、集成电路的分类3、摩尔定律4、数字逻辑状态5、数字逻辑噪声6、简单的基本数字逻辑门7、基本 TTL 逻辑门8、发射极耦合数字逻辑门9、集成电路的“74”子族10、基本 CMOS 数字逻辑门数字逻辑门是一种电子电路,它根据其…

CI/CD实战-jenkins结合ansible 7

配置主机环境 在jenkins上断开并删除docker1节点 重新给master添加构建任务 将server3&#xff0c;server4作为测试主机&#xff0c;停掉其上后面的docker 在server2&#xff08;jenkins&#xff09;主机上安装ansible 设置jenkins用户到目标主机的免密 给测试主机创建用户并…

STL —— string(终)

目录 1. swap() 函数的模拟实现 2. find() 函数的模拟实现 3. substr() 函数的模拟实现 4. operator()的重载模拟实现 5. << 和 >> 重载的模拟实现 6. getline() 的重载 7. 拷贝构造的现代写法 8. 赋值重载的现代写法 本片文章还是主要讲解 string 类中剩…

运维经验|Linux虚拟机如何挂载磁盘

&#x1f4eb; 作者简介&#xff1a;「六月暴雪飞梨花」&#xff0c;专注于研究Java&#xff0c;就职于科技型公司后端工程师 &#x1f3c6; 近期荣誉&#xff1a;华为云云享专家、阿里云专家博主、腾讯云优秀创作者 &#x1f525; 三连支持&#xff1a;欢迎 ❤️关注、&#x…