绑定完请刷新页面
取消
刷新

分享好友

×
取消 复制
近,我在Spring的BeanUtils踩了不少坑
2021-11-18 16:33:47



背景

近项目中在和第三方进行联调一个接口,我们这边发送http请求给对方,然后接收对方的回应,代码都是老代码。根据注释,对方的SDK中写好的Request类有一个无法序列化的bug,所以这边重新写了一个Request类,基本属性都是相同的,但是重点是有一个属性是静态内部类,还有两个是list属性,类似于下面这样:

private List<Order> orders;  
private AddRequest.Ticket ticket;  
private List<Payment> payments;  

AddRequest就是我们自己重写的请求类,他们SDK中的请求类是MixAddRequest,我们组装好请求参数后利用Spring的BeanUtils的copyProperties方法将AddRequest中的属性拷贝到MixAddRequest,然后发送请求。到此为止,照理说一切完美

图片

结果请求失败,纳尼?对方说缺少一个必要的字段,参数校验不通过,一查字段名称,是Ticket这个类里面的某个字段,赶紧看代码,心里充满对老代码的自信,想着一定是哪里搞错了,或者是他们那边偷偷动了代码,把字段从可选改为了必选,嘿嘿

图片

果然在代码里找到了设置的地方,这下应该是他们的问题确信无疑了,再开一把调试,准备宣判他们的死刑。结果发现发给他们的请求就是没有这个字段。。。中间只有一个Spring的copy属性的方法,当时觉得很诡异

图片

由于中间只有这么一行代码,玄机肯定在这里面,初步怀疑是两个静态内部类不同导致,所以自己写Demo,准备搞一把这个BeanUtils的copyProperties方法,写了两个类和一个Main,@Data和@ToString是lombok插件的注解,这里用来自动生成getter和setter方法以及toString方法

@ToString  
@Data  
public class CopyTest1 {  
    public String outerName;  
    public CopyTest1.InnerClass innerClass;  
    public List<CopyTest1.InnerClass> clazz;  
  
    @ToString  
    @Data  
    public static class InnerClass {  
        public String InnerName;  
    }  
}  

@ToString  
@Data  
public class CopyTest2 {  
    public String outerName;  
    public CopyTest2.InnerClass innerClass;  
    public List<CopyTest2.InnerClass> clazz;  
  
    @ToString  
    @Data  
    public static class InnerClass {  
        public String InnerName;  
    }  
}  
CopyTest1 test1 = new CopyTest1();  
test1.outerName = "hahaha";  
CopyTest1.InnerClass innerClass = new CopyTest1.InnerClass();  
innerClass.InnerName = "hohoho";  
test1.innerClass = innerClass;  
  
System.out.println(test1.toString());  
CopyTest2 test2 = new CopyTest2();  
BeanUtils.copyProperties(test1, test2);  
  
System.out.println(test2.toString());  

这里遇到了个坑,一开始图省事,属性写为public,想着省掉了getter和setter方法,没加@Data注解,结果运行完test2所有属性都为null,一个都没copy过去,加上@Data继续跑,果然,基本属性(String)复制过去了,但是内部类在test2中还是null。那就验证了真的是内部类的问题,有点不敢相信自己的眼睛,毕竟线上跑了这么久的代码。。。

图片

知道了问题,总要想着怎么解决吧,所以需要单独设置一下内部类,单独copy,如果内部类的bean属性较多或者递归的bean属性很多,那可以自己封装一个方法,用于递归拷贝,我这里只有一层,所以直接额外copy一次

CopyTest1 test1 = new CopyTest1();  
test1.outerName = "hahaha";  
CopyTest1.InnerClass innerClass = new CopyTest1.InnerClass();  
innerClass.InnerName = "hohoho";  
test1.innerClass = innerClass;  
  
System.out.println(test1.toString());  
CopyTest2 test2 = new CopyTest2();  
test2.innerClass = new CopyTest2.InnerClass();  
BeanUtils.copyProperties(test1, test2);  
BeanUtils.copyProperties(test1.innerClass, test2.innerClass);  
  
System.out.println(test2.toString());  

记得内部类的属性也是要有setter方法的,不然也会导致copy失败,大家还记得我开头说到还有两个List属性的吧,为什么要提到这个呢?你猜

图片

其实list里面的两个类也都是重写的内部类,他们也是不同的,当时他们却顺利copy过去了,为什么呢?

因为java的泛型只在编译期起作用,在运行期,list属性就是一个存放Object的集合,在copy后,MixAddRequest的orders属性其实是一个Order类的集合,但却不是自己内部类的集合,是AddRequest的内部类Order的集合,但因为对方是解析json的,所以没有发生错误。。。

图片

总结

  1. Spring的BeanUtils的CopyProperties方法需要对应的属性有getter和setter方法;

  2. 如果存在属性完全相同的内部类,但是不是同一个内部类,即分别属于各自的内部类,则spring会认为属性不同,不会copy;

  3. 泛型只在编译期起作用,不能依靠泛型来做运行期的限制;

  4. 后,spring和apache的copy属性的方法源和目的参数的位置正好相反,所以导包和调用的时候都要注意一下。

后的后

附上spring的源码,getWriteMethod是jdk的方法,会去取set开头的方法,所以没有setter方法是不行滴。

private static void copyProperties(Object source, Object target, @Nullable Class<?> editable, @Nullable String... ignoreProperties) throws BeansException {  
        Assert.notNull(source, "Source must not be null");  
        Assert.notNull(target, "Target must not be null");  
        Class<?> actualEditable = target.getClass();  
        if (editable != null) {  
            if (!editable.isInstance(target)) {  
                throw new IllegalArgumentException("Target class [" + target.getClass().getName() + "] not assignable to Editable class [" + editable.getName() + "]");  
            }  
  
            actualEditable = editable;  
        }  
  
        PropertyDescriptor[] targetPds = getPropertyDescriptors(actualEditable);  
        List<String> ignoreList = ignoreProperties != null ? Arrays.asList(ignoreProperties) : null;  
        PropertyDescriptor[] var7 = targetPds;  
        int var8 = targetPds.length;  
  
        for(int var9 = ; var9 < var8; ++var9) {  
            PropertyDescriptor targetPd = var7[var9];  
            Method writeMethod = targetPd.getWriteMethod();  
            if (writeMethod != null && (ignoreList == null || !ignoreList.contains(targetPd.getName()))) {  
                PropertyDescriptor sourcePd = getPropertyDescriptor(source.getClass(), targetPd.getName());  
                if (sourcePd != null) {  
                    Method readMethod = sourcePd.getReadMethod();  
                    if (readMethod != null && ClassUtils.isAssignable(writeMethod.getParameter*()[], readMethod.getReturnType())) {  
                        try {  
                            if (!Modifier.isPublic(readMethod.getDeclaringClass().getModifiers())) {  
                                readMethod.setAccessible(true);  
                            }  
  
                            Object value = readMethod.invoke(source);  
                            if (!Modifier.isPublic(writeMethod.getDeclaringClass().getModifiers())) {  
                                writeMethod.setAccessible(true);  
                            }  
  
                            writeMethod.invoke(target, value);  
                        } catch (Throwable var15) {  
                            throw new FatalBeanException("Could not copy property '" + targetPd.getName() + "' from source to target", var15);  
                        }  
                    }  
                }  
            }  
        }  
  
    }

来源:https://urlify.cn/YBNfeu



分享好友

分享这个小栈给你的朋友们,一起进步吧。

Spring Boot
创建时间:2020-06-22 17:22:00
SpringBoot是由Pivotal团队在2013年开始研发、2014年4月发布个版本的全新开源的轻量级框架。它基于Spring4.0设计,不仅继承了Spring框架原有的特性,而且还通过简化配置来进一步简化了Spring应用的整个搭建和开发过程。另外SpringBoot通过集成大量的框架使得依赖包的版本冲突,以及引用的不稳定性等问题得到了很好的解决。
展开
订阅须知

• 所有用户可根据关注领域订阅专区或所有专区

• 付费订阅:虚拟交易,一经交易不退款;若特殊情况,可3日内客服咨询

• 专区发布评论属默认订阅所评论专区(除付费小栈外)

栈主、嘉宾

查看更多
  • duanhao
    栈主

小栈成员

查看更多
  • ?
  • zander
  • 凉茶cooltea
戳我,来吐槽~