BeanUtils.copyProperties復(fù)制不生效的解決

更新時間：2021年09月01日 09:45:30 作者：藍風9

這篇文章主要介紹了BeanUtils.copyProperties復(fù)制不生效的解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

前言

呵呵前端時間使用 BeanUtils.copyProperties 的時候碰到了一個這樣的問題

我有兩個實體, 有同樣的屬性, 一個有給定的屬性的 getter, 另外一個有給定的屬性的 setter, 但是我使用 BeanUtils.copyProperties 的時候把來源對象的這個屬性復(fù)制不到目標對象上面

然后當時也跟蹤了一下代碼, 然后這里整理一下改代碼片段吧

然后在調(diào)試的過程中也發(fā)現(xiàn)了一些其他的問題, 呵呵算是額外的了解吧

一下代碼基于 : jdk1.8.0_211 + commons-beanutils 1.9.4

問題的排查

首先來一段測試用例, 里面主要包含了三個類, 一個測試類, 兩個實體類

package com.hx.test03;  
import org.apache.commons.beanutils.BeanUtils; 
/**
 * Test24BeanUtilsCopy
 *
 * @author Jerry.X.He <970655147@qq.com>
 * @version 1.0
 * @date 2020-02-25 16:55
 */
public class Test24BeanUtilsCopy {
 
  // Test24BeanUtilsCopy
  // 1. 取的 source 的 propertyDescriptor
  // 2. get, set 對應(yīng)的類型不匹配
  public static void main(String[] args) throws Exception {
 
    Test24ImmutableEntity fromImmutable = new Test24ImmutableEntity("fromImmutable");
    Test24MutableEntity fromMutable = new Test24MutableEntity("fromMutable");
    Test24MutableEntity targetEntity = new Test24MutableEntity("targetEntity");
 
    // does't work
    BeanUtils.copyProperties(targetEntity, fromImmutable);
    System.out.println(targetEntity.getAttr());
    // does't work
    BeanUtils.copyProperties(targetEntity, fromMutable);
    System.out.println(targetEntity.getAttr()); 
  }
}

package com.hx.test03; 
/**
 * ImmutablePayment
 *
 * @author Jerry.X.He <970655147@qq.com>
 * @version 1.0
 * @date 2020-02-25 16:32
 */
public class Test24ImmutableEntity {
 
  // attr
  private final String attr;
 
  public Test24ImmutableEntity(String attr) {
    this.attr = attr;
  }
 
  public String getAttr() {
    return attr;
  } 
}

package com.hx.test03; 
import java.util.Optional; 
/**
 * ImmutablePayment
 *
 * @author Jerry.X.He <970655147@qq.com>
 * @version 1.0
 * @date 2020-02-25 16:32
 */
public class Test24MutableEntity {
 
  // attr
  private String attr;
 
  public Test24MutableEntity(String attr) {
    this.attr = attr;
  }
 
  public Optional<String> getAttr() {
    return Optional.of(attr);
  }
 
//  public String getAttr() {
//    return attr;
//  }
 
  public void setAttr(String attr) {
    this.attr = attr;
  } 
}

以上測試代碼輸出結(jié)果為 :

從測試代碼中可以看到這里有兩個 BeanUtils.copyProperties 的使用, 并且兩個都沒有拷貝成功, 我們一個一個的來看

首先是第一個 BeanUtils.copyProperties, 來源對象和目標對象分別為 ImmutableEntity 和 MutableEntity

ImmutableEntity 上面有 getAttr, MutableEntity 上面有 setAttr, 但是為什么沒有拷貝成功呢 ?

在下圖的地方打一個斷點調(diào)試一下

調(diào)試發(fā)現(xiàn) 源對象是可讀的, 但是目標對象不可寫?, 為什么呢?, 我們的 MutableEntity 不是有 setAttr 么

在 processPropertyDescriptor 方法之后, 我們發(fā)現(xiàn) attr 屬性, 居然不可寫了 ?

具體到 processPropertyDescriptor 方法, 他主要干的事情是

// 1. 尋找 getter(存在多個merge) 
// First pass. Find the latest getter method. Merge properties
// of previous getter methods.
 
// 2. 尋找 setter(存在多個merge) 
// Second pass. Find the latest setter method which
// has the same type as the getter method.
 
// 3. merge getter & setter 
// At this stage we should have either PDs or IPDs for the
// representative getters and setters. The order at which the
// property descriptors are determined represent the
// precedence of the property ordering.

以上注釋來自于 Introspector.java, 1, 2, 3 的注釋來自于我

我們這里重點關(guān)注 step2, 需要找到類型匹配 getter 類型的 setter 方法, 但是我們這里的情況是 getter 返回值是 Optional, setter 返回值是 String, 因此類型不匹配所以我們上面看到的結(jié)果是有 getter, 沒得 setter

實際的上下文信息如下圖

以上便是第一個 BeanUtils.copyProperties 不生效的原因了

第二個 BeanUtils.copyProperties, 原因也是同上, 不過直觀的理解來說, attr 是有 getter 并且有 setter 的, 但是由于規(guī)范的約定, 因此 propertyDescriptor 里面有 getter, 沒得 setter

問題的擴展

package com.hx.test03;  
import org.apache.commons.beanutils.BeanUtils; 
/**
 * BeanUtilsCopy
 *
 * @author Jerry.X.He <970655147@qq.com>
 * @version 1.0
 * @date 2020-02-24 12:49
 */
public class Test23BeanUtilsCopy {
 
  // Test23BeanUtilsCopy
  // 1. 取的 source 的 propertyDescriptor
  // 2. get, set 對應(yīng)的類型不匹配
  public static void main(String[] args) throws Exception { 
    ImmutableEntity fromImmutable = new ImmutableEntity("fromImmutable");
    MutableEntity fromMutable = new MutableEntity("fromMutable");
    MutableEntity targetEntity = new MutableEntity("targetEntity");
 
    // does't work
    BeanUtils.copyProperties(targetEntity, fromImmutable);
    System.out.println(targetEntity.getAttr());
    // does't work
    BeanUtils.copyProperties(targetEntity, fromMutable);
    System.out.println(targetEntity.getAttr()); 
  }
}
 
/**
 * ImmutablePayment
 *
 * @author Jerry.X.He <970655147@qq.com>
 * @version 1.0
 * @date 2020-02-24 12:50
 */
class ImmutableEntity {
  // attr
  private final String attr;
 
  public ImmutableEntity(String attr) {
    this.attr = attr;
  }
 
  public String getAttr() {
    return attr;
  }
}
 
/**
 * MutablePayment
 *
 * @author Jerry.X.He <970655147@qq.com>
 * @version 1.0
 * @date 2020-02-24 12:54
 */
class MutableEntity {
  // attr
  private String attr;
 
  public MutableEntity(String attr) {
    this.attr = attr;
  }
 
//  public Optional<String> getAttr() {
//    return Optional.of(attr);
//  }
  public String getAttr() {
    return attr;
  }
 
  public void setAttr(String attr) {
    this.attr = attr;
  }
}

我們吧如上代碼整理到同一個文件中(這其實才是第一個 demo, 上文中的是第二個 demo), 并且調(diào)整了 MutableEntity.getter 使其和 setter 的類型能夠匹配

但是我們一跑, 發(fā)現(xiàn)結(jié)果還是有些出人意料