変更を分離するために、開発では、 DAO によって照会されたDO を、フロントエンドに提供された DTO から分離することがよくありますが、それらの構造は類似しています。b.setFiled(a.getFiled()) のような長いコードをたくさん書くのは面倒で無意味です。そのため、オブジェクトのコピー方法を単純化する必要があります。ほとんどの場合、Apache または Spring の BeanUtils が使用されますが、プロパティをコピーする別のより効率的な方法があります: BeanCopier です。

1. 背景

1️⃣ オブジェクトコピーの概念
Java では、データ型は値型 (基本データ型) と参照型に分けられます。オブジェクトのコピーは、シャローコピー (shallow clone) とディープコピー (deep clone)に分けられます。

シャローコピーとディープコピーの違い

2️⃣ 例題前の準備。ソースオブジェクト属性クラス UserDO.class (次の例では、すべてのソースオブジェクトがこれを使用します)

@Data
public class UserDO {
    
        
  private int id;    
  private String userName;    
  private LocalDateTime gmtBroth;    
  private BigDecimal balance;    
  public UserDO(Integer id, String userName, LocalDateTime gmtBroth, BigDecimal balance) {
    
            
    this.id = id;        
    this.userName = userName;        
    this.gmtBroth = gmtBroth;        
    this.balance = balance;    
  }
}

データツールクラス DataUtil を作成する

public class DataUtil {
    
        
  /**    
     * 模拟查询出一条数据     
      * @return     
      */    
  public static UserDO createData() {
    
            
    return new UserDO(1, "Van", LocalDateTime.now(),new BigDecimal(100L));    
  }    
  /**       
      * 模拟查询出多条数据     
      * @param num 数量     
      * @return     
      */    
  public static List<UserDO> createDataList(int num) {
    
            
    List<UserDO> userDOS = new ArrayList<>();        
    for (int i = 0; i < num; i++) {
    
                
    UserDO userDO = new UserDO(i+1, "Van", LocalDateTime.now(),new BigDecimal(100L));            
    userDOS.add(userDO);        
  }        
    return userDOS;    
 }
}

2.オブジェクトコピー用BeanUtils

Apache と Spring の両方に BeanUtils ツールクラスがあります. Apache の BeanUtils は安定しておらず効率的ではありません. Spring の BeanUtils は比較的安定しており, 量が多いため時間的に大幅に増加しないため, Spring の BeanUtils が一般的に使用されます.

1️⃣
Spring での BeanUtils のソースコードの解釈。実装方法は非常に単純です。つまり、2 つのオブジェクトで同じ名前の属性を取得/設定し、属性のアクセシビリティのみをチェックするだけです。メンバー変数の代入は対象オブジェクトのメンバーリストを元に行い、ソースオブジェクトに存在しないものは無視してスキップするため、この方法は安全であり、2 つのオブジェクトの構造の違いによるエラーは発生しませんが、保証する必要があります。同じ名前の 2 つのメンバ変数が同じ型です。

2️⃣例

@Slf4j
public class BeanUtilsDemo {
    
        
  public static void main(String[] args) {
    
            
    long start = System.currentTimeMillis();        
    UserDO userDO = DataUtil.createData();        
    log.info("拷贝前，userDO:{}", userDO);        
    UserDTO userDTO = new UserDTO();
    BeanUtils.copyProperties(userDO,userDTO);        
    log.info("拷贝后，userDO:{}", userDO);
  long end = System.currentTimeMillis();  
   }
}

結果

18:12:11.734 [main] INFO cn.van.parameter.bean.copy.demo.BeanUtilsDemo 
- 拷贝前，userDO:UserDO(id=1, userName=Van, gmtBroth=2019-11-02T18:12:11.730, balance=100)
18:12:11.917 [main] INFO cn.van.parameter.bean.copy.demo.BeanUtilsDemo 
- 拷贝后，userDO:UserDO(id=1, userName=Van, gmtBroth=2019-11-02T18:12:11.730, balance=100)

3.オブジェクトコピー用のBeanCopier

BeanCopier は、2 つの Bean 間でプロパティをコピーするために使用されます。BeanCopier は 2 つの方法をサポートします:
1️⃣1 つは、Converter を使用せず、2 つの Bean 間で同じプロパティ名と型を持つ変数のみをコピーする方法、
2️⃣もう 1 つは、特定の特定のプロパティ値に対して特別な操作を実行できる Converter を導入する方法です。

基本的な使い方

頼る

<dependency>    
<groupId>cglib</groupId>    
<artifactId>cglib-nodep</artifactId>    
<version>3.3.0</version>
</dependency>

注: cglib はSpring に統合されており、この記事では org.springframework.cglib.beans.BeanCopier を使用しているため、この依存関係は必要ありません。

3.1.1 属性名と型が同じ

対象オブジェクトの属性クラス

@Data
public class UserDTO {
    
        
  private int id;    
  private String userName;
}

試験方法

/** * 属性名称、类型都相同(部分属性不拷贝) */
private static void normalCopy() {
    
    	
// 模拟查询出数据    
UserDO userDO = DataUtil.createData();    
log.info("拷贝前，userDO:{}", userDO);    
//第一个参数：源对象。
//第二个参数：目标对象。
//第三个参数：是否使用自定义转换器（下面会介绍），下同    
BeanCopier b = BeanCopier.create(UserDO.class, UserDTO.class, false);    
UserDTO userDTO = new UserDTO();    
b.copy(userDO, userDTO, null);    
log.info("拷贝后，userDTO:{}", userDTO);
}

結果: 正常にコピーされました

18:24:24.080 [main] INFO cn.van.parameter.bean.copy.demo.BeanCopierDemo 
- 拷贝前，userDO:UserDO(id=1, userName=Van, gmtBroth=2019-11-02T18:24:24.077, balance=100)
18:24:24.200 [main] INFO cn.van.parameter.bean.copy.demo.BeanCopierDemo 
- 拷贝后，userDTO:UserDTO(id=1, userName=Van)

3.1.2 プロパティ名は同じだがタイプが異なる

対象オブジェクトの属性クラス

@Data
public class UserEntity {
    
        
  private Integer id;    
  private String userName;
}

試験方法

/** * 属性名称相同、类型不同 */
private static void sameNameDifferentType() {
    
        
// 模拟查询出数据    
UserDO userDO = DataUtil.createData();    
log.info("拷贝前，userDO:{}", userDO);    
BeanCopier b = BeanCopier.create(UserDO.class, UserEntity.class, false);
UserEntity userEntity = new UserEntity();    
b.copy(userDO, userEntity, null);    
log.info("拷贝后，userEntity:{}", userEntity);}

結果

19:43:31.645 [main] INFO cn.van.parameter.bean.copy.demo.BeanCopierDemo 
- 拷贝前，userDO:UserDO(id=1, userName=Van, gmtBroth=2019-11-02T19:43:31.642, balance=100)
19:43:31.748 [main] INFO cn.van.parameter.bean.copy.demo.BeanCopierDemo 
- 拷贝后，userEntity:UserEntity(id=null, userName=Van)

分析
ログから、UserDO の int 型 ID を UserEntity の Integer ID にコピーできないことがわかります。

3.1.3 セクション

BeanCopier は、同じ名前とタイプのプロパティのみをコピーします。

ソース型がプリミティブ型 (int、short、char など) であっても、ターゲット型がそのラッパー型 (Integer、Short、Character など) である場合、またはその逆の場合: コピーされません。

3.2 カスタムコンバーター

3.1.2 によると、コピー元とコピー先のクラスの属性の型が異なる場合、属性をコピーすることはできません. このとき、Converter インターフェイスを実装することで、コンバーターをカスタマイズできます。

3.2.1 準備

対象オブジェクトの属性クラス

@Data
public class UserDomain {
    
        
  private Integer id;    
  private String userName;        
/**     
    * 以下两个字段用户模拟自定义转换    
    */    
  private String gmtBroth;    
  private String balance;
}

3.2.2 コンバータなし

試験方法

/** * 类型不同,不使用Converter */
public static void noConverterTest() {
    
        
  // 模拟查询出数据    
  UserDO userDO = DataUtil.createData();   
  log.info("拷贝前，userDO:{}", userDO);    
  BeanCopier copier = BeanCopier.create(UserDO.class, UserDomain.class, false);
  UserDomain userDomain = new UserDomain();    
  copier.copy(userDO, userDomain, null);    
  log.info("拷贝后，userDomain:{}", userDomain);}

結果

19:49:19.294 [main] INFO cn.van.parameter.bean.copy.demo.BeanCopierDemo 
- 拷贝前，userDO:UserDO(id=1, userName=Van, gmtBroth=2019-11-02T19:49:19.290, balance=100)
19:49:19.394 [main] INFO cn.van.parameter.bean.copy.demo.BeanCopierDemo 
- 拷贝后，userDomain:UserDomain(id=null, userName=Van, gmtBroth=null, balance=null)

分析
前後に印刷されたログを比較すると、属性タイプが異なるフィールド id、gmtBroth、および残高がコピーされていません。

3.2.3 コンバーターの使用

Converter インターフェイスを実装して、属性変換をカスタマイズする

public  class UserConverter implements Converter {
    
        
   /**    
     * 时间转换的格式    
     */    
  DateTimeFormatter dtf = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");    
  /**    
    * 自定义属性转换    
    * @param value 源对象属性类     
    * @param target 目标对象里属性对应set方法名,eg.setId     
    * @param context 目标对象属性类   
    * @return     
    */    
  @Override
  public Object convert(Object value, Class target, Object context) {
    
         
     if (value instanceof Integer) {
    
                
        return value;      
     } else if (value instanceof LocalDateTime) {
    
          
        LocalDateTime date = (LocalDateTime) value;      
        return dtf.format(date);     
     } else if (value instanceof BigDecimal) {
    
                
        BigDecimal bd = (BigDecimal) value;       
        return bd.toPlainString();      
     }       
   return value;  
  }
}

試験方法

/** 
  * 类型不同,使用Converter 
  */
public static void converterTest() {
    
        
  // 模拟查询出数据    
  UserDO userDO = DataUtil.createData();    
  log.info("拷贝前，userDO:{}", userDO);    
  BeanCopier copier = BeanCopier.create(UserDO.class, UserDomain.class, true);
  UserConverter converter = new UserConverter();    
  UserDomain userDomain = new UserDomain();    
  copier.copy(userDO, userDomain, converter);    
  log.info("拷贝后：userDomain:{}", userDomain);
}

結果: すべてコピー

19:51:11.989 [main] INFO cn.van.parameter.bean.copy.demo.BeanCopierDemo 
- 拷贝前，userDO:UserDO(id=1, userName=Van, gmtBroth=2019-11-02T19:51:11.985, balance=100)

3.2.4 セクション

Converter が使用されると、BeanCopier は Converter によって定義されたルールのみを使用してプロパティをコピーするため、すべてのプロパティを convert() メソッドで考慮する必要があります。
ただし、Converter を使用すると、オブジェクトのコピーが遅くなります。

3.3 BeanCopier の概要

ソースクラスとターゲットクラスの属性名と型が同じであれば、コピーしても問題ありません。
ソースオブジェクトとターゲットオブジェクトの属性が同じ名前でタイプが異なる場合、同じ名前でタイプが異なる属性はコピーされません。プリミティブ型 (int、short、char) とそのラッパー型は、ここでは別の型として扱われるため、コピーされないことに注意してください。
ソースクラスまたはターゲットクラスは、getter よりも setter が少なく、コピーは問題ありません。この時点で、setter は冗長ですが、エラーは報告されません。
ソースクラスとターゲットクラスのプロパティは同じですが (両方のゲッターが存在します)、ターゲットクラスのセッターが存在せず、この時点で NullPointerException がスローされます。

4. BeanUtils と BeanCopier の速度比較

4.1 BeanUtils

テストコード

private static void beanUtil() {
    
        
  List<UserDO> list = DataUtil.createDataList(10000);    
  long start = System.currentTimeMillis();    
  List<UserDTO> dtoList = new ArrayList<>();    
  list.forEach(userDO -> {
    
      UserDTO userDTO = new UserDTO();
  BeanUtils.copyProperties(userDO,userDTO);
  dtoList.add(userDTO);    
  });    
  log.info("BeanUtils cotTime: {}ms", System.currentTimeMillis() - start);
}

結果 (所要時間: 232ms)

20:14:24.380 [main] INFO cn.van.parameter.bean.copy.demo.BeanCopyComparedDemo 
- BeanUtils cotTime: 232ms

4.2 BeanCopier

テストコード

private static void beanCopier() {
    
        
  // 工具类生成10w条数据    
  List<UserDO> doList = DataUtil.createDataList(10000);    
  long start = System.currentTimeMillis();    
  List<UserDTO> dtoList = new ArrayList<>();    
  doList.forEach(userDO -> {
    
            
  BeanCopier b = BeanCopier.create(UserDO.class, UserDTO.class, false);
  UserDTO userDTO = new UserDTO();        
  b.copy(userDO, userDTO, null);        
  dtoList.add(userDTO);    });    
  log.info("BeanCopier costTime: {}ms", System.currentTimeMillis() - start);
}

結果 (所要時間: 116ms)

20:15:24.380 [main] INFO cn.van.parameter.bean.copy.demo.BeanCopyComparedDemo 
- BeanCopier costTime: 116ms

4.3 BeanCopier インスタンスをキャッシュしてパフォーマンスを向上させる

BeanCopier のコピー速度は速く、パフォーマンスのボトルネックは BeanCopier インスタンスを作成するプロセスに現れます。したがって、作成した BeanCopier インスタンスをキャッシュに入れておくと、次回から直接取得できるため、パフォーマンスが向上します。

テストコード

private static void beanCopierWithCache() {
    
        
    List<UserDO> userDOList = DataUtil.createDataList(10000);    
    long start = System.currentTimeMillis();    
    List<UserDTO> userDTOS = new ArrayList<>();    
    userDOList.forEach(userDO -> {
    
            
    UserDTO userDTO = new UserDTO();        
    copy(userDO, userDTO);        
    userDTOS.add(userDTO);    
    });    
    log.info("BeanCopier 加缓存后 costTime: {}ms", System.currentTimeMillis() - start);}
public static void copy(Object srcObj, Object destObj) {
    
        
    String key = genKey(srcObj.getClass(), destObj.getClass());    
    BeanCopier copier = null;    
    if (!BEAN_COPIERS.containsKey(key)) {
    
            
      copier = BeanCopier.create(srcObj.getClass(), destObj.getClass(), false);
      BEAN_COPIERS.put(key, copier);    
    } else {
    
            
      copier = BEAN_COPIERS.get(key);    
    }    
    copier.copy(srcObj, destObj, null);
}
private static String genKey(Class<?> srcClazz, Class<?> destClazz) {
    
        
    return srcClazz.getName() + destClazz.getName();
}

結果 (時間がかかる: 6ms)

20:32:31.405 [main] INFO cn.van.parameter.bean.copy.demo.BeanCopyComparedDemo 
- BeanCopier 加缓存后 costTime: 6ms

BeanCopier、BeanUtils オブジェクトのプロパティのコピー