【lombok】从easyExcel read不到值到cglib @Accessors(chain = true)隐藏的大坑

浅浅的花香味﹌ 2024-02-05 14:45 9阅读 0赞

> 背景:  
> 在一次使用easyExcel.read 读取excel时，发现实体类字段没有值，在反复测试后，发现去掉@Accessors(chain = true)就正常了，为了验证原因，进行了一次代码跟踪

由于调用链路特别长，只列举出部分代码， 感兴趣的同学通过断点及前后的堆栈信息可以自己追踪到中间代码。

DTO代码(开启了chain )：

@HeadRowHeight(30)
    @ContentRowHeight(20)
    @Data()
    @Accessors(chain = true)
    public class EasyExcelDTO {
        
        @ColumnWidth(30)
        @ExcelProperty("标题")
        private String title;
    
        @ColumnWidth(30)
        @ExcelProperty("内容")
        private String content;
    
    }

读取excel代码示例：

List<EasyExcelDTO> res = new ArrayList<>();
    
            EasyExcel.read(file, EasyExcelDTO.class, new AnalysisEventListener<EasyExcelDTO>() {
        
    
                @Override
                public void invoke(EasyExcelDTO o, AnalysisContext analysisContext) {
        
                    res.add(o);
                }
    
                @Override
                public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        
    
                }
            }).sheet().doRead();
    
            System.out.println(res);

首先我们从doRead()方法点进去：  
ExcelReaderSheetBuilder类的doRead()方法

![在这里插入图片描述][88b27c50eb04481bbcec0fba9140ff6d.jpeg]  
接着连续点几次read()方法 过程略

接下来可以看到如下代码：  
![在这里插入图片描述][a5d53ac9b1974b9d90e16a7a18385b3d.png]  
省略一系列中间步骤 （可自行通过前后断点 看到中间堆栈链路）  
接下来可以看到DefaultAnalysisEventProcessor类中 readListener监听的invoke方法  
![在这里插入图片描述][a50e1d760bf54babadebc6e99327a183.jpeg]

ModelBuildEventListener类的buildUserModel方法，  
下图中的resultModel就是我们的实体类对象  
![在这里插入图片描述][dbe1437eb3a44839b532f117d8cf66b0.png]  
接着就是一系列的convert操作:  
ConverterUtils类doConvertToJavaObject方法  
![在这里插入图片描述][2c440b95dd4a4451aaf3bf21b006c8c1.png]

接下来的重点来了：  
还是在ModelBuildEventListener类的buildUserModel方法中，最后有两行,  
为什么会盯上这两行代码呢 ，因为这里返回去 字段没有值，意味着这个步骤出现了问题，也正是从这里开始 与阿里无关（阿里成功甩锅），接下来就是使用的cglib的代码了

BeanMap.create(resultModel).putAll(map);
            return resultModel;

从这里开始 我们可以不用分析easyExcel的代码了，我们的demo也可以转换为 (因为没有监听 更方便调试)：

EasyExcelDTO easyExcelDTO = new EasyExcelDTO();
            Map<String, String> map = new HashMap<>();
            // DTO里面有title字段
            map.put("title","1");
            // 相当于bean拷贝 (下面这行是cglib里面的代码)
            BeanMap.create(easyExcelDTO).putAll(map);
            System.out.println(easyExcelDTO);

![在这里插入图片描述][4cde6adac02a4df38a61eda1ab8afa53.png]

putAll只是个赋值，所以我们看cglib包下的BeanMap类的 create()方法：  
![在这里插入图片描述][e738c7d86fdd45bf898df49534b2f5fd.png]  
跟踪的难点 难就难在不知道到底哪个步骤对bean进行操作 ，  
接下来是AbstractClassGenerator类的create方法

![在这里插入图片描述][0017714adceb45728cf7fd8834723873.png]  
再接下来是ReflectUtils类的getPropertiesHelper方法：  
为什么会找到这个方法 因为它被getBeanSetters方法调用，而bean拷贝赋值 大概率就是通过set方法去设置值的，也就是说问题可能出在set方法里面  
![在这里插入图片描述][33a4033d3eaf4357a008ec45dfe1acbf.jpeg]

从这里开始，调用的就是java.desktop包下的代码了 通俗点说也就是jdk源码  
接下来是Introspector类的processPropertyDescriptors()方法

![在这里插入图片描述][5aba25a762d846e0a87b75bf6ed45fde.png]  
再紧接着就是PropertyDescriptor类的构造方法了 有些代码逻辑 不管是get 还是set方法 都会执行一遍  
![在这里插入图片描述][5aafaecfd4f34f89b29b462def41b4b4.png]  
因为我断点只打在了下图setters ，上面是get方法的步骤 其实在之前的步骤中 还需要经过cglib BeanMapEmitter类的构造方法 (set流程也是类似的)

![在这里插入图片描述][eb7f2f667b94461698c97f8f52486d5b.png]  
我们可以看到关键的一行代码：

Map setters = this.makePropertyMap(ReflectUtils.getBeanSetters(type));

这边就是获取set方法map了，那如果这个map没有内容 是不是说明我们错过了什么调试步骤呢？我们需要做的应该是往上游找代码， 没必要继续往下跟源码了

我们代码跟下来，似乎信息都是在 entry里面，我们往上翻两步可以看到下列代码：

PropertyInfo info = entry.getValue();
            setName(Introspector.decapitalize(base));
            setReadMethod0(info.getReadMethod());
            setWriteMethod0(info.getWriteMethod());

于是我们再次回到这个方法：  
Introspector类的processPropertyDescriptors()方法  
![在这里插入图片描述][2e86135e6e1146f29aa99dbccedaa2b7.png]  
光标这行代码中 有个.getProperties()方法 , 我们点进去看看 ,  
进入到了ClassInfo类中 有个get方法

![在这里插入图片描述][97934c7967da402d848b55fc037a7eef.png]

进入上图红框的get方法，来到了PropertyInfo类的get方法，至此真相大白，  
针对set方法的返回值做了判断，如果不为空 writeList就不会赋值  
就找不到写入（set）相关的方法

![在这里插入图片描述][386c5caba6ab40a6b4bf01251b542847.png]

上面我们分析的是create方法， 我们接下来简单看一下put方法

// 
    BeanMap.create(easyExcelDTO).putAll(map)

BeanMap类的putAll方法：

![在这里插入图片描述][9449e2dc18aa416ea4d1c66f228d5b75.jpeg]

最终是一个抽象方法，那么我们可以想到 这里是用了动态代理去实现，  
红框中var1是bean, bean是由我们DTO对象转换来的，var2 var3分别是k v,  
不难猜测这个方法里面是对bean进行赋值  
![在这里插入图片描述][0246fa6731344498aceaa6a1e3712659.png]

我们可以通过artuas 看一下代理对象中 put方法赋值做了什么：

> tips:如何寻找代理对象？  
> 我们通过put方法 不难看出 是给DTO（bean）赋值，意味着我们的DTO对象可能被代理了

启动arthuas 输入命令：

dump *EasyExcelDTO*

果然发现了代理对象：  
![在这里插入图片描述][d0c5da733f6543b2a39ffeddb81ceb68.png]  
接着通过jad 命令，输入全路径类名即可：

![在这里插入图片描述][9b5d196f36bd4cc5876809bd531164fc.png]

开启了chain 我们可以看到put方法里面没有set的步骤  
![在这里插入图片描述][f8d2e4e3f46f4c35b2756876baeb00d9.png]  
关闭chain之后 有set步骤  
![在这里插入图片描述][09a8434b1bdc4a529f057ebdfc59a173.png]

总结： 完整调用链路中 涉及到 ReflectUtils 和 BaseMap 类，比较多工具框架都可能使用到这些代码，出现问题时，通常会先尝试找各种原因 花大量时间排除其它原因导致的 比较难想到是因为set方法有返回值导致的。

[88b27c50eb04481bbcec0fba9140ff6d.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/3657c4cd3bc94619bc7a8ac1f776f387.png
[a5d53ac9b1974b9d90e16a7a18385b3d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/d08b19e1b74a4b2f9c66345e37dc7075.png
[a50e1d760bf54babadebc6e99327a183.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/f958069786354f4993ad8c5ed62e8dc5.png
[dbe1437eb3a44839b532f117d8cf66b0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/748d1519ca864ab7a50fb00920f925d6.png
[2c440b95dd4a4451aaf3bf21b006c8c1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/72cbecc53362421d9a91b7c7859494c9.png
[4cde6adac02a4df38a61eda1ab8afa53.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/886de2e34be24882a15ec2d706fc6fdf.png
[e738c7d86fdd45bf898df49534b2f5fd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/3e52c58088484d57b6e227da79950ee6.png
[0017714adceb45728cf7fd8834723873.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/a85fcfe584994319a63fbf5796375c25.png
[33a4033d3eaf4357a008ec45dfe1acbf.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/990ef00b05184afe865acffd0e2e8a05.png
[5aba25a762d846e0a87b75bf6ed45fde.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/c10244c46cf345d3b724b1e781121694.png
[5aafaecfd4f34f89b29b462def41b4b4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/f629542fbe374f9face6780ba6f53d5b.png
[eb7f2f667b94461698c97f8f52486d5b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/33be49af82cf4d6e9941899848c17c36.png
[2e86135e6e1146f29aa99dbccedaa2b7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/7625e40a0e6c44648362bf2f27c262d3.png
[97934c7967da402d848b55fc037a7eef.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/fb87efee52ef4b83832cca1c7ad656d8.png
[386c5caba6ab40a6b4bf01251b542847.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/ddf05b85edca468c820d415eaef678a5.png
[9449e2dc18aa416ea4d1c66f228d5b75.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/d2451669acdd471fb2800fa5b552c17c.png
[0246fa6731344498aceaa6a1e3712659.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/0faaa5dc3c82467783011e5373d8cfe2.png
[d0c5da733f6543b2a39ffeddb81ceb68.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/2a560e8ae3f048558f5672d4a1a73f57.png
[9b5d196f36bd4cc5876809bd531164fc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/a53c145bc6e947bd8b0c1253ca525bee.png
[f8d2e4e3f46f4c35b2756876baeb00d9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/2194ae37bfeb4ecb932243b0774b3496.png
[09a8434b1bdc4a529f057ebdfc59a173.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/6efe4b52ac9a4bc9b826fa2060c84644.png