BeanUtil.copyProperties(weighBillRecord, existRecord, CopyOptions.create().setIgnoreNullValue(true))
是 Hutool 工具库中BeanUtil.copyProperties方法的一个高级用法。它通过CopyOptions参数,实现了仅拷贝源对象中非空属性的精细控制。
📘BeanUtil.copyProperties与CopyOptions详解
BeanUtil.copyProperties是 Hutool 提供的属性拷贝工具,用于将源对象的属性值复制到目标对象中。CopyOptions类则是一个配置选项,允许你精细地控制拷贝过程,比如指定忽略哪些属性、是否忽略空值等。
在你提供的代码中:BeanUtil.copyProperties(weighBillRecord, existRecord, CopyOptions.create().setIgnoreNullValue(true));
其作用是将weighBillRecord中值不为null的属性,拷贝到existRecord对象中对应的同名属性上,而weighBillRecord中为null的属性则会被忽略,不会覆盖existRecord中已有的值。
🛠️CopyOptions的核心配置项
CopyOptions提供了多个配置方法,方便你根据业务需求组合使用:
| 配置项 | 对应方法 | 作用描述 |
|---|---|---|
| 忽略空值 | setIgnoreNullValue(true) | 核心配置。当源对象的属性值为null时,不拷贝该属性,从而避免覆盖目标对象已有的非空值。 |
| 覆盖控制 | setOverride(true/false) | 当目标对象属性已有值,且源对象该属性为null时,是否用null覆盖。配合ignoreNullValue使用可实现更精细的控制。 |
| 忽略错误 | setIgnoreError(true) | 忽略拷贝过程中因字段类型不匹配等原因抛出的异常,避免整个拷贝过程中断。 |
| 忽略属性 | setIgnoreProperties("field1", "field2") | 指定一个或多个不需要拷贝的属性名称,直接忽略这些字段。 |
🎯 典型使用场景
setIgnoreNullValue(true)配置在以下场景中非常实用:
数据更新(部分更新):在更新一个实体时,只希望更新用户提交的、有值的字段,而不希望用
null去覆盖数据库中已有的数据。这正是你代码中的作用。对象合并:将两个对象的属性进行合并,以其中一个对象为主,另一个对象作为补充,且补充对象的值只在非空时才生效。
⚠️ 使用注意事项
默认是浅拷贝:
BeanUtil.copyProperties执行的是浅拷贝,对于嵌套对象(对象内的另一个对象),拷贝的是引用,而非创建一个全新的嵌套对象。依赖规范:该方法依赖于 JavaBean 规范,即需要标准的
getter和setter方法才能正常工作。类型自动转换:Hutool 会尝试对属性进行简单的类型转换(如
String和Integer互转),但如果类型完全不兼容且没有配置忽略错误,可能会抛出异常。
总的来说,你使用的这行代码就是一个在更新场景下,安全、高效地合并对象属性的典型应用,它确保了数据库中的现有数据不会因前端传递的null值而被意外清空。
