四条使用Spring BeanUtils的总结,避免各种诡异的属性拷贝问题!

副标题#e#

 背景

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

  1. private List<Order> orders; 
  2. private AddRequest.Ticket ticket; 
  3. 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方法。

  1. @ToString 
  2. @Data 
  3. public classCopyTest1{ 
  4.     public String outerName; 
  5.     public CopyTest1.InnerClass innerClass; 
  6.     public List<CopyTest1.InnerClass> clazz; 
  7.  
  8.     @ToString 
  9.     @Data 
  10.     public static classInnerClass{ 
  11.         public String InnerName; 
  12.     } 
  13. @ToString 
  14. @Data 
  15. public classCopyTest2{ 
  16.     public String outerName; 
  17.     public CopyTest2.InnerClass innerClass; 
  18.     public List<CopyTest2.InnerClass> clazz; 
  19.  
  20.     @ToString 
  21.     @Data 
  22.     public static classInnerClass{ 
  23.         public String InnerName; 
  24.     } 
  25.         CopyTest1 test1 = new CopyTest1(); 
  26.         test1.outerName = "hahaha"; 
  27.         CopyTest1.InnerClass innerClass = new CopyTest1.InnerClass(); 
  28.         innerClass.InnerName = "hohoho"; 
  29.         test1.innerClass = innerClass; 
  30.  
  31.         System.out.println(test1.toString()); 
  32.         CopyTest2 test2 = new CopyTest2(); 
  33.         BeanUtils.copyProperties(test1, test2); 
  34.  
  35.         System.out.println(test2.toString()); 

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

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

  1. CopyTest1 test1 = new CopyTest1(); 
  2.         test1.outerName = "hahaha"; 
  3.         CopyTest1.InnerClass innerClass = new CopyTest1.InnerClass(); 
  4.         innerClass.InnerName = "hohoho"; 
  5.         test1.innerClass = innerClass; 
  6.  
  7.         System.out.println(test1.toString()); 
  8.         CopyTest2 test2 = new CopyTest2(); 
  9.         test2.innerClass = new CopyTest2.InnerClass(); 
  10.         BeanUtils.copyProperties(test1, test2); 
  11.         BeanUtils.copyProperties(test1.innerClass, test2.innerClass); 
  12.  
  13.         System.out.println(test2.toString()); 

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

#p#副标题#e#

其实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方法是不行滴。

  1. privatestaticvoid copyProperties(Object source, Object target, @Nullable Class<?> editable, @Nullable String... ignoreProperties) throws BeansException { 
  2.         Assert.notNull(source, "Source must not be null"); 
  3.         Assert.notNull(target, "Target must not be null"); 
  4.         Class<?> actualEditable = target.getClass(); 
  5.         if (editable != null) { 
  6.             if (!editable.isInstance(target)) { 
  7.                 throw new IllegalArgumentException("Target class [" + target.getClass().getName() + "] not assignable to Editable class [" + editable.getName() + "]"); 
  8.             } 
  9.  
  10.             actualEditable = editable; 
  11.         } 
  12.  
  13.         PropertyDescriptor[] targetPds = getPropertyDescriptors(actualEditable); 
  14.         List<String> ignoreList = ignoreProperties != null ? Arrays.asList(ignoreProperties) : null; 
  15.         PropertyDescriptor[] var7 = targetPds; 
  16.         int var8 = targetPds.length; 
  17.  
  18.         for(int var9 = 0; var9 < var8; ++var9) { 
  19.             PropertyDescriptor targetPd = var7[var9]; 
  20.             Method writeMethod = targetPd.getWriteMethod(); 
  21.             if (writeMethod != null && (ignoreList == null || !ignoreList.contains(targetPd.getName()))) { 
  22.                 PropertyDescriptor sourcePd = getPropertyDescriptor(source.getClass(), targetPd.getName()); 
  23.                 if (sourcePd != null) { 
  24.                     Method readMethod = sourcePd.getReadMethod(); 
  25.                     if (readMethod != null && ClassUtils.isAssignable(writeMethod.getParameterTypes()[0], readMethod.getReturnType())) { 
  26.                         try { 
  27.                             if (!Modifier.isPublic(readMethod.getDeclaringClass().getModifiers())) { 
  28.                                 readMethod.setAccessible(true); 
  29.                             } 
  30.  
  31.                             Object value = readMethod.invoke(source); 
  32.                             if (!Modifier.isPublic(writeMethod.getDeclaringClass().getModifiers())) { 
  33.                                 writeMethod.setAccessible(true); 
  34.                             } 
  35.  
  36.                             writeMethod.invoke(target, value); 
  37.                         } catch (Throwable var15) { 
  38.                             throw new FatalBeanException("Could not copy property '" + targetPd.getName() + "' from source to target", var15); 
  39.                         } 
  40.                     } 
  41.                 } 
  42.             } 
  43.         } 
  44.  
  45.     } 

dawei

【声明】:北京站长网内容转载自互联网,其相关言论仅代表作者个人观点绝非权威,不代表本站立场。如您发现内容存在版权问题,请提交相关链接至邮箱:bqsm@foxmail.com,我们将及时予以处理。