使用mapstruct进行对象数据的复制

已于 2024-08-24 18:15:50 修改
阅读量978 收藏 10
点赞数 21
分类专栏： java 文章标签： java 笔记
于 2024-08-18 00:06:48 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/dan_seek/article/details/141289151
版权

MapStruct是一个基于Java注解处理器的代码生成器，它专注于在Java Bean类型之间自动生成类型安全、高性能且无依赖的映射代码。MapStruct极大地简化了对象之间的映射过程，减少了手动编写映射代码的工作量。其主要特点包括：

  • 类型安全：在编译时进行类型检查，确保映射的正确性。
  • 高性能：生成的映射代码使用简单的方法调用，避免了反射带来的性能损耗。
  • 灵活性：支持复杂的映射场景，如嵌套映射、集合映射、自定义转换规则等。
  • 简洁性：通过注解定义映射规则，使得映射逻辑更加直观和简洁。
  • 无依赖：不依赖于任何第三方库，易于集成到任何Java项目中。

MapStruct特别适用于多层架构的应用，如在持久层的实体和传输层的DTO或VO之间进行转换。

先引入对应的包

如果不依赖lombok

...
<properties>
    <org.mapstruct.version>1.6.0</org.mapstruct.version>
</properties>
...
<dependencies>
    <dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>${org.mapstruct.version}</version>
    </dependency>
</dependencies>
...
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.13.0</version>
            <configuration>
                <source>17</source>
                <target>17</target>
                <annotationProcessorPaths>
                    <path>
                        <groupId>org.mapstruct</groupId>
                        <artifactId>mapstruct-processor</artifactId>
                        <version>${org.mapstruct.version}</version>
                    </path>
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>
...

如果依赖lombok

....
<properties>
    <java.version>17</java.version>
    <org.mapstruct.version>1.6.0</org.mapstruct.version>
    <org.projectlombok.version>1.18.34</org.projectlombok.version>
    <lombok-mapstruct-binding.version>0.2.0</lombok-mapstruct-binding.version>
</properties>
<dependencies>
    ....
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>${org.projectlombok.version}</version>
        <optional>true</optional>
    </dependency>
	<dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>${org.mapstruct.version}</version>
    </dependency>
    ....
</dependencies>

<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>3.13.0</version>
				<configuration>
					<source>${java.version}</source>
					<target>${java.version}</target>
					<annotationProcessorPaths>

						<!-- mapstruct相关 start -->
						<path>
							<groupId>org.mapstruct</groupId>
							<artifactId>mapstruct-processor</artifactId>
							<version>${org.mapstruct.version}</version>
						</path>
						<path>
							<groupId>org.projectlombok</groupId>
							<artifactId>lombok</artifactId>
							<version>${org.projectlombok.version}</version>
						</path>
						<path>
							<groupId>org.projectlombok</groupId>
							<artifactId>lombok-mapstruct-binding</artifactId>
							<version>${lombok-mapstruct-binding.version}</version>
						</path>
						<!-- mapstruct相关 end -->

					</annotationProcessorPaths>
				</configuration>
			</plugin>
		</plugins>
	</build>

为了更好体验，可以给IDEA安装MapStruct support插件

示例中使用的两个类

User.java

@Data
public class User {
    private Integer id;
    private String name;
    private String mobile;
}

UserVo.java

@Data
public class UserVo {
    private Integer id;
    // 注意这里有两个属性不一样
    private String nickName;
    private String contactMobile;
}

1、基本的用法

1.1 两个对象属性名都相同

如果两个对象需要拷贝的属性值相同，只需下面两行代码

import org.mapstruct.Mapper;
import org.mapstruct.factory.Mappers;

@Mapper
public interface UserConverter {

    UserConverter CONVERTER = Mappers.getMapper(UserConverter.class);

    UserVo toUserVo(User user);
}

rebuild项目会自动生成如下代码

public class UserConverterImpl implements UserConverter {

    @Override
    public UserVo toUserVo(User user) {
        if ( user == null ) {
            return null;
        }

        UserVo userVo = new UserVo();
        userVo.setId( user.getId() );
        return userVo;
    }
}

只要是两个对象里属性名相同的都会自动复制，不同的会忽略

并且两个属性的类型不同也没关系，mapstruct会智能转换成对应类型

1.2 两个对象有部分属性名不同

使用@Mapping注解即可

@Mapper
public interface UserConverter {

    UserConverter CONVERTER = Mappers.getMapper(UserConverter.class);

    @Mapping(source = "name", target = "nickName")
    @Mapping(source = "mobile", target = "contactMobile")
    UserVo toUserVo(User user);
}

如果对象里面的属性是对象，使用对象 . 属性操作即可

多个值转换也可以这样：

@Mappings({
	@Mapping(source = "name", target = "nickName"),
	@Mapping(source = "mobile", target = "contactMobile")
})

rebuild项目会自动生成如下代码

public class UserConverterImpl implements UserConverter {

    @Override
    public UserVo toUserVo(User user) {
        if ( user == null ) {
            return null;
        }

        UserVo userVo = new UserVo();

        userVo.setNickName( user.getName() );
        userVo.setContactMobile( user.getMobile() );
        userVo.setId( user.getId() );

        return userVo;
    }
}

使用方式：

	@Test
	void contextLoads() {
		User user = new User();
		user.setId(1);
		user.setMobile("123456789");
		user.setName("张三");
        
        // 调用方式
		UserVo userVo = UserConverter.CONVERTER.toUserVo(user);
		System.out.println(userVo.getNickName()); // 如期输出张三
	}

一个方法怎够，其实接口里面还可以写多个转换方法

@Mapper
public interface UserConverter {

    UserConverter CONVERTER = Mappers.getMapper(UserConverter.class);

    @Mappings({
        @Mapping(source = "name", target = "nickName"),
        @Mapping(source = "mobile", target = "contactMobile")
    })
    UserVo toUserVo(User user);

    // 从userVo拷贝属性到user，复用上面的mapping
    @InheritInverseConfiguration
    User toUser(UserVo userVo);

    // 克隆user
    User clone(User user);
}

@InheritInverseConfiguration注解是指复用之前的mapping映射，否则还需要再写一遍映射关系；如果有多个转换方法则需要指定复用哪个方法的映射

@InheritInverseConfiguration( name = "toUserVo" )

以上为最基础、常用的写法

1.3 其他配置

忽略
@Mapping(target = "id", ignore = true)

不拷贝id的值

默认值
@Mapping(target = "id", defaultValue = "100")

如果id值为空则设置为100

设置常量
@Mapping(target = "id", constant = "111")

设置id的值为111

格式化
@Mapping(source = "weight", target = "weight", numberFormat = "#.00")
格式数字

拷贝的属性会保留两位小数

User user = new User();
user.setWeight(100.5f);
UserVo userVo = UserConverter.CONVERTER.toUserVo(user);
// userVo的weight为String类型，类型不同会自动转换
System.out.println(userVo.getWeight());  // 输出100.50
格式日期
@Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")

User user = new User();
user.setBirthday(new Date());
UserVo userVo = UserConverter.CONVERTER.toUserVo(user);
// userVo的birthday为String类型，类型不同会自动转换
System.out.println(userVo.getBirthday()); // 输出2024-08-17 19:05:05

来看下自动生成的代码

userVo.setWeight( new DecimalFormat( "#.00" ).format( user.getWeight() ) );

        if ( user.getBirthday() != null ) {
            userVo.setBirthday( new SimpleDateFormat( "yyyy-MM-dd HH:mm:ss" ).format( user.getBirthday() ) );
        }

        userVo.setId( 111 );

2、进阶用法

2.1 属性里有复杂对象

@Data
public class Group {
    private int id;
    private String name;
    private List<User> members;
}

@Data
public class GroupVo {
    private int id;
    private String name;
    private List<UserVo> membersVo;
}

注意看下members和membersVo，它们里面存的对象是不一样的，mapstruct会自动解析它们之间的关系。

写法如下：

@Mapper
public interface GroupConverter {
    GroupConverter CONVERTER = Mappers.getMapper(GroupConverter.class);

    @Mapping(source = "members", target = "membersVo")
    GroupVo toGroupVo(Group group);

    @InheritInverseConfiguration
    Group toGroup(GroupVo groupVo);
}

2.2 表达式

2.2.1 可以使用expression属性来调用代码（方法）
@Mapping(target = "nickName", expression = "java(user.getName().toUpperCase())")
UserVo toUserVo(User user);

将会生成如下代码：

userVo.setNickName( user.getName().toUpperCase() );
2.2.2 使用qualifiedByName调用方法
@Mapping(target = "nickName", source = "name", qualifiedByName = "toUpperCase")
UserVo toUserVo(User user);

@InheritInverseConfiguration
User toUser(UserVo userVo);

@Named("toUpperCase")
default String toUpperCase(String name) {
    return name.toUpperCase();
}

如果使用了@InheritInverseConfiguration注解反向也会调用方法

生成代码如下：

public UserVo toUserVo(User user) {
        if ( user == null ) {
            return null;
        }

        UserVo userVo = new UserVo();

        userVo.setNickName( toUpperCase( user.getName() ) );
       .........
           .....
        return userVo;
    }

    @Override
    public User toUser(UserVo userVo) {
        if ( userVo == null ) {
            return null;
        }

        User user = new User();

        user.setName( toUpperCase( userVo.getNickName() ) );
        .......
            ...
        return user;
    }

2.3 实现类加入spring容器

在接口上方使用如下注解

@Mapper(componentModel = MappingConstants.ComponentModel.SPRING)

生成的方法会加上@Component

@Component
public class UserConverterImpl implements UserConverter { ... }

2.4 多个对象转一个对象

限定名称即可，如果target对象的某个属性在两个source中都有，必须指定从哪个取。比如user和order实例都有id属性，这个时候必须指定复制哪个实例的id

@Mapping(source = "user.id", target = "id")
@Mapping(source = "user.name", target = "nickName")
@Mapping(source = "order.orderNo", target = "orderNo")
UserVo toUserVo(User user, Order order);

参考官方示例：https://github.com/mapstruct/mapstruct-examples

风中蒲公英
关注
专栏目录
【微服务】springboot整合对象映射工具MapStruct使用详解
congge
08-25 4244
springboot 整合 MapStruct 使用详解
MapStruct：一款java对象转换神器
2401_83915664的博客
04-16 926
可能有人会问我为什么愿意去花时间帮助大家实现求职梦想，因为我一直坚信时间是可以复制的。我牺牲了自己的大概十个小时写了这片文章，换来的是成千上万的求职者节约几天甚至几周时间浪费在无用的资源上。上面的这些（算法与数据结构）+（Java多线程学习手册）+（计算机网络顶级教程）等学习资源《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！中…(img-2plSXhFQ-1713223652486)]
maptruct复制对像
weixin_41126842的博客
11-25 259
现在项目中要求用mapstruct 每个接口要有自己的接收参数对象，就是controller层的入参对象，以Req结尾，比如：IndicatorReq 规定service层不能直接用IndicatorReq，要转换为IndicatorDTO service返回结果也是DTO结尾，比如IndicatorResultDTO 在controller层返回不能直接用IndicatorResultD...
MapStruct复制对象详细介绍
Lxl1418的博客
10-09 525
MapStruct是基于JSR 269的Java注释处理器，用于生成类型安全的 Bean 映射类。您所要做的就是定义一个映射器接口，该接口声明任何所需的映射方法。在编译过程中，MapStruct将生成此接口的实现。此实现使用纯 Java 方法调用在源对象和目标对象之间进行映射，即无反射或类似内容。与手动编写映射代码相比，MapStruct通过生成繁琐且容易出错的代码来节省时间。遵循配置方法的约定，MapStruct使用合理的默认值，但在配置或实现特殊行为时会步入歧途。在这里插入图片描述。
使用mapstruct实现对象拷贝
前行的博客
01-26 772
【代码】使用mapstruct实现对象拷贝。
【SpringBoot】MapStruct实现优雅的数据复制
最新发布
k123456kah的博客
05-20 1941
1.为什么选择MapStruct2.MapStruct快速入门3.MapStruct进阶4.字段的逻辑处理一般来说，不使用MapStruct框架进行属性映射，常有的方法以下两种：这种方法最朴素，手动编写代码将源对象的属性存入目标对象，需要注意实体类中嵌套属性的判空操作以防止空指针异常。底层使用的是反射机制实现属性的映射。反射是一种在运行时动态获取类信息、调用方法或访问字段的机制，无法利用JVM的优化机制，因此通常比直接方法调用慢得多。此外， 只能同属性映射，或者在属性相同的情况下，允许被映射的对象属性少；但
对象之间互相拷贝效率最高工具（mapstruct）
weixin_43811057的博客
09-10 1563
1、干掉 BeanUtils！试试这款 Bean 自动映射工具，真心强大 2、mapstruct最佳实践 3、springboot整合mapstruct 4、SpringBoot 2.4.1整合 MapStruct 详细教程
mapstruct.zip
06-03
它通过代码生成的方式，极大地提高了在Spring框架中进行对象复制的效率，相比传统的`Spring BeanUtils`或者`ModelMapper`等工具，MapStruct具有更高的性能和更简洁的API。本文将深入探讨MapStruct的工作原理、优点、...
MapStruct Java实例Demo
09-04
MapStruct是一款优秀的Java库，专为简化对象到对象映射（Object-to-Object mapping）而设计。在软件开发中，特别是在处理数据传输对象（DTO，Data Transfer Objects）时，经常需要将一个对象的属性值复制到另一个...
kotlin将对象转换为map_在 Kotlin 的 data class 中使用 MapStruct
weixin_39546312的博客
12-22 696
原文：https://zhuanlan.zhihu.com/p/208525542一. data class 的 copy() 为浅拷贝浅拷贝是按位拷贝对象，它会创建一个新对象，这个对象有着原始对象属性值的一份精确拷贝。如果属性是基本类型，拷贝的就是基本类型的值；如果属性是内存地址(引用类型)，拷贝的就是内存地址 ，因此如果其中一个对象改变了这个地址，就会影响到另一个对象。深拷贝会拷贝所有的属性,...
mapstruct两个对象数据合并
05-29
如果你想将两个对象数据合并，可以使用 mapstruct 提供的 `@MappingTarget` 注解。示例代码如下： ```java @Mapper public interface UserMapper { @Mapping(target = "firstName", source = "firstName") @...
对象拷贝 - 优雅的解决方案 Mapstruct
weixin_33943836的博客
05-29 733
MapStruct GitHub 访问地址 : https://github.com/mapstruct/mapstruct/ 使用例子 : https://github.com/mapstruct/mapstruct-examples MapStrcut与其它工具对比以及使用说明! http://www.tuicool.com/articles/uiIRjai 是否一直在使用BeanUtils...
【Java生态圈技术总结】之深度剖析MapStruct对象拷贝工具
weixin_42469135的博客
05-26 3887
目录导航一、常用的对象拷贝工具基本介绍1.1 Apache BeanUtils1.2 Spring BeanUtils1.3 cglib BeanCopier1.4 HuTool BeanUtils1.5 MapStruct1.6 getter & setter1.7 总结二、使用介绍2.1 准备工作2.2 映射2.2.1 基本映射2.2.2 不同属性名映射2.2.3 不同个数属性映射2.2.4 多个源合并映射2.2.5 子对象映射2.2.6 集合属性映射2.2.7 枚举映射2.2.8 集合映射2.
【springboot进阶】优雅使用 MapStruct 进行类复制
热门推荐
11-13 1万+
实体映射工具类 MapStruct 的介绍、使用和配置，并结合一般项目使用情况进行演示。对调试过程出现的 java.lang.NoSuchMethodError 异常进行说明并提供解决方法。
高效、优雅的对象copy之MapStruct入门到精通，实战踩坑版
小王博客基地
01-29 1732
大家在开发中，最让人头疼的就是：对象之间的拷贝，前端的VO和数据库的Entity不一致！性能最好的就是手动set，主要是枯燥且无技术含量，不仅耗费大量时间而且很容易出错；所以我们要成为优秀的程序员，要多借助轮子，开发效率事半功倍，开发技能也是增长不少！如果系统性能没有要求，怎么实现都是好的，但是我们要有追求哈，追求高质量！每个东西都有存在的价值，不要捧一踩一哈！MapStruct是基于JSR 269的Java注释处理器，用于生成类型安全的 Bean 映射类。
mapStruct对象复制工具在项目中使用以及避坑指南
Jiao1225的博客
05-04 1149
MapStruct 使用姿势以及避坑指南
优雅的转换拷贝对象—MapStruct集成以及使用
银魄清辉自夜凝的博客
02-27 1196
优雅的转换拷贝对象—mapstructMapStruct是什么MapStruct优点MapStruct使用MapStruct代码生成器处理器选项配置具体配置方式创建用户类创建用户VO创建一个转换接口调用user转userVO方法就会自动转换通过接口方法 看自动生成的代码如下自定义属性映射多个source参数的映射 MapStruct是什么 项目经常有这样的场景，我要把对象a的name转换到对象b的name去，我们经常是使用BeanUtils.copyProperties();方法去实现的，但是这样做很大的
Java对象拷贝MapStruct
lonelymanontheway的博客
06-10 2314
介绍，入门实战； Internal error in the mapping processor:NullPointerException； No target bean properties found: can't map Collection element, Consider to declare/implement a mapping method
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值