为啥不建议用BeanUtils.copyProperties拷贝数据

柔情只为你懂 2024-05-23 22:18 57阅读 0赞

## 为啥不建议用BeanUtils.copyProperties拷贝数据 ##

*  在实际的业务开发中，我们经常会碰到VO、BO、PO、DTO等对象属性之间的赋值，当属性较多的时候我们使用get，set的方式进行赋值的工作量相对较大，因此很多人会选择使用spring提供的拷贝工具BeanUtils的copyProperties方法完成对象之间属性的拷贝。通过这种方式可以很大程度上降低我们手动编写对象属性赋值代码的工作量，既然它那么方便为什么还不建议使用呢？下面是我整理的BeanUtils.copyProperties数据拷贝一些常见的**坑**。

#### **属性类型不一致导致拷贝失败** ####

*  **同一属性的类型不同**
 *  在实际开发中，很可能会出现同一字段在不同的类中定义的类型不一致，例如ID，可能在A类中定义的类型为Long，在B类中定义的类型为String，此时如果使用BeanUtils.copyProperties进行拷贝，就会出现拷贝失败的现象，导致对应的字段为null，对应案例如下：
 *      public class BeanUtilsTest {
        
            public static void main(String[] args) {
                SourcePoJo sourcePoJo = new SourcePoJo("jingdong", (long) 35711);
                TargetPoJo targetPoJo = new TargetPoJo();
                BeanUtils.copyProperties(sourcePoJo,targetPoJo);
                System.out.println(targetPoJo);
            }
        }
        @Data
        @AllArgsConstructor
        class SourcePoJo{
            private String username;
            private Long id;
        }
        
        @Data
        class TargetPoJo{
            private String username;
            private String id;
        }
 *  对应的运行结果如下：
 *  ![在这里插入图片描述][05a33689751f45c598a3e9e1a0816184.png]
 *  可以看到id字段由于类型不一致，导致拷贝后的值为null。
 *  **同一字段分别使用包装类型和基本类型**
 *  如果通一个字段分别使用包装类和基本类型,在没有传递实际值的时候，会出现异常，具体案例如下：
 *      public class BeanUtilsTest {
        
            public static void main(String[] args) {
                SourcePoJo sourcePoJo = new SourcePoJo();
                sourcePoJo.setUsername("joy");
                TargetPoJo targetPoJo = new TargetPoJo();
                BeanUtils.copyProperties(sourcePoJo,targetPoJo);
                System.out.println(targetPoJo);
            }
        }
        @Data
        class SourcePoJo{
            private String username;
            private Long id;
        }
        
        @Data
        class TargetPoJo{
            private String username;
            private long id;
        }
 *  在测试案例中，id字段在拷贝源和拷贝目标中分别使用包装类型和基本类型，可以看到下面在拷贝时出现了异常。
 *  ![在这里插入图片描述][68b568c7ce344af295263a9f35a0ffe3.png]
 *  **注意：** 如果一个布尔类型的属性分别使用了基本类型和包装类型，且属性名如果使用is开头，例如isSuccess，也会导致拷贝失败。

#### **null值覆盖导致数据异常** ####

*  在业务开发时，我们可能会有部分字段拷贝的需求，被拷贝的数据里面如果某些字段有null值存在，但是对应的需要被拷贝过去的数据的相同字段的值并不为null，如果直接使用 BeanUtils.copyProperties 进行数据拷贝，就会出现被拷贝数据的null值覆盖拷贝目标数据的字段，导致原有的数据失效。
 *  对应的案例如下：
 *      public class BeanUtilsTest {
        
            public static void main(String[] args) {
                SourcePoJo sourcePoJo = new SourcePoJo();
                sourcePoJo.setId("35711");
                TargetPoJo targetPoJo = new TargetPoJo();
                targetPoJo.setUsername("Joy");
                BeanUtils.copyProperties(sourcePoJo,targetPoJo);
                System.out.println(targetPoJo);
            }
        }
        @Data
        class SourcePoJo{
            private String username;
            private String id;
        }
        
        @Data
        class TargetPoJo{
            private String username;
            private String id;
        }
 *  对应的运行结果如下：
 *  ![在这里插入图片描述][7d29c235ca4e4af59417b09380499961.png]
 *  可以看到拷贝目标结果中原本有值的username字段，它的值被覆盖成了null。虽然可以使用 BeanUtils.copyProperties 的重载方法，配合自定义的 ConvertUtilsBean 来实现部分字段的拷贝，但是这么做本身也比较复杂，也就失去了使用BeanUtils.copyProperties 拷贝数据的意义，因此也不推荐这么做。

#### **导包错误导致拷贝数据异常** ####

*  在使用 BeanUtils.copyProperties 拷贝数据时，如果项目中同时引入了Spring的beans包和Apache的beanutils包，在导包的时候，如果导入错误，很可能导致数据拷贝失败，排查起来也不太好发现。我们通常使用的是Sping包中的拷贝方法，两者的区别如下：
 *      //org.springframework.beans.BeanUtils(源对象在左边，目标对象在右边)
        public static void copyProperties(Object source, Object target) throws BeansException 
        //org.apache.commons.beanutils.BeanUtils（源对象在右边，目标对象在左边）
        public static void copyProperties(Object dest, Object orig) throws IllegalAccessException, InvocationTargetException

#### **查找不到字段引用，修改内容难以溯源** ####

*  在开发或者排查问题过程中，如果我们在链路中查找某个字段值（**调用方并未传递**）的来源，我们可能会通过全文搜索的方式，去找它对应的赋值方法（例如set方式、build方式等），但是如果在链路中使用BeanUtils.copyProperties拷贝了数据，就很难快速定位到赋值的地方，导致排查效率较低。

#### **内部类数据无法成功拷贝** ####

*  内部类数据无法正常拷贝，及时类型和字段名均相同也无法拷贝成功，如下所示：
 *      public class BeanUtilsTest {
        
            public static void main(String[] args) {
                SourcePoJo sourcePoJo = new SourcePoJo();
                sourcePoJo.setUsername("joy");
                SourcePoJo.InnerClass innerClass = new SourcePoJo.InnerClass("sourceInner");
                sourcePoJo.innerClass=innerClass;
                System.out.println(sourcePoJo.toString());
                TargetPoJo targetPoJo = new TargetPoJo();
                BeanUtils.copyProperties(sourcePoJo,targetPoJo);
                System.out.println(targetPoJo.toString());
            }
        }
        //下面是类的信息，这里就直接放到一块展示了
        @Data
        @ToString
        public class SourcePoJo{
            private String username;
            private Long id;
            public InnerClass innerClass;
            @Data
            @ToString
            @AllArgsConstructor
            public static class InnerClass{
                public String innerName;
            }
        }
        
        @Data
        @ToString
        public class TargetPoJo{
            private String username;
            private Long id;
            public InnerClass innerClass;
            @Data
            @ToString
            public static class InnerClass{
                public String innerName;
            }
        }
 *  下面是运行结果：
 *  ![在这里插入图片描述][9d1a364d4f1d4e60b6f72614fc5ddc66.png]
 *  上面案例中，在拷贝源和拷贝目标中各自存在一个内部类InnerClass，虽然这个内部类属性也相同，类名也相同，但是在不同的类中，因此Spring会认为属性不同，因此不会拷贝数据。

#### **BeanUtils.copyProperties是浅拷贝** ####

*  这里我先给大家复习一下深拷贝和浅拷贝。
 *  **浅拷贝**是指创建一个新对象，该对象的属性值与原始对象相同，但对于引用类型的属性，仍然共享相同的引用。也就是说在浅拷贝下，当原始内容的引用属性值发生变化时，被拷贝对象的引用属性值也会随之发生变化。
 *  **深拷贝**是指创建一个新对象，该对象的属性值与原始对象相同，包括引用类型的属性。深拷贝会递归复制引用对象，创建全新的对象，所以深拷贝拷贝后的对象与原始对象完全独立。
 *  下面是对应的代码示例：
 *      public class BeanUtilsTest {
        
            public static void main(String[] args) {
                Person sourcePerson = new Person("sunyangwei",new Card("123456"));
                Person targetPerson = new Person();
                BeanUtils.copyProperties(sourcePerson, targetPerson);
                sourcePerson.getCard().setNum("35711");
                System.out.println(targetPerson);
            }
        }
        
        
        @Data
        @AllArgsConstructor
        class Card {
            private String num;
        }
        
        @NoArgsConstructor
        @AllArgsConstructor
        @Data
        class Person {
            private String name;
            private Card card;
        }
 *  下面是运行结果：
 *  ![在这里插入图片描述][5158ea8869d94fdea3a570a7ea30173f.png]
 *  **总结：** 通过代码运行结果我们可以发现，一旦你在拷贝后修改了原始对象的引用类型的数据，就会导致拷贝数据的值发生异常，这种问题排查起来也比较困难。

#### **底层实现为反射拷贝效率低** ####

*  **BeanUtils.copyProperties**底层是通过反射获取到对象的set和get方法，然后通过get、set完成数据的拷贝，整体拷贝效率较低。
 *  下面是使用**BeanUtils.copyProperties**拷贝数据和直接set的方式赋值效率对比，为了便于直观的看出效果，这里以拷贝1万次为例
 *      public class BeanUtilsTest {
        
            public static void main(String[] args) {
                long copyStartTime = System.currentTimeMillis();
                User sourceUser = new User("sunyangwei");
                User targetUser = new User();
                for(int i = 0; i < 10000; i++) {
                    BeanUtils.copyProperties(sourceUser, targetUser);
                }
                System.out.println("copy方式："+(System.currentTimeMillis()-copyStartTime));
        
                long setStartTime = System.currentTimeMillis();
                for(int i = 0; i < 10000; i++) {
                    targetUser.setUserName(sourceUser.getUserName());
                }
                System.out.println("set方式："+(System.currentTimeMillis()-setStartTime));
            }
        }
        
        @Data
        @AllArgsConstructor
        @NoArgsConstructor
        class User{
            private String userName;
        }
 *  下面是执行的效率结果对比：
 *  ![在这里插入图片描述][6b595e532ed040c19d16511dad203255.png]
 *  可以发现，常规的set和BeanUtils.copyProperties对比，性能差距非常大。因此，慎用BeanUtils.copyProperties。
 *  以上就是在使用BeanUtils.copyProperties拷贝数据时常见的坑，这些坑大多都是比较隐蔽的，出了问题不太好排查，因此不建议在业务中使用BeanUtils.copyProperties拷贝数据。文中不足之处，欢迎补充和指正。

[05a33689751f45c598a3e9e1a0816184.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/23/058388e50f35416eada15ce33586695a.png
[68b568c7ce344af295263a9f35a0ffe3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/23/cadc4e9ef2ee44558cc554682a9e5b23.png
[7d29c235ca4e4af59417b09380499961.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/23/02f39ec4d8694f93a81729e245dbecea.png
[9d1a364d4f1d4e60b6f72614fc5ddc66.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/23/5b48a95293554ad4bde17a002a57cb0a.png
[5158ea8869d94fdea3a570a7ea30173f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/23/0526a0151992456aa626b06027a5abaf.png
[6b595e532ed040c19d16511dad203255.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/23/d3f45cca715e42d4936a9da76fb388be.png