SpringMVC源码探索之RequestBody的工作原理

阳光穿透心脏的1/2处 2022-03-22 14:56 671阅读 0赞

> 遇到一个很奇怪的问题，后面发现了问题所在，原因是自己太过匆忙、连快捷键都被复制粘贴省略了。虽然出现问题的原因有点傻逼，但是之所以出现这种问题的原因却更加引人入胜。

## 问题现象描述 ##

Controller中没有逻辑，只有一个`@RequestBody`注释的form表单  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70]  
然而这个TestBean有点特殊，非一般的get/set方法  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 1]  
按照常理，发送post请求，body中塞入`{"param":"hello"}`即可成功注入到TestBean的实例中  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 2]  
高潮在后面，如果我改成`{"paramA":"hello"}`，结果却能成功接收：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 3]  
综上所述，`paramA`为之前定义的一个变量，我把它改成了新的变量`param`，然后顺便把`paramA`的get/set方法中的`this.paramA`改成了`this.param`。然后就出现了上面的情况。要知道，这个现象很反常，并且不常见。**非常想知道为什么！**

## 怎么通向背后的原因 ##

从源码中看spring是如何处理@RequestBody

## 站在巨人肩膀上 ##

从网上的[参考资料][Link 1]来看，处理相关内容的源码可能位于一个叫做`readWithMessageConverters()`方法中。打开该方法所在的类（双击shift，然后输入方法名），大致是八九不离十的，如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 4]  
打开至该方法后，使用debug模式，在可能的地方打上断点，发送postman请求，等待请求的到来：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 5]  
接着往下看，寻找到一个能将JSON转换成对象的方法：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 6]  
此时的messageConverters和body内容如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 7]  
这里的read()，才是真正的开始。

## 向着jackson-databind的源码出发 ##

跟着上面的read()方法，一路打断点达到了这里，这可以说是最终setter方法的执行处，代码如下：  
![加粗样式][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 8]  
**所以，为什么setter方法会变成setParamA()呢？** 目前为止，可行的解释为：*jackson是根据已解析的出来的json的键，去寻找对应键的setter方法*，与对应的Form表单类中的成员变量的值无关，因此也解释了刚开头那一幕戏剧性的现象。**但是，源代码在哪里？**

## 如何寻找对应的setter方法 ##

经过一次又一次的打断点、跟踪代码运行，终于将规则锁定在了`POJOPropertiesCollector.java`这个类上了。这里面还涉及到了打断点、跟踪代码的一些技巧，一定要分清F7、F8、F9呀，不然就很容易就要从头再来。  
![to be continued...][]  
从上面的代码来看，对`TestForm`的解析，变成了只有一个变量为`paramA`的bean类。所以，按照`paramA`的键，去JSON中取数据，然后调用对应的setter方法，最后赋值给了`param`，过程就是这样。

## 总结 ##

对这个流程的跟踪，发现：只有第一次请求的时候，会初始化一个把JSON转化成对象的这样一个类，缓存使用的是LRUMap。**其中desc是一个解析器，包含了变量与getter/setter方法之间的映射关系**。关键的代码如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 9]  
调试跟踪的过程中，主要的时间都花在了desc的初始化上。因为后续的调用，就是根据desc的映射关系去执行。

### 如何根据getter/setter去解析出成员变量名称？ ###

其实这个流程并不难，我们自己也很容易想到，但是就是想看框架里面是怎么写的。在传给这个函数之前，已经保证了basename是以get开头，且此时的offset为3。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 10]

### 什么情况下删除param？ ###

param即没有setter/getter方法的那个属性。这里因为param被private修饰，然后也未找到setter/getter方法。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 11]  
具体判断是否可见的代码如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 12]

以上。于2019/01/31 00:51完成全部内容。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70]: /images/20220322/1a98b80d2f5743bcb8c830eee4be5947.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 1]: /images/20220322/4e01dba0e20b47008a48538073388653.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 2]: /images/20220322/2eb6b4746d554fe3bf660decb5d6f85d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 3]: /images/20220322/ed4cd661362f441bb1ffa8cdae966f68.png
[Link 1]: https://www.cnblogs.com/caoyc/p/5644730.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 4]: /images/20220322/1518dc82d0d242a2843a4341bff3860b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 5]: /images/20220322/6956eee52bfd46ef90b157cd6c7b5cc9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 6]: /images/20220322/18e59ae36d0d443a9c9f221f0c25a870.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 7]: /images/20220322/225327cc1d614bdfbe31e29d88319c1c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 8]: /images/20220322/7c1d79a11b2246449ec25774f1e5a73a.png
[to be continued...]: /images/20220322/9be827ebeff64c9dbf38db92cd6a47b3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 9]: /images/20220322/588f952bee9a4c50a182b979d36767b1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 10]: /images/20220322/d1cabaeb4a824a13bf809dc52cd46757.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 11]: /images/20220322/0a068a17078b428298f3eeb4e0cdccd6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzYWhpbm9rYXdh_size_16_color_FFFFFF_t_70 12]: /images/20220322/e96d57f602a64105a46a01d93fed29d2.png