Java使用BeanUtils.copyProperties实现对象的拷贝

pan_junbiao

已于 2024-09-30 17:51:02 修改

阅读量1k

点赞数 29

分类专栏： Java 我の原创文章标签： java 开发语言

于 2024-09-30 17:27:48 首次发布

本文链接：https://blog.csdn.net/pan_junbiao/article/details/142659184

版权

我の原创同时被 2 个专栏收录

539 篇文章 29 订阅

订阅专栏

Java

91 篇文章 16 订阅

订阅专栏

1、BeanUtils.copyProperties() 方法的使用

BeanUtils.copyProperties 方法是 Java 中 Spring 框架提供的一个非常实用的工具方法，它用于将一个 JavaBean 对象的属性值拷贝到另一个 JavaBean 对象中。这个方法主要用于简化对象之间的数据转换过程，尤其是在处理具有大量相同属性的对象时，可以大大减少代码量，提高开发效率。

语法格式：

BeanUtils.copyPropertiescopyProperties(Object source, Object target)

参数说明：

source：源对象，属性值从这个对象中提取。

target：目标对象，将属性值复制到这个对象中。

【实例】使用 BeanUtils.copyProperties() 方法，实现用户信息类的拷贝。

（1）创建 UserInfo 类（用户信息实体类）。

package com.pjb.pm.entity;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 用户信息实体类
 * @author pan_junbiao
 **/
@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserInfo
{
    private Long userId;       //用户ID
    private String userName;   //用户名称
    private BlogInfo blogInfo; //博客信息
}

（2）创建 BlogInfo 类（博客信息实体类）。

package com.pjb.pm.entity;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 博客信息实体类
 * @author pan_junbiao
 **/
@Data
@NoArgsConstructor
@AllArgsConstructor
public class BlogInfo
{
    private String blogName; //博客名称
    private String blogUrl; //博客地址
}

（3）创建 UserModel 类（用户信息模型类）。

package com.pjb.pm.model;

import com.pjb.pm.entity.BlogInfo;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 用户信息模型类
 * @author pan_junbiao
 **/
@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserModel
{
    private Long userId;       //用户ID
    private String userName;   //用户名称
    private BlogInfo blogInfo; //博客信息
}

（4）使用 BeanUtils.copyProperties() 方法实现对象的拷贝。

package com.pjb.pm;

import com.pjb.pm.entity.BlogInfo;
import com.pjb.pm.entity.UserInfo;
import com.pjb.pm.model.UserModel;
import org.junit.jupiter.api.Test;
import org.springframework.beans.BeanUtils;
import org.springframework.boot.test.context.SpringBootTest;

/**
 * 用户信息测试类
 * @author pan_junbiao
 **/
@SpringBootTest
public class UserModelTest
{
    @Test
    public void copyUserTest()
    {
        //创建用户信息
        BlogInfo blogInfo = new BlogInfo("您好，欢迎访问 pan_junbiao的博客", "https://blog.csdn.net/pan_junbiao");
        UserInfo userInfo = new UserInfo(1L, "pan_junbiao的博客", blogInfo); //源对象

        //对象拷贝
        UserModel userModel = new UserModel(); //目标对象
        BeanUtils.copyProperties(userInfo, userModel);
        System.out.println(userModel);
    }
}

执行结果：

UserModel(userId=1, userName=pan_junbiao的博客, 
blogInfo=BlogInfo(blogName=您好，欢迎访问 pan_junbiao的博客, blogUrl=https://blog.csdn.net/pan_junbiao))

从控制台输出的结果可以看出，目标对象的拷贝成功。

2、BeanUtils.copyProperties() 方法的坑

BeanUtils.copyProperties() 方法在 Java 开发中虽然非常实用，但也存在一些需要注意的“坑”，这些坑可能会导致属性拷贝失败或产生意外的结果。以下是一些常见的坑点：

2.1 属性的类型不一致，导致拷贝失败

如果源对象和目标对象的属性类型不一致，BeanUtils.copyProperties() 方法将不会赋值成功。例如，源对象的某个属性是Long类型，而目标对象的对应属性是String类型，这将导致拷贝失败。

（1）创建一个新的模型类：BlogModel 类（博客信息模型类）。

package com.pjb.pm.model;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 博客信息模型类
 * @author pan_junbiao
 **/
@Data
@NoArgsConstructor
@AllArgsConstructor
public class BlogModel
{
    private String blogName; //博客名称
    private String blogUrl; //博客地址
}

（2）修改 UserModel 类，将“博客信息”字段的属性类型由原来的 BlogInfo 类，改成上述新建的 BlogModel 类。

/**
 * 用户信息模型类
 * @author pan_junbiao
 **/
@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserModel
{
    private Long userId;       //用户ID
    private String userName;   //用户名称
    //private BlogInfo blogInfo; //博客信息（属性类型相同，所有拷贝成功）
    private BlogModel blogInfo; //博客信息（属性类型不相同，所有拷贝失败）
}

（3）使用 BeanUtils.copyProperties() 方法实现对象的拷贝。

@Test
public void copyUserTest()
{
    //创建用户信息
    BlogInfo blogInfo = new BlogInfo("您好，欢迎访问 pan_junbiao的博客", "https://blog.csdn.net/pan_junbiao");
    UserInfo userInfo = new UserInfo(1L, "pan_junbiao的博客", blogInfo); //源对象

    //对象拷贝
    UserModel userModel = new UserModel(); //目标对象
    BeanUtils.copyProperties(userInfo, userModel);
    System.out.println(userModel);
}

执行结果：

从控制器输出的结果可以看出，由于属性的类型不一致，导致拷贝失败。

2.2 浅拷贝问题

BeanUtils.copyProperties() 方法执行的是浅拷贝。对于引用类型的属性，只复制了引用地址，而没有复制对象本身。因此，如果源对象和目标对象中的某个引用类型属性指向同一个对象，修改其中一个对象的该属性将影响另一个对象。

当执行拷贝完成后，修改源对象中的某个属性的值。

@Test
public void copyUserTest()
{
    //创建用户信息
    BlogInfo blogInfo = new BlogInfo("您好，欢迎访问 pan_junbiao的博客", "https://blog.csdn.net/pan_junbiao");
    UserInfo userInfo = new UserInfo(1L, "pan_junbiao的博客", blogInfo); //源对象

    //对象拷贝
    UserModel userModel = new UserModel(); //目标对象
    BeanUtils.copyProperties(userInfo, userModel);

    //执行拷贝完成后，修改源对象中的某个属性的值
    userInfo.getBlogInfo().setBlogUrl("XXXXXXXXX");
    System.out.println(userInfo); //源对象
    System.out.println(userModel); //目标对象
}

执行结果：

源对象：
UserInfo(userId=1, userName=pan_junbiao的博客, 
blogInfo=BlogInfo(blogName=您好，欢迎访问 pan_junbiao的博客, blogUrl=XXXXXXXXX))

目标对象：
UserModel(userId=1, userName=pan_junbiao的博客, 
blogInfo=BlogInfo(blogName=您好，欢迎访问 pan_junbiao的博客, blogUrl=XXXXXXXXX))

从控制器输出的结果可以看出，当修改了源对象的属性值后，目标对象对应的属性值也改变了。这是由于浅拷贝问题。对于引用类型的属性，只复制了引用地址，而没有复制对象本身。

3、闭坑总结

以下是一些常见的坑点：

（1）类型不匹配：

（2）属性名称不一致：

属性名称必须完全一致（包括大小写）才能成功拷贝。如果源对象和目标对象的属性名称存在细微差别（如大小写不同、缺少或多余的字母等），则这些属性将不会被拷贝。

（3）浅拷贝问题：

（4）Null值覆盖：

默认情况下，如果源对象的某个属性值为 null，则 BeanUtils.copyProperties() 方法会将该 null 值覆盖到目标对象的对应属性上。这可能会导致目标对象中的有效数据被意外覆盖。

（5）Boolean 类型和 is 属性开头的坑：

当使用 Lombok 等库自动生成 getter 方法时，如果 Boolean 类型的属性以 is 开头（如：isActive），则生成的 getter 方法可能是 isActive() 而不是 getActive()。BeanUtils.copyProperties() 方法在寻找对应的 getter 方法时可能会找不到，导致拷贝失败。

（6）内部类拷贝问题：

当对象中包含内部类时，BeanUtils.copyProperties() 方法在处理内部类属性时可能会出现拷贝失败的情况。这是因为内部类的实例化和属性访问可能受到外部类实例的约束。

（7）包引入冲突：

在 Java 中，BeanUtils 类有多个实现，如 Apache 的 commons-beanutils 和 Spring 的 BeanUtils。如果项目中同时引入了这两个库，并且没有正确区分它们的包路径，可能会导致意外的错误。

（8）性能问题：

由于 BeanUtils.copyProperties() 方法使用了反射机制，因此在处理大量数据拷贝时可能会成为性能瓶颈。对于性能要求较高的场景，可以考虑使用其他更高效的方式（如手动拷贝、使用序列化/反序列化等）。