【推荐】使用 mapstruct 对 PO VO DTO 进行转换

转载 已于 2023-10-12 13:30:38 修改
· 208 阅读 · 0
文章标签：

#java

于 2023-10-07 10:56:31 首次发布
本文介绍了Mapstruct这一开源项目，用于简化实体之间的数据转换，特别是当字段众多时，对比了它与BeanUtils的使用，并展示了如何通过Lombok和Mapper接口实现自动化的字段映射和格式化。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

本文转载，原文地址： 别再用 BeanUtils 了，这款 PO VO DTO 转换神器不香么？      

老铁们是不是经常为写一些实体转换的原始代码感到头疼，尤其是实体字段特别多的时候。介绍一个开源项目 mapstruct ，可以轻松优雅的进行转换，简化你的代码。当然有的人喜欢写get set，或者用BeanUtils 进行复制，代码只是工具，本文只是提供一种思路。

先贴下官网地址吧：https://mapstruct.org/

废话不多说，上代码：

pom 配置：

<properties>
	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	<maven.compiler.source>1.8</maven.compiler.source>
	<maven.compiler.target>1.8</maven.compiler.target>
	<org.mapstruct.version>1.4.1.Final</org.mapstruct.version>
	<org.projectlombok.version>1.18.12</org.projectlombok.version>
</properties>


<dependencies>
	<dependency>
		<groupId>org.mapstruct</groupId>
		<artifactId>mapstruct</artifactId>
		<version>${org.mapstruct.version}</version>
	</dependency>

	<!-- lombok dependencies should not end up on classpath -->
	<dependency>
		<groupId>org.projectlombok</groupId>
		<artifactId>lombok</artifactId>
		<version>${org.projectlombok.version}</version>
		<scope>provided</scope>
	</dependency>
	
	<!-- idea 2018.1.1 之前的版本需要添加下面的配置，后期的版本就不需要了，可以注释掉，我自己用的2019.3 -->
	<dependency>
		<groupId>org.mapstruct</groupId>
		<artifactId>mapstruct-processor</artifactId>
		<version>${org.mapstruct.version}</version>
		<scope>provided</scope>
	</dependency>

</dependencies>


<build>
	<plugins>
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-compiler-plugin</artifactId>
			<version>3.8.1</version>
			<configuration>
				<source>1.8</source>
				<target>1.8</target>
				<annotationProcessorPaths>
					<path>
						<groupId>org.projectlombok</groupId>
						<artifactId>lombok</artifactId>
						<version>${org.projectlombok.version}</version>
					</path>
					<path>
						<groupId>org.mapstruct</groupId>
						<artifactId>mapstruct-processor</artifactId>
						<version>${org.mapstruct.version}</version>
					</path>
				</annotationProcessorPaths>
			</configuration>
		</plugin>
	</plugins>
</build>

关于lombok和mapstruct的版本兼容问题多说几句，maven插件要使用3.6.0版本以上、lombok使用1.16.16版本以上，另外编译的lombok mapstruct的插件不要忘了加上。否则会出现下面的错误：No property named "aaa" exists in source parameter(s). Did you mean "null"?

这种异常就是lombok编译异常导致缺少get setter方法造成的。还有就是缺少构造函数也会抛异常。

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class Student {

    private String name;
    private int age;
    private GenderEnum gender;
    private Double height;
    private Date birthday;

}


public enum GenderEnum {
    Male("1", "男"),
    Female("0", "女");

    private String code;
    private String name;

    public String getCode() {
        return this.code;
    }

    public String getName() {
        return this.name;
    }

    GenderEnum(String code, String name) {
        this.code = code;
        this.name = name;
    }
}


@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class StudentVO {
    private String name;
    private int age;
    private String gender;
    private Double height;
    private String birthday;
}


@Mapper
public interface StudentMapper {

    StudentMapper INSTANCE = Mappers.getMapper(StudentMapper.class);

    @Mapping(source = "gender.name", target = "gender")
    @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")
    StudentVO student2StudentVO(Student student);

}

实体类是开发过程少不了的，就算是用工具生成肯定也是要有的，需要手写的部分就是这个Mapper的接口，编译完成后会自动生成相应的实现类。

然后就可以直接用mapper进行实体的转换了

public class Test {

    public static void main(String[] args) {

        Student student = Student.builder().name("小明").age(6).gender(GenderEnum.Male).height(121.1).birthday(new Date()).build();
        System.out.println(student);
        //这行代码便是实际要用的代码
        StudentVO studentVO = StudentMapper.INSTANCE.student2StudentVO(student);
        System.out.println(studentVO);

    }

}

mapper可以进行字段映射，改变字段类型，指定格式化的方式，包括一些日期的默认处理。

可以手动指定格式化的方法：

@Mapper
public interface StudentMapper {

    StudentMapper INSTANCE = Mappers.getMapper(StudentMapper.class);

    @Mapping(source = "gender", target = "gender")
    @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")
    StudentVO student2StudentVO(Student student);

    default String getGenderName(GenderEnum gender) {
        return gender.getName();
    }

}

上面只是最简单的实体映射处理，下面介绍一些高级用法

1、List 转换

属性映射基于上面的mapping配置

@Mapper
public interface StudentMapper {

    StudentMapper INSTANCE = Mappers.getMapper(StudentMapper.class);

    @Mapping(source = "gender.name", target = "gender")
    @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")
    StudentVO student2StudentVO(Student student);


    List<StudentVO> students2StudentVOs(List<Student> studentList);

}


public static void main(String[] args) {

    Student student = Student.builder().name("小明").age(6).gender(GenderEnum.Male).height(121.1).birthday(new Date()).build();

    List<Student> list = new ArrayList<>();
    list.add(student);
    List<StudentVO> result = StudentMapper.INSTANCE.students2StudentVOs(list);
    System.out.println(result);
}

2、多对象转换到一个对象

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class Student {

    private String name;
    private int age;
    private GenderEnum gender;
    private Double height;
    private Date birthday;

}


@Data
@AllArgsConstructor
@Builder
@NoArgsConstructor
public class Course {

    private String courseName;
    private int sortNo;
    private long id;

}


@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class StudentVO {
    private String name;
    private int age;
    private String gender;
    private Double height;
    private String birthday;
    private String course;
}


@Mapper
public interface StudentMapper {

    StudentMapper INSTANCE = Mappers.getMapper(StudentMapper.class);

    @Mapping(source = "student.gender.name", target = "gender")
    @Mapping(source = "student.birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")
    @Mapping(source = "course.courseName", target = "course")
    StudentVO studentAndCourse2StudentVO(Student student, Course course);

}


public class Test {

    public static void main(String[] args) {

        Student student = Student.builder().name("小明").age(6).gender(GenderEnum.Male).height(121.1).birthday(new Date()).build();
        Course course = Course.builder().id(1L).courseName("语文").build();

        StudentVO studentVO = StudentMapper.INSTANCE.studentAndCourse2StudentVO(student, course);
        System.out.println(studentVO);
    }

}

3、默认值

@Mapper
public interface StudentMapper {

    StudentMapper INSTANCE = Mappers.getMapper(StudentMapper.class);

    @Mapping(source = "student.gender.name", target = "gender")
    @Mapping(source = "student.birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")
    @Mapping(source = "course.courseName", target = "course")
    @Mapping(target = "name", source = "student.name", defaultValue = "张三")
    StudentVO studentAndCourse2StudentVO(Student student, Course course);

}

拓展知识点：@Mapper主键，其有不同的属性值，可以看看它不同的属性值的功能用途是什么。  

常用的属性有：builder、 uses、 unmappedTargetPolicy、unmappedSourcePolicy ，还有其他非常多的属性。

                                       

4、参考文章

1、 Mapstruct中使用lombok@Builder的坑          

2、 Mapstruct @Mapper @Mapping 使用介绍以及总结       

3、 MapStruct进阶使用＜二＞    

                                         

遇到MapStruct后，再也不手写PO，DTO，VO对象之间的转换了
代码讲故事
05-11 2828
遇到MapStruct后，再也不手写PO，DTO，VO对象之间的转换了。 介绍 在工作中，我们经常要进行各种对象之间的转换。 PO：persistent object 持久对象，对应数据库中的一条记录 VO：view object 表现层对象，最终返回给前端的对象 DTO：data transfer object数据传输对象，如dubbo服务之间传输的对象 如果这些对象的属性名相同还好，可以用如下工具类赋值 Spring BeanUtils Cglib BeanCopier 避免使用Apache BeanU
【笔记】Java - mapstruct 转换VO、DTO、PO
LawssssCat的博客
02-20 866
在工作中，我们经常要进行各种对象之间的转换。如果这些对象的属性名相同还好，可以用如下工具类赋值如果属性名不同呢？如果是将多个PO对象合并成一个VO对象呢？好在有MapStruct神器，可以帮助我们快速转换MapSturct 是一个生成类型安全，高性能且无依赖的 JavaBean 映射代码的注解处理器（annotation processor）。💡 注解处理器可以生成 JavaBean 之间那的映射代码类型安全，高性能，无依赖性。
MapStruct转换时，进行数值和中文映射
qq_36438844的博客
07-10 226
示例描述：查询书来的DO中状态status可能是0，1，2，需要转化成VO中的待审核，通过，驳回；注意：只需要在DOToVO单个对象转化的方法上标注，集合转化会默认循环调用单个对象转化的方法；
PO自动转换为DTO（mapstruct-解决手动转换）
不积跬步无以至千里，不积小流无以成江河
05-13 2128
订单
DTO 与 PO的相互转换
qq_33753147的博客
01-16 2300
Bean属性转换
使用MapStruct转换VO、DTO、PO
传智燕青
11-21 2233
1 MapStruct是什么 MapStruct是一个代码生成器，它基于约定优于配置的方法大大简化了Java Bean类型之间的映射的实现。 生成的映射代码使用简单的方法调用，因此速度快，类型安全且易于理解。 它有什么用？ 多层应用程序通常需要在不同的对象模型之间进行映射。比如VO对象向DTO对象的转换，DTO对象向PO对象的转换，编写这些转换代码是一项繁琐且容易出错的任务。MapStruct旨在...
MapStruct介绍以及VO、DTO、PO、DO的区别
tmax52HZ的博客
09-23 487
MapStruct介绍以及VO、DTO、PO、DO的区别
mapstruct实现各个实体间的类型转换（DTO转BO、BO转Entity）的实践
m0_73376570的博客
06-26 1517
***/@Data@Data@Mapper//将DTO转换为BO//将List转换为List//将BO转换为DTO。
Java编码辅助工具Mapstruct用法详解
08-25
在项目开发中，业务分层会涉及不同类型的Bean之间需要相互转换，如PO与DTO之间，PO与VO之间等。手动编码setter/getter各个对应属性，会显得臃肿繁琐。通过Mapstruct框架可简单方便地完成这一工作。 如何引入Map...
mapstruct实现实体类属性的转换
qq_45789058的博客
12-13 1808
前言 项目开发中，业务分层会涉及不同类型的Bean之间需要相互转换，如PO与DTO之间，PO与VO之间等。手动或者生成编码setter/getter各个对应属性，会显得臃肿繁琐，代码里面出现大量的map或者build方法，有的serivce里面映射的方法代码行数比实际业务代码还要多，MapStruct 就是一个属性映射插件，用于为Java Bean生成类型安全且高性能的映射。基于编译阶段生成get/set代码，此实现过程中没有反射，不会造成额外的性能损失。只需要定义一个 Mapper 接口，M
mybatis plus generator 3.5.1 从了解到自定义定制VO、PO、DTO
TimerBin的博客
11-11 7184
mybatis plus generator 3.5.1 最新 代码生成器、使用 Velocity 模板自定义生成工具类(默认)1、主要配置方法在以上代码中已列出，为 initInjectionConfig() 方法，需同步配置信息//1、指定生成的自定文件存放路径/**存放生成文件的 其他实体类 存放的package地址**///2、自定义重新生成自定义、定制类的工具/*** 自定义模板解析器*///3、定义注入配置方法/*** 自定义注入配置* @return*//**自定义生成模板参数**/
Java 对象属性映射转换器 mapStruct ,PO转VO或VO转DTO等
小鹏子的博客
01-10 2386
在项目中，时常有DTO、VO、BO等转换问题时候，我们会使用Apache或者Spring的BeanUtils来做copy。他们使用的原理都是反射，而且是浅拷贝性能不高。 场景 耗时（调用100万次） 原理 get/set 20ms 直接调用 MapStruct 20ms 接口映射注入（简洁方便） BeanCopiers 20ms 基于 cglib，修改字节码 BeanUtils 12000ms 反射 PropertyUtils 4000ms 反射 MapStruct 性能
Java循环编程常见错误与优化实践
最新发布
静水深流
06-10 184
值得注意的是，基础的静态分析诊断（如"变量未使用"）无法检测此类问题，因为循环变量。该实现完全封装了索引操作，消除了客户端代码中显式使用索引的风险。建议在代码审查时特别关注循环体内索引变量的使用一致性，并针对边界情况（如空数组、单元素数组、多元素同值数组）设计专项测试用例。），将导致严重的无限循环问题。在需要逆向遍历集合时，开发者常犯的关键错误是修改循环条件后忘记调整递增/递减操作。开发者在循环结构中常犯的一个典型错误是：虽然正确编写了循环结构，但在循环体内错误地使用常量索引（如。停止更新，引发无限循环。
11《Java 类加载机制：从动态加载到热修复的底层秘密》
qq_62682600的博客
06-08 909
Java 类加载机制在运行期完成类的加载、连接与初始化，牺牲部分性能换灵活性，支持热修复、插件化等。其生命周期含 7 阶段，初始化有 5 种强制触发场景，动态性是热修复等技术的底层基础。
常见查找算法原理与应用详解
m0_74482103的博客
06-08 456
这些实现涵盖了从基础到高级的分块扩展查找算法，可根据具体数据特征和性能要求选择合适的方法。顺序查找是最简单的查找算法，从数据结构的一端开始，逐个检查每个元素，直到找到目标元素或遍历完整个结构。分块查找将数据划分为若干块，块内无序但块间有序。插值查找是二分查找的改进，通过计算目标值的位置来缩小范围。斐波那契查找利用斐波那契数列分割数组，适用于有序数据且数据量较大时。分块查找结合顺序查找和二分查找的思想，适合数据分块有序的场景。适用于超大规模数据的分块扩展查找。：数据分块存储且块间有序的查找。
什么是闭包，JavaScript闭包详解
qq_44136882的博客
06-09 898
JavaScript闭包详解：闭包是函数与可访问的外部变量的组合，具有记忆词法作用域的特性。核心特征在于函数能访问定义时的作用域变量，即使在其他位置执行。常见用途包括封装私有变量、创建函数工厂和处理回调。但需注意内存泄漏风险及循环中的变量共享问题。React Hooks也依赖闭包机制保存状态。理解闭包有助于编写高效灵活的代码，但需正确处理变量引用和生命周期。
Java 语言特性(面试系列1)
myy2012的专栏
06-10 1096
JVM 为节省内存，相同字面量的字符串共享同一个实例。：线程安全，分段锁实现（JDK8 采用 CAS+之间的对象，超出范围时创建新对象。
springCloud2025+springBoot3.5.0+Nacos集成redis从nacos拉配置起服务
zwrlj527的专栏
06-07 647
本文探讨了在搭建最新SpringCloud+SpringBoot3+Nacos微服务框架时，网关(Gateway)选择WebFlux响应式编程模型的原因及Redis集成的方案。作者对比了WebFlux与传统Servlet栈的性能优势，包括非阻塞I/O、高并发处理能力等技术特点。针对Redis集成问题，提出了两种解决方案：一种是自定义配置类RedisAfterNacosAutoConfiguration，确保在Nacos配置加载后初始化Redis连接；另一种是直接使用SpringBoot自动配置。文章还提供了
软件工程职业实践第一节课（6.9）
m0_73776435的博客
06-10 405
新建项目打开IDEA → 点击 New Project → 选择左侧的 ‌Spring Initializr‌。 配置项目信息： ‌Name‌：项目名称（如 demo） ‌Location‌：项目存储路径 ‌Type‌：Maven 或 Gradle（本文以Maven为例） ‌Language‌：Java ‌Group‌：包名前缀（如 com.example） ‌Artifact‌：项目标识（自动填充） ‌Java Version‌：选择JDK 17或24 ‌Spring Boot‌：选择最新稳定版本（如 3
java中 vo bo dto po的转换
02-12
### Java 中 VO、BO、DTO、PO 的转换方法 在Java开发中，为了保持不同层次间的解耦合以及数据的安全性和一致性，通常会使用不同的对象模型来表示同一逻辑实体的不同视图。这些对象包括VO（View Object）、BO（Business Object）、DTO（Data Transfer Object）和PO（Persistent Object）。下面将介绍如何在这几种对象之间进行转换。 #### 使用 MapStruct 实现自动映射 MapStruct 是一种用于简化类间属性复制工作的框架，可以减少手动编写繁琐的转换代码。通过定义接口并标注特定注解即可实现高效的双向映射功能[^1]。 ```java @Mapper(componentModel = "spring") public interface EntityDtoMapper { UserBo userPoToUserBo(UserPo po); UserDto userBoToUserDto(UserBo bo); } ``` 此段代码展示了从`UserPo`(持久化对象)到`UserBo`(业务对象)，再到`UserDto`(传输对象)的过程。借助于MapStruct自动生成具体的实现类完成实际的对象转换工作。 对于VO(视图对象), 如果前端请求或响应需要特殊格式的数据，则可以在控制器层进一步处理： ```java @RestController @RequestMapping("/users") public class UserController { @Autowired private UserService userService; @GetMapping("/{id}") public ResponseEntity<UserVo> getUser(@PathVariable Long id){ UserDto dto = userService.getUserById(id); // 假设这里有一个dtoToVo的方法来进行最终转换 return new ResponseEntity<>(dtoToVo(dto), HttpStatus.OK); } } private static UserVo dtoToVo(UserDto dto){ UserVo vo = new UserVo(); BeanUtils.copyProperties(dto,vo); // 可能还需要额外设置一些只读字段或者其他不适合放在DTO中的信息 return vo; } ``` 上述例子说明了当接收到HTTP GET请求时，先调用服务获取DTO实例，之后将其转化为适合前端使用的VO实例返回给客户端[^2]。 另外值得注意的是，在某些情况下可以直接利用DTO作为VO传递给前端而不需要单独创建VO类，尤其是在两者结构非常相似的情况下这样做能够有效降低系统的复杂度[^3]。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值