Spring Boot | 集成MapStruct实现不同类型Java对象间的自动转换

简介: MapStruct是一个开源的代码生成器,极大地简化了从一种Java对象到另一种Java对象的转换过程。MapStruct常用注解

MapStruct简介

MapStruct is a code generator that greatly simplifies the implementation of mappings between Java bean types based on a convention over configuration approach.
The generated mapping code uses plain method invocations and thus is fast, type-safe and easy to understand.
—— 引自MapStruct官网

MapStruct是一个开源的代码生成器,极大地简化了从一种Java对象到另一种Java对象的转换过程。
MapStruct常用注解

00.png

注解说明@Mapper用于标注Mapper接口,MapStruct根据接口定义自动生成Mapper实现类。@Mapping用于标注接口方法或者参数,指示源属性与目标属性之间的映射关系。可以通过source和target属性指定源和目标属性的名称。@Mappings用于标注多个@Mapping注解,方便在一个接口方法中定义多个属性的映射关系。
@Mapper注解常用属性:

componentModel属性:默认值为default。在Spring项目中通过自动注入的方式使用MapStruct Mapper类,需要将componentModel属性的属性值改为spring。
unmappedTargetPolicy属性:指定目标对象中未映射属性的处理策略。默认为IGNORE,表示忽略未映射的属性。其他可选值包括WARN、ERROR和REPORT。

集成MapStruct
添加MapStruct依赖
修改pom.xml文件,添加如下代码:
...

<java.version>1.8</java.version>
<lombok.version>1.18.24</lombok.version>
<mapstruct.version>1.5.3.Final</mapstruct.version>

...

<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>


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



...

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



复制代码
说明:

mapstruct-processor:MapStruct注解处理器。

入门示例:属性完全相同
1、创建一个实体类 —— User.java
package cn.ddcherry.springboot.demo.entity;

import lombok.AllArgsConstructor;
import lombok.Data;

@Data
@AllArgsConstructor
public class User {

private String id;
private String usercode;
private String name;

}
复制代码
2、创建一个DTO类 —— UserDto.java
package cn.ddcherry.springboot.demo.dto;

import lombok.AllArgsConstructor;
import lombok.Data;

@Data
@AllArgsConstructor
public class UserDto {

private String id;
private String usercode;
private String name;

}
复制代码
说明:
实体类和DTO类的属性(类型、名称)完全相同。
3、创建一个转换器类 —— UserMapper.java
package cn.ddcherry.springboot.demo.mapper;

import cn.ddcherry.springboot.demo.dto.UserDto;
import cn.ddcherry.springboot.demo.entity.User;
import org.mapstruct.Mapper;

import java.util.List;

@Mapper(componentModel = "spring")
public interface UserMapper {

UserDto toDto(User entity);
User toEntity(UserDto dto);
List<UserDto> toDto(List<User> entityList);
List<User> toEntity(List<UserDto> dtoList);

}
复制代码
4、创建一个测试类 —— UserMapperTest.java
package cn.ddcherry.springboot.demo;

import cn.ddcherry.springboot.demo.dto.UserDto;
import cn.ddcherry.springboot.demo.entity.User;
import cn.ddcherry.springboot.demo.mapper.UserMapper;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import javax.annotation.Resource;

@SpringBootTest
public class UserMapperTest {

@Resource
private UserMapper userMapper;

@Test
public void testEntityToDto() {
    User user = new User("001", "user-001", "嗨皮汪小成");
    UserDto dto = userMapper.toDto(user);
    System.out.println(dto);
}

}
复制代码
输出结果:
UserDto(id=001, usercode=user-001, name=嗨皮汪小成)
复制代码
程序运行成功后,我们可以在IDEA中打开target目录下的class文件,看一下MapStruct自动生成的转换器实现。笔者汪小成截取了toDto(...)和toDtoList(...)两个方法的实现,如下图:

简单封装
在Spring Boot项目中,我们可以将Entity与DTO间转换的方法提取到一个基础转换器中,其它所有需要进行Entity与DTO转换的类都继承这个类。
基础转换器类 —— BaseMapper.java
package cn.ddcherry.springboot.demo.mapper;

import java.util.List;

public interface BaseMapper<D, E> {

D toDto(E entity);
E toEntity(D dto);
List<D> toDto(List<E> entityList);
List<E> toEntity(List<D> dtoList);

}
复制代码
一个具体转换器类 —— UserMapper.java
package cn.ddcherry.springboot.demo.mapper;

import cn.ddcherry.springboot.demo.dto.UserDto;
import cn.ddcherry.springboot.demo.entity.User;
import org.mapstruct.Mapper;
import org.mapstruct.ReportingPolicy;

@Mapper(componentModel = "spring",unmappedTargetPolicy = ReportingPolicy.IGNORE)
public interface UserMapper extends BaseMapper<UserDto, User> {
}

相关文章
|
14天前
|
Java 关系型数据库 MySQL
SpringBoot 通过集成 Flink CDC 来实时追踪 MySql 数据变动
通过详细的步骤和示例代码,您可以在 SpringBoot 项目中成功集成 Flink CDC,并实时追踪 MySQL 数据库的变动。
119 43
|
16天前
|
XML Java 测试技术
Spring AOP—通知类型 和 切入点表达式 万字详解(通俗易懂)
Spring 第五节 AOP——切入点表达式 万字详解!
79 25
|
16天前
|
监控 前端开发 Java
SpringBoot集成Tomcat、DispatcherServlet
通过这些配置,您可以充分利用 Spring Boot 内置的功能,快速构建和优化您的 Web 应用。
48 21
|
1月前
|
XML JavaScript Java
SpringBoot集成Shiro权限+Jwt认证
本文主要描述如何快速基于SpringBoot 2.5.X版本集成Shiro+JWT框架,让大家快速实现无状态登陆和接口权限认证主体框架,具体业务细节未实现,大家按照实际项目补充。
87 11
|
1月前
|
监控 Java Nacos
使用Spring Boot集成Nacos
通过上述步骤,Spring Boot应用可以成功集成Nacos,利用Nacos的服务发现和配置管理功能来提升微服务架构的灵活性和可维护性。通过这种集成,开发者可以更高效地管理和部署微服务。
208 17
|
1月前
|
缓存 安全 Java
Spring Boot 3 集成 Spring Security + JWT
本文详细介绍了如何使用Spring Boot 3和Spring Security集成JWT,实现前后端分离的安全认证概述了从入门到引入数据库,再到使用JWT的完整流程。列举了项目中用到的关键依赖,如MyBatis-Plus、Hutool等。简要提及了系统配置表、部门表、字典表等表结构。使用Hutool-jwt工具类进行JWT校验。配置忽略路径、禁用CSRF、添加JWT校验过滤器等。实现登录接口,返回token等信息。
369 12
|
1月前
|
人工智能 达摩院 并行计算
VideoRefer:阿里达摩院开源视频对象感知与推理框架,可集成 VLLM 提升其空间和时间理解能力
VideoRefer 是浙江大学与阿里达摩学院联合推出的视频对象感知与推理技术,支持细粒度视频对象理解、复杂关系分析及多模态交互,适用于视频剪辑、教育、安防等多个领域。
158 17
VideoRefer:阿里达摩院开源视频对象感知与推理框架,可集成 VLLM 提升其空间和时间理解能力
|
1月前
|
存储 安全 Java
Spring Boot 3 集成Spring AOP实现系统日志记录
本文介绍了如何在Spring Boot 3中集成Spring AOP实现系统日志记录功能。通过定义`SysLog`注解和配置相应的AOP切面,可以在方法执行前后自动记录日志信息,包括操作的开始时间、结束时间、请求参数、返回结果、异常信息等,并将这些信息保存到数据库中。此外,还使用了`ThreadLocal`变量来存储每个线程独立的日志数据,确保线程安全。文中还展示了项目实战中的部分代码片段,以及基于Spring Boot 3 + Vue 3构建的快速开发框架的简介与内置功能列表。此框架结合了当前主流技术栈,提供了用户管理、权限控制、接口文档自动生成等多项实用特性。
84 8
|
2月前
|
XML 安全 Java
Spring Boot中使用MapStruct进行对象映射
本文介绍如何在Spring Boot项目中使用MapStruct进行对象映射,探讨其性能高效、类型安全及易于集成等优势,并详细说明添加MapStruct依赖的步骤。
|
2月前
|
XML Java API
Spring Boot集成MinIO
本文介绍了如何在Spring Boot项目中集成MinIO,一个高性能的分布式对象存储服务。主要步骤包括:引入MinIO依赖、配置MinIO属性、创建MinIO配置类和服务类、使用服务类实现文件上传和下载功能,以及运行应用进行测试。通过这些步骤,可以轻松地在项目中使用MinIO的对象存储功能。
149 5

热门文章

最新文章