大型 Java 框架的逆向工程可以通过多种工具实现。本文将演示如何利用 ulyp 工具在短短 10 分钟内深入了解 spring web 的内部机制,帮助开发者在深入研究源码之前快速掌握框架运作原理。这是关于 ulyp 工具的系列博客文章的第二部分,第一部分内容可参考此处(此处应插入第一部分链接)。
引言
分析大型框架的代码库是开发过程中的一大挑战。开发者有时需要快速了解框架的内部结构,例如当某些功能未按预期工作,而基本的调试手段无法解决问题时。
常见的代码库分析方法包括:
- 使用传统调试器:设置断点,检查堆栈跟踪和变量。
- 直接阅读源码:利用已有的知识直接深入研究源码。
- 基于测试分析:通过测试来理解代码库的运作。
- 使用追踪日志:启用追踪日志并分析日志信息。
- 使用采样分析器:生成火焰图,尤其适用于已处于负载状态的应用。
- 使用记录调试器:记录整个执行流程,生成调用树。
本文将重点介绍最后一种方法——使用记录调试器。在处理大型代码库时,这种方法能有效地帮助开发者理解运行时行为,从而更好地理解源码。
spring Web 逆向工程
我们将使用 Spring Petclinic 项目(一个基于 Spring Web 的 Java Web 应用)来演示 Ulyp 工具的使用。假设我们需要快速了解该应用的运作方式。
我们跳过设置步骤,直接进入录制过程。首先,我们需要确定录制的起始点。一种简单的方法是收集堆栈跟踪。如果我们在控制器内部设置断点,则堆栈跟踪的顶部通常如下所示:
<应用方法> ... <其他Spring方法> at org.springframework.web.Filter.characterencodingfilter.dofilterinternal(characterencodingfilter.java:201) at org.springframework.web.filter.onceperrequestfilter.dofilter(onceperrequestfilter.java:116) ... <tomcat方法> at java.base/java.lang.thread.run(thread.java:1583) </Tomcat></其他></应用>
由于我们的目标是逆向工程 Spring Web,因此我们应该从堆栈跟踪的底部开始,在本例中是 org.springframework.web.filter.onceperrequestfilter 方法。这是 Spring 框架中第一个被调用的方法。
为了记录执行流程,我们需要配置 Ulyp。在启动 Petclinic 应用时,我们添加以下系统属性,无需修改任何代码:
-javaagent:/home/tools/ulyp/ulyp-agent-1.0.2.jar -Dulyp.methods=**.OncePerRequestFilter.doFilter -Dulyp.file=/tmp/test-petclinic.dat -Dulyp.record-constructors -Dulyp.record-collections=JDK -Dulyp.record-arrays
-Dulyp.methods=**.OncePerRequestFilter.doFilter 指示 Ulyp 在调用任何名为 OncePerRequestFilter 类的 doFilter 方法时开始记录。-Dulyp.file=/tmp/test-petclinic.dat 指定输出文件路径。其他属性启用额外的录制功能,这些是可选的。
访问 URL http://localhost:4200/petclinic/vets (显示所有兽医信息的页面),然后停止应用,Ulyp 将所有记录的数据写入输出文件。
接下来,使用 Ulyp 的桌面应用打开 /tmp/test-petclinic.dat 文件,查看记录的数据。
显示的是一个调用树。可以看到,根方法是 OncePerRequestFilter.doFilter。下一层是该方法内部调用的方法。黑色线条表示每个子树中的调用次数。我们可以展开每个方法调用来查看嵌套调用。Spring Web 使用责任链模式,每个过滤器执行一些操作,然后调用下一个过滤器。例如,OrderedFormContentFilter 调用 OrderedRequestContextFilter。
深入分析,我们可以观察到 Spring Web 如何创建 Micrometer 事件,以及如何更新可在其他过滤器中访问的上下文。
路径中还调用了许多过滤器。AuthorizationFilter 调用 ObservationAuthorizationManager.check 方法,返回 AuthorizationDecision 实例,过滤器随后检查 AuthorizationDecision.isGranted 是否返回 true,以验证用户权限。
接下来,可以看到 DispatcherServlet.doDispatch 的调用,以及最终的控制器调用 (VetController),返回兽医列表。
我们可以看到 Spring mvc 的运作方式,包括过滤器、验证器以及响应映射到 json 的过程。每个方法调用都被记录下来,方便后续分析。
(此处可以补充关于深入到 hibernate 或 JDBC 层级的说明,并链接到系列博客文章的第一部分。)
结论
本文演示了如何使用 Ulyp 工具记录和分析大型框架的内部结构,帮助开发者更好地理解框架的运作方式,从而提高开发效率。在处理复杂的代码库时,Ulyp 工具是一个非常有用的辅助工具。