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

最新推荐文章于 2024-09-30 17:27:48 发布
原创 最新推荐文章于 2024-09-30 17:27:48 发布 · 1.1k 阅读 · 17 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#数据库

本文讨论了在业务开发中，虽然BeanUtils.copyProperties便于快速赋值，但因其可能导致类型不一致、null值问题和反射效率低等缺点，推荐使用MapperStruct。MapperStruct基于预编译提供更快的性能，且支持自定义配置。

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

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

我总结为以下几点：

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

    在实际开发中，很可能会出现同一字段在不同的类中定义的类型不一致，例如Id，可能在A类中定义的类型为Long，在B类中定义的类型为String，此时如果使用BeanUtils.copyProperties进行拷贝，就会出现拷贝失败的现象，导致对应的字段为null

  • 同一字段分别使用包装类型和基本类型

    如果同一个字段分别使用包装类和基本类型，在没有传递实际值的时候，会出现异常

    注意，如果一个布尔类型的属性分别使用了基本类型和包装类型，且属性名如果使用is开头，例如isSuccess，也会导致拷贝失败

  • null值覆盖导致数据异常

    在业务开发时，我们可能会有部分字段拷贝的需求，被拷贝的数据里面如果某些字段有null值存在，但是对应的需要被拷贝过去的数据的相同字段的值并不为null，如果直接使用 BeanUtils.copyProperties 进行数据拷贝，就会出现被拷贝数据的null值覆盖拷贝目标数据的字段，导致原有的数据失效

    简单举个例子，我有一个BO(已经存在了A属性且有值)，需要拷贝DTO中除了A属性的其他属性(DTO中的A属性为null)，此时使用BeanUtils.copyProperties就会导致BO中的A属性的值被DTO中A的null给覆盖了

    虽然可以使用 BeanUtils.copyProperties 的重载方法，配合自定义的 ConvertUtilsBean 来实现部分字段的拷贝，但是这么做本身也比较复杂，也就失去了使用BeanUtils.copyProperties 拷贝数据的意义，因此也不推荐这么做。

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

  • 导包错误导致拷贝数据异常

具体更加详细的可以去看这篇文章 ：为啥不建议用BeanUtils.copyProperties拷贝数据 | 京东云技术团队 - 掘金 (juejin.cn)

为什么使用MapperStruct

为什么使用MapperStruct? ---> 快，对就是因为很快，性能比BeanUtils.copyProperties快很多很多

放张参考图给大家参考

image.png

 那么为什么MapperStruct比BeanUtils.copyProperties快?

  • 避免了反射操作的性能开销
  • 预编译的高效代码执行更快 (看到这里就懵了，预编译？咋回事啊到底)

什么是预编译? --- 在项目启动的时候，自动帮你生成对象拷贝的代码，拒绝使用的时候才去通过反射调用get/set...

具体的可以往下看

 

java
 

复制代码
 

@Generated( value = "org.mapstruct.ap.MappingProcessor", date = "2024-02-07T00:50:05+0800", comments = "version: 1.4.2.Final, compiler: javac, environment: Java 1.8.0_211 (Oracle Corporation)" ) public class XXXDTOConverterImpl implements XXXDTOConverter { @Override public XXXBO convertDtoToBo(XXXDTO XXXDTO) { if ( XXXDTO == null ) { return null; } XXXBO XXXBO = new XXXBO(); XXXBO.setId( XXXDTO.getId() ); XXXBO.setLabelName( XXXDTO.getLabelName() ); XXXBO.setSortNum( XXXDTO.getSortNum() ); XXXBO.setCategoryId( XXXDTO.getCategoryId() ); return XXXBO; } } 
 

怎么使用MapperStruct
 

Maven引入依赖
 

 

xml
 

复制代码
 

<dependency> <groupId>org.mapstruct</groupId> <artifactId>mapstruct</artifactId> <version>1.4.2.Final</version> </dependency> <dependency> <groupId>org.mapstruct</groupId> <artifactId>mapstruct-processor</artifactId> <version>1.4.2.Final</version> </dependency> 
 

编写代码
 

 

java
 

复制代码
 

@Data public class SubjectLabelDTO implements Serializable { private String labelName; } @Data public class SubjectLabelBO implements Serializable { private String labelName; } 
 

 

java
 

复制代码
 

@Mapper public interface SubjectLabelDTOConverter { SubjectLabelDTOConverter INSTANCE = Mappers.getMapper(SubjectLabelDTOConverter.class); SubjectLabelBO convertDtoToBo(SubjectLabelDTO subjectLabelDTO); } 
 

 

java
 

复制代码
 

public Result<Boolean> add( SubjectLabelDTO subjectLabelDTO){ SubjectLabelBO subjectLabelBO = SubjectLabelDTOConverter.INSTANCE .convertDtoToBo(subjectLabelDTO); } 
 

总结
 

Mapper-struct同样也是浅拷贝，需要进行深拷贝，就写多个Converter把需要深拷贝的再转一次吧，如果要配置深拷贝
 

太麻烦了

                

        

    


  



    



                



	

		

			

				
					
比Spring的BeanUtils.copyProperties还快的对象属性拷贝工具

				
			

			

				

					SJZYLC的专栏
				

				

					07-30
					
					2380
					
				

			

		

		

			
				
关于对象属性拷贝，虽说有现成的工具可用，之前都是自己写的反射进行拷贝，效率比较后，发现效率不高。

自从看了spring的源码，决定优化一下自定义的拷贝工具，主要是吸收spring的优秀思想，即使用内存作为缓存，同样的一个class拷贝时不用每次都进行反射，这样大大提升了效率。

话不多说，直接上源码：


class MethodObj{
    private String name;
   ...

			
		

	



                

            
              



	

		

			

				
					
2024年了你还在用BeanUtil.copy，看看这款神器

				
			

			

				

					分享思想，留下痕迹。
				

				

					03-06
					
					1753
					
				

			

		

		

			
				
手动一个个字段的赋值通过反序列化的手段，必须先转成JSON字符串，再转回来使用Spring的BeanUtils，提供的克隆方法。想必上面这几种方式大家都使用过。但是BeanUtils底层是通过反射实现的，复杂场景支持不足，控制 copy 粒度太粗，不易重构。而前两种方式的话， 重复性工作多，手写代码容易遗漏掉有些字段。今天我们来介绍关于MapStruct，MapStruct是一个代码生成器，它通过编译时自动生成映射代码，从而避免了手动编写重复且容易出错的映射逻辑。

			
		

	



              


  
              

                


	

		

			

				
					
structmapper:映射器将字段从一种结构类型映射到另一种结构类型

				
			

			

				

					06-14
				

			

		

		

			
				
结构映射器
映射器将字段从一种结构类型映射到另一种结构类型

			
		

	





	

		

			

				
					
每天都在写Getter、Setter方法，我不耐烦了，于是用了神器MapperStruct，crud效率一下子提高了! （最好使用硬编码）

				
			

			

				

					dj1540225203的博客
				

				

					06-08
					
					290
					
				

			

		

		

			
				
java类属性便捷工具的使用

			
		

	



		

			
		



	

		

			

				
					
强烈推荐 MapperStruct，不建议用 BeanUtils.copyProperties 拷贝数据？

				
			

			

				

					良月柒
				

				

					05-10
					
					162
					
				

			

		

		

			
				
程序员的成长之路互联网/程序员/技术/资料共享关注阅读本文大概需要 3.5分钟。来自：juejin.cn/post/7333458486435987494在实际的业务开发中，我们经常会碰到BO、PO、DTO等对象属性之间的赋值，当属性较多的时候我们使用get，set的方式进行赋值的工作量相对较大，因此很多人会选择使用spring提供的拷贝工具BeanUtils的copyProperties方法...

			
		

	





	

		

			

				
					
为啥不建议用BeanUtils.copyProperties拷贝数据 | 京东云技术团队

				
			

			

				

					JDDTechTalk的博客
				

				

					12-22
					
					2113
					
				

			

		

		

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

			
		

	





	

		

			

				
					
BeanMapper：比BeanUtils.copyProperties更快


				
			

			

				

					08-24
				

			

		

		

			
				
一个BeanUtils.copyProperties的小型快速替代。 起因 由于BeanUtils（Spring或Apache Commons）的copyProperties实现是利用反射实现的，它在大量调用时具有比较严重的性能问题。 BeanMapper通过javassist类库实现在...

			
		

	





	

		

			

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

				
			

			

				

					pan_junbiao的博客
				

				

					09-30
					
					1631
					
				

			

		

		

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

			
		

	





	

		

			

				
					
BeanUtils.copyProperties封装拷贝List对象

				
			

			

				

					顶顶顶顶顶顶顶顶顶顶顶顶
				

				

					02-20
					
					2118
					
				

			

		

		

			
				
BeanUtils.copyProperties封装拷贝List对象。

			
		

	





	

		

			

				
					
Java对象复制系列六: 史上最快的对象复制工具 Mapper Struct 原理浅析

				
			

			

				

					一起成为更好的Java工程师
				

				

					07-18
					
					1441
					
				

			

		

		

			
				
Mapper Struct 是目前最好的 Java 对象复制的工具之一。上一节我们介绍了 Mapper Struct 高阶应用，今天我们来看下为什么可以做到这么快。今天带着大家了解了为什么 Mapper Struct 为上面这么快，知根知底以后大家可以在工作中使用起来了，本人在项目中引入收到的反馈非常棒，绝对是一款项目必备的工具。给大家推荐一个非常完整的Java项目搭建的最佳实践,也是本文的源码出处，由大厂程序员&EasyExcel作者维护。

			
		

	





	

		

			

				
					
mapper:一个简单易用的工具，用于自动映射器映射到结构，映射到结构，映射到结构，切片到切片，映射到切片，映射到json

				
			

			

				

					05-23
				

			

		

		

			
				
devfeel /映射器
一个简单易用的工具，用于自动映射器struct映射，struct struct，slice to slice，slice to slice，map to json。
1.安装
 go get -u github.com/devfeel/mapper
2.入门
 package main
import (
	"fmt"
	"github.com/devfeel/mapper"
)
type (
	User struct {
		Name string
		Age  int
		Id   string `mapper:"_id"`
		AA   string `json:"Score"`
		Time time. Time
	}
	Student struct {
		Name  string
		Age   int
		Id    string `mapper:"_

			
		

	





	

		

			

				
					
go-structmapper:Go库提供的功能允许将结构映射到地图，反之亦然

				
			

			

				

					05-02
				

			

		

		

			
				
go-structmapper
 go-structmapper是一个Go库，它允许将任意结构映射到map，反之亦然。
安装
使用Go工具链： 
go get -u gopkg.in/anexia-it/go-structmapper.v1

			
		

	





	

		

			

				
					
Java对象复制系列五: 最快速度、方便的对象复制工具 Mapper Struct 的高阶应用

				
			

			

				

					一起成为更好的Java工程师
				

				

					07-17
					
					1050
					
				

			

		

		

			
				
Mapper Struct 是目前最好的 Java 对象复制的工具之一。上一节我们讲到了 Mapper Struct 的应用，以及测试了他的性能，发现他的性能已经无限接近直接 get/set 了。今天我们来讲一下如何集成spring 以及一些高阶用法。让你在工作中各种对象转换游刃有余。今天给大家介绍了各种高阶的使用方法，平时工作应该完全胜任了，代码会别的特别优雅，把复杂的逻辑写到转换器里面，代码会变得特别优雅。

			
		

	





	

		

			

				
					
解锁Spring Boot数据映射新利器：深度探索MapperStruct

				
			

			

				

					
				

				

					05-11
					
					1161
					
				

			

		

		

			
				
MapperStruct 是一款功能强大、易于使用的对象属性拷贝工具，可以帮助开发者快速、安全地完成对象属性拷贝工作。在实际开发中，可以根据具体的项目需求选择合适的工具进行对象属性拷贝。

			
		

	





	

		

			

				
					
每天都在写Getter、Setter方法，我不耐烦了，于是用了神器MapperStruct，crud效率一下子提高了!

				
			

			

				

					yangjnsjbad的博客
				

				

					05-31
					
					2225
					
				

			

		

		

			
				
​ 相信绝大多数的业务开发同学，日常的工作都离不开写getter、setter方法。要么是将下游的RPC结果通过getter、setter方法进行获取组装。要么就是将自己系统内部的处理结果通过getter、setter方法处理成前端所需要的VO对象。


​ 传统的方法一般是采用硬编码，将每个对象的值都逐一设值。当然为了偷懒也会有采用一些BeanUtil简约代码的方式：


​ 但是，像BeanUtils这类通过反射、内省等实现的框架，在速度上会带来比较严重的影响。尤其是对于一些大字段、大对象而言，这个速度

			
		

	





	

		

			

				
					
每天都在写Getter、Setter方法，我不耐烦了，于是用了神器MapperStruct，crud效率一下子提高了~

				
			

			

				

					Laugh_xiaoao的博客
				

				

					05-29
					
					819
					
				

			

		

		

			
				
前言
​	相信绝大多数的业务开发同学，日常的工作都离不开写getter、setter方法。要么是将下游的RPC结果通过getter、setter方法进行获取组装。要么就是将自己系统内部的处理结果通过getter、setter方法处理成前端所需要的VO对象。
public UserInfoVO originalCopyItem(UserDTO userDTO){
    UserInfoVO userInfoVO = new UserInfoVO();
    userInfoVO.setUserName(u

			
		

	





	

		

			

				
					
Spring Boot数据映射利器：MapperStruct vs. BeanUtils.copyProperties 一较高下

				
			

			

				

					
				

				

					05-11
					
					982
					
				

			

		

		

			
				
在选择使用 MapperStruct 还是 BeanUtils.copyProperties 时，需要根据项目的具体情况来进行权衡。如果项目对性能要求较高，且需要更好的类型安全性和灵活性，推荐使用 MapperStruct；如果项目对性能要求不高，且简单的属性拷贝场景较多，可以考虑使用 BeanUtils.copyProperties。最终，根据实际情况选择合适的方式来进行对象之间的数据拷贝操作。

			
		

	





	

		

			

				
					
玩转MapStruct,学习就是了

				
			

			

				

					JavaAlliance
				

				

					11-26
					
					5108
					
				

			

		

		

			
				
玩转MapStruct,手把手带你学会！
在平时CRUD的工作中，经常需要做PO、VO、DTO之间的转换。简单的对象转换，使用BeanUtils基本上是够了，但是复杂的转换，如果使用它的话又得写一堆Getter、Setter方法了。BeanUtils 就是一个大老粗，只能同属性映射，或者在属性相同的情况下，允许被映射的对象属性少；但当遇到被映射的属性数据类型被修改或者被映射的字段名被修改，则会导致映射失败。而 mapstruct 就是一个巧媳妇儿了，她心思细腻，把我们可能会遇到的情况都给考虑到了，所以今天给

			
		

	





	

		

			

				
					
BeanUtils.copyProperties拷贝对象如何忽略不需要属性

					
最新发布

				
			

			

				

					12-17
				

			

		

		

			
				
<think>我们正在讨论如何使用BeanUtils.copyProperties来拷贝对象并忽略某些属性。根据引用[2]，BeanUtils.copyProperties有一个重载方法，可以传入一个忽略属性列表。
 具体语法是：BeanUtils.copyProperties(源对象, 目标对象, 忽略的属性数组);
 例如，如果我们想忽略属性"actiontime"和"dbtime"，可以这样写：
   BeanUtils.copyProperties(kafkaNoticeVO, kafkaNotice, new String[]{"actiontime","dbtime"});
 这样，在拷贝过程中，源对象中这两个属性的值（即使不为null）也不会被拷贝到目标对象中。

 另外，引用[1]提到的是忽略null值的拷贝，但用户的问题是要忽略某些属性（不管是否为null）。所以，我们这里使用三个参数的方法即可。

 注意：这里使用的是Apache Commons BeanUtils库中的方法，确保项目中已经引入该依赖。

 因此，回答用户问题：使用BeanUtils.copyProperties拷贝对象时忽略不需要的属性，可以通过调用三个参数的方法，第三个参数是一个字符串数组，包含需要忽略的属性名。

 下面给出一个示例代码：

 假设有两个类：SourceClass和TargetClass，它们都有属性name、age和email。如果我们想忽略name和email属性，可以这样：

```java
SourceClass source = new SourceClass();
source.setName("John");
source.setAge(25);
source.setEmail("john@example.com");

TargetClass target = new TargetClass();

// 拷贝source到target，但忽略name和email属性
BeanUtils.copyProperties(source, target, new String[]{"name", "email"});

// 此时target的name和email属性为null（或原来的值），而age属性被拷贝为25
```

 注意：这个方法会忽略指定的属性，无论这些属性在源对象中的值是什么（即使不为null）。

 如果用户想要忽略null值，那么需要使用其他方法，比如自定义一个工具类或者使用其他库（如Spring BeanUtils）。但根据用户问题，我们只讨论忽略特定属性。

 另外，需要确保目标对象中需要忽略的属性在拷贝前已经设置过值（如果不想被覆盖），因为忽略的属性不会被源对象的值覆盖。

 最后，提醒用户注意，如果忽略的属性在目标对象中不存在，则不会有影响，也不会报错（除非属性名拼写错误，但BeanUtils会忽略不存在的属性名）。

 根据要求，生成相关问题：
 1. 如何在使用BeanUtils.copyProperties时只拷贝非空属性？
 2. BeanUtils.copyProperties和Spring的BeanUtils有什么区别？
 3. 除了使用BeanUtils.copyProperties，还有哪些对象拷贝的方法？

 注意：引用标识的使用，在回答中引用了引用[2]的内容，所以在末尾添加引用标识。
</think>
### 使用 BeanUtils.copyProperties 忽略属性的方法

根据引用资料，使用 Apache Commons BeanUtils 库中的 `copyProperties` 方法时，可通过 **三个参数的重载方法** 忽略指定属性：

```java
// 语法结构
BeanUtils.copyProperties(源对象, 目标对象, 需要忽略的属性名数组);
```

#### 操作步骤：
1. **导入依赖**（Maven）：
   ```xml
   <dependency>
     <groupId>commons-beanutils</groupId>
     <artifactId>commons-beanutils</artifactId>
     <version>1.9.4</version>
   </dependency>
   ```

2. **代码示例**：
   ```java
   // 定义忽略的属性数组
   String[] ignoreProperties = {"createTime", "updateTime", "敏感字段"};

   // 执行拷贝（忽略指定属性）
   BeanUtils.copyProperties(sourceObj, targetObj, ignoreProperties);
   ```
   - 效果：无论 `createTime` 等属性是否为 `null`，均不会被拷贝到目标对象[^2]

#### 注意事项：
1. **属性名必须严格匹配**，区分大小写
2. 若忽略的属性在目标对象中不存在，会自动跳过且不会报错
3. 此方法会**覆盖目标对象原有值**（除非被忽略）
4. 如需深度拷贝或复杂逻辑，建议使用 MapStruct 等工具

#### 对比其他方案：
| 方法                | 忽略 null | 忽略指定属性 | 是否需要额外代码 |
|---------------------|-----------|--------------|------------------|
| 三参数 copyProperties | ❌         | ✅            | ❌                |
| 自定义工具类         | ✅         | ✅            | ✅                |
| Spring BeanUtils     | ❌         | ❌            | ❌                |

> 提示：Spring 框架自带的 `BeanUtils.copyProperties` 不支持忽略属性功能，需使用 Apache Commons 版本[^1][^2]

			
		

	



              




          




        



    





    



      

      

        
      

      





	

		评论	
	

  
	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

            领取后你会自动成为博主和红包主的粉丝
            规则
          

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

                
 1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
 2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

              

            

          

      

      余额充值