SpringBoot的MapStruct使用

已于 2023-06-05 10:21:52 修改
阅读量1.9k 收藏 2
点赞数
分类专栏： SpringBoot 文章标签： spring boot java spring
于 2023-06-05 10:17:00 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qinxun2008081/article/details/131041391
版权
本文介绍了如何使用MapStruct库在Java中实现对象间的转换，包括引入依赖、创建实体类和DTO、定义转换接口、处理属性名差异以及自定义转换方法。示例展示了从Person到PersonDto的转换，反之亦然，以及列表转换，并提供了针对不同属性类型的自定义转换策略。
摘要由CSDN通过智能技术生成

目的:MapStruct可以实现对象之间的转换

一、引入依赖

<!--lombok-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>
<!--mapstruct-->
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct</artifactId>
    <version>1.5.2.Final</version>
</dependency>
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-processor</artifactId>
    <version>1.5.2.Final</version>
</dependency>

二、创建两个实体类 Person和PersonDto

import lombok.*;

/**
 * @author qinxun
 * @date 2023-06-05
 * @Descripion: 人实体类
 */
@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class Person {

    private Long id;

    private String name;

    private Integer age;

}
import lombok.*;

/**
 * @author qinxun
 * @date 2023-06-05
 * @Descripion: 人的dto类
 */
@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class PersonDto {

    private Long id;

    private String name;

    private Integer age;

}

三、创建MapStruct对象转换接口

import com.example.quartzdemo.bean.Person;
import com.example.quartzdemo.dto.PersonDto;
import org.mapstruct.Mapper;
import org.mapstruct.factory.Mappers;

import java.util.List;

/**
 * @author qinxun
 * @date 2023-06-05
 * @Descripion: 人的对象mapstruct转换类
 */
@Mapper
public interface PersonConverter {

    // 使用工厂方法获取对象实例
    PersonConverter INSTANCE = Mappers.getMapper(PersonConverter.class);

    PersonDto personToPersonDto(Person person);

    Person personDtoToPerson(PersonDto personDto);

    List<PersonDto> personToPersonDto(List<Person> personList);

    List<Person> personDtoToPerson(List<PersonDto> personDtoList);

}

四、测试

import com.example.quartzdemo.bean.Person;
import com.example.quartzdemo.convert.PersonConverter;
import com.example.quartzdemo.dto.PersonDto;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.ArrayList;
import java.util.List;

@SpringBootTest
class QuartzDemoApplicationTests {

    /**
     * person转PersonDto
     */
    @Test
    void personToPersonDto() {
        Person person = new Person(1L, "张三", 25);
        PersonDto personDto = PersonConverter.INSTANCE.personToPersonDto(person);
        // 输出PersonDto(id=1, name=张三, age=25)
        System.out.println(personDto);
    }

    /**
     * personDto转Person
     */
    @Test
    void personDtoToPerson() {
        PersonDto personDto = new PersonDto(2L, "李四", 26);
        Person person = PersonConverter.INSTANCE.personDtoToPerson(personDto);
        // 输出Person(id=2, name=李四, age=26)
        System.out.println(person);
    }

    /**
     * personList转PersonDtoList
     */
    @Test
    void personListToPersonDtoList() {
        List<Person> personList = new ArrayList<>();
        personList.add(new Person(1L, "张三", 25));
        personList.add(new Person(2L, "李四", 26));
        List<PersonDto> personDtoList = PersonConverter.INSTANCE.personToPersonDto(personList);
        // 输出[PersonDto(id=1, name=张三, age=25), PersonDto(id=2, name=李四, age=26)]
        System.out.println(personDtoList);
    }

    /**
     * PersonDtoList转personList
     */
    @Test
    void prsonDtoListToPersonList() {
        List<PersonDto> personDtoList = new ArrayList<>();
        personDtoList.add(new PersonDto(1L, "张三", 25));
        personDtoList.add(new PersonDto(2L, "李四", 26));
        List<Person> personList = PersonConverter.INSTANCE.personDtoToPerson(personDtoList);
        // 输出[Person(id=1, name=张三, age=25), Person(id=2, name=李四, age=26)]
        System.out.println(personList);
    }

}

五、如果遇到两个实体类属性名不相同的情况，我们需要对转换器接口进行处理

import java.io.Serializable;

/**
 * @author qinxun
 * @date 2023-06-05
 * @Descripion: 人实体类
 */
@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class Person implements Serializable {

    private Long id;

    private String name;

    private Integer age;

    private String address;
    

}


import lombok.*;

/**
 * @author qinxun
 * @date 2023-06-05
 * @Descripion: 人的dto类
 */
@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class PersonDto {

    private Long id;

    private String name;

    private Integer age;

    private String addr;

}

两个对象的address和addr代表同一个意思，但是表现形式不一样。

我们需要对转换接口进行映射处理

import com.example.quartzdemo.bean.Person;
import com.example.quartzdemo.dto.PersonDto;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers;

import java.util.List;

/**
 * @author qinxun
 * @date 2023-06-05
 * @Descripion: 人的对象mapstruct转换类
 */
@Mapper
public interface PersonConverter {

    // 使用工厂方法获取对象实例
    PersonConverter INSTANCE = Mappers.getMapper(PersonConverter.class);

    // source:需要转换的属性 target:转换后的属性
    @Mappings({
            @Mapping(source = "address", target = "addr")
    })
    PersonDto personToPersonDto(Person person);

    @Mappings({
            @Mapping(source = "addr", target = "address")
    })
    Person personDtoToPerson(PersonDto personDto);

    @Mappings({
            @Mapping(source = "address", target = "addr")
    })
    List<PersonDto> personToPersonDto(List<Person> personList);

    @Mappings({
            @Mapping(source = "addr", target = "address")
    })
    List<Person> personDtoToPerson(List<PersonDto> personDtoList);

}

测试:

import com.example.quartzdemo.bean.Person;
import com.example.quartzdemo.convert.PersonConverter;
import com.example.quartzdemo.dto.PersonDto;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.ArrayList;
import java.util.List;

@SpringBootTest
class QuartzDemoApplicationTests {

    /**
     * person转PersonDto
     */
    @Test
    void personToPersonDto() {
        Person person = new Person(1L, "张三", 25, "广州");
        PersonDto personDto = PersonConverter.INSTANCE.personToPersonDto(person);
        // 输出PersonDto(id=1, name=张三, age=25, addr=广州)
        System.out.println(personDto);
    }

    /**
     * personDto转Person
     */
    @Test
    void personDtoToPerson() {
        PersonDto personDto = new PersonDto(2L, "李四", 26, "广州");
        Person person = PersonConverter.INSTANCE.personDtoToPerson(personDto);
        // 输出Person(id=2, name=李四, age=26, address=广州)
        System.out.println(person);
    }

    /**
     * personList转PersonDtoList
     */
    @Test
    void personListToPersonDtoList() {
        List<Person> personList = new ArrayList<>();
        personList.add(new Person(1L, "张三", 25, "广州"));
        personList.add(new Person(2L, "李四", 26, "广州"));
        List<PersonDto> personDtoList = PersonConverter.INSTANCE.personToPersonDto(personList);
        // 输出[PersonDto(id=1, name=张三, age=25, addr=广州), PersonDto(id=2, name=李四, age=26, addr=广州)]
        System.out.println(personDtoList);
    }

    /**
     * PersonDtoList转personList
     */
    @Test
    void prsonDtoListToPersonList() {
        List<PersonDto> personDtoList = new ArrayList<>();
        personDtoList.add(new PersonDto(1L, "张三", 25, "广州"));
        personDtoList.add(new PersonDto(2L, "李四", 26, "广州"));
        List<Person> personList = PersonConverter.INSTANCE.personDtoToPerson(personDtoList);
        // 输出[Person(id=1, name=张三, age=25, address=广州), Person(id=2, name=李四, age=26, address=广州)]
        System.out.println(personList);
    }

}

六、自定义转换 对于某些类型，没有办法通过代码生成器来进行处理，就需要自定义方法来进行转换。

import java.io.Serializable;

/**
 * @author qinxun
 * @date 2023-06-05
 * @Descripion: 人实体类
 */
@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class Person implements Serializable {

    private Long id;

    private String name;

    private Integer age;

    private String address;

    private SubPerson subPerson;


}

@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class SubPerson {

    private Integer deleted;

    private String name;

}

import lombok.*;

/**
 * @author qinxun
 * @date 2023-06-05
 * @Descripion: 人的dto类
 */
@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class PersonDto {

    private Long id;

    private String name;

    private Integer age;

    private String addr;

    private SubPersonDto subPersonDto;
}

@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class SubPersonDto {

    private Boolean result;

    private String name;

}

转换接口中添加自定义的转换方法

import com.example.quartzdemo.bean.Person;
import com.example.quartzdemo.bean.SubPerson;
import com.example.quartzdemo.dto.PersonDto;
import com.example.quartzdemo.dto.SubPersonDto;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers;

import java.util.List;

/**
 * @author qinxun
 * @date 2023-06-05
 * @Descripion: 人的对象mapstruct转换类
 */
@Mapper
public interface PersonConverter {

    // 使用工厂方法获取对象实例
    PersonConverter INSTANCE = Mappers.getMapper(PersonConverter.class);

    // source:需要转换的属性 target:转换后的属性
    @Mappings({
            @Mapping(source = "address", target = "addr"),
            @Mapping(source = "subPerson", target = "subPersonDto")
    })
    PersonDto personToPersonDto(Person person);

    @Mappings({
            @Mapping(source = "addr", target = "address"),
            @Mapping(source = "subPersonDto", target = "subPerson")
    })
    Person personDtoToPerson(PersonDto personDto);

    @Mappings({
            @Mapping(source = "address", target = "addr"),
            @Mapping(source = "subPerson", target = "subPersonDto")
    })
    List<PersonDto> personToPersonDto(List<Person> personList);

    @Mappings({
            @Mapping(source = "addr", target = "address"),
            @Mapping(source = "subPersonDto", target = "subPerson")
    })
    List<Person> personDtoToPerson(List<PersonDto> personDtoList);

    /**
     * 属性的自定义转换
     */
    default SubPersonDto subPersonToSubPersonDto(SubPerson subPerson) {
        if (subPerson == null) {
            return null;
        }
        SubPersonDto subPersonDto = new SubPersonDto();
        subPersonDto.setResult(!subPerson.getDeleted().equals(0));
        subPersonDto.setName(subPerson.getName());
        return subPersonDto;
    }

    /**
     * 属性的自定义转换
     */
    default SubPerson subPersonDtoToSubPerson(SubPersonDto subPersonDto) {
        if (subPersonDto == null) {
            return null;
        }
        SubPerson subPerson = new SubPerson();
        subPerson.setDeleted(subPersonDto.getResult() ? 1 : 0);
        subPerson.setName(subPersonDto.getName());
        return subPerson;
    }
}

测试

import com.example.quartzdemo.bean.Person;
import com.example.quartzdemo.bean.SubPerson;
import com.example.quartzdemo.convert.PersonConverter;
import com.example.quartzdemo.dto.PersonDto;
import com.example.quartzdemo.dto.SubPersonDto;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.ArrayList;
import java.util.List;

@SpringBootTest
class QuartzDemoApplicationTests {

    /**
     * person转PersonDto
     */
    @Test
    void personToPersonDto() {
        SubPerson subPerson = new SubPerson(0, "zhangsan");
        Person person = new Person(1L, "张三", 25, "广州", subPerson);
        PersonDto personDto = PersonConverter.INSTANCE.personToPersonDto(person);
        // 输出PersonDto(id=1, name=张三, age=25, addr=广州, subPersonDto=SubPersonDto(result=false, name=zhangsan))
        System.out.println(personDto);
    }

    /**
     * personDto转Person
     */
    @Test
    void personDtoToPerson() {
        SubPersonDto subPersonDto = new SubPersonDto(false, "lisi");
        PersonDto personDto = new PersonDto(2L, "李四", 26, "广州", subPersonDto);
        Person person = PersonConverter.INSTANCE.personDtoToPerson(personDto);
        // 输出Person(id=2, name=李四, age=26, address=广州, subPerson=SubPerson(deleted=0, name=lisi))
        System.out.println(person);
    }

    /**
     * personList转PersonDtoList
     */
    @Test
    void personListToPersonDtoList() {
        List<Person> personList = new ArrayList<>();
        personList.add(new Person(1L, "张三", 25, "广州", new SubPerson(0, "zhangsan")));
        personList.add(new Person(2L, "李四", 26, "广州", new SubPerson(1, "lisi")));
        List<PersonDto> personDtoList = PersonConverter.INSTANCE.personToPersonDto(personList);
        // 输出[PersonDto(id=1, name=张三, age=25, addr=广州, subPersonDto=SubPersonDto(result=false, name=zhangsan)), PersonDto(id=2, name=李四, age=26, addr=广州, subPersonDto=SubPersonDto(result=true, name=lisi))]
        System.out.println(personDtoList);
    }

    /**
     * PersonDtoList转personList
     */
    @Test
    void prsonDtoListToPersonList() {
        List<PersonDto> personDtoList = new ArrayList<>();
        personDtoList.add(new PersonDto(1L, "张三", 25, "广州", new SubPersonDto(false, "zhangsan")));
        personDtoList.add(new PersonDto(2L, "李四", 26, "广州", new SubPersonDto(true, "lisi")));
        List<Person> personList = PersonConverter.INSTANCE.personDtoToPerson(personDtoList);
        // 输出[Person(id=1, name=张三, age=25, address=广州, subPerson=SubPerson(deleted=0, name=zhangsan)), Person(id=2, name=李四, age=26, address=广州, subPerson=SubPerson(deleted=1, name=lisi))]
        System.out.println(personList);
    }

}

qinxun2008081
关注
专栏目录
【微服务】springboot整合对象映射工具MapStruct使用详解
congge
08-25 4996
springboot 整合 MapStruct 使用详解
SpringBoot入门教程：MapStruct
人不风流枉少年
11-05 1209
开发中我们可能使用通用Mapper或者MyBatis-Plus去查询数据，而这类框架都是返回的实体，实体是和数据库中的表一一对应的，而作为接口的返回值我们无需把整个实体都暴露给前端，这就需要将实体转为DTO了，通常有以下转换方式： 自己写代码手动转换（这种方式代码量多，而且不优雅） BeanUtils.copyProperties(entity, dto)，这种方式是通过反射来实现的，一般反射效率相对有点低 使用ModelMapper框架（这种方式是通过反射来实现的，一般反射效率相对有点低）
【springboot进阶】优雅使用 MapStruct 进行类复制
热门推荐
11-13 1万+
实体映射工具类 MapStruct 的介绍、使用和配置，并结合一般项目使用情况进行演示。对调试过程出现的 java.lang.NoSuchMethodError 异常进行说明并提供解决方法。
mapstruct_sandbox:在SpringBoot项目中使用mapstruct玩沙盒
05-19
mapstruct_sandbox 沙盒，用于在SpringBoot项目中使用Mapstruct，H2和Liquibase MapStruct概述 MapStruct是一个代码生成器，它基于约定优于配置的方法极大地简化了Java bean类型之间映射的实现。 项目设置 用途： 摇动 H2 液基 Sprint Boot 地图结构 运行说明 ./gradlew bootRun REST URL //待办事项 IntelliJ配置 为了能够使用代码完成功能并从IntelliJ运行应用程序，您必须做两件事： 启用构建/运行委派以进行gradle（设置->构建/运行/部署-> Gradle-> Runner） 从Idea Repository安装mapstruct-plugin
【微服务】SpringBoot 整合对象映射工具 MapStruct 使用详解
最新发布
小蜗牛的珍贵百宝箱
09-30 1408
MapStruct 是一个用于 Java Bean 之间转换的代码生成器，能够自动生成对象映射的代码。在编译时，MapStruct 会生成高效的、类型安全的代码来实现对象之间的映射，无需运行时依赖。它可以帮助开发者节省手动编写转换逻辑的时间，同时保证代码的性能和可读性。接下来，我们定义一个UserMapper接口，通过 MapStruct 的@Mapper注解来表示这是一个映射接口。@Mapper// 将 User 映射为 UserDTO// 将 UserDTO 映射为 User。
第三十章：SpringBoot使用MapStruct自动映射DTO
恒宇少年De成长之路
08-20 2235
MapStruct是一种类型安全的bean映射类生成java注释处理器。 我们要做的就是定义一个映射器接口，声明任何必需的映射方法。在编译的过程中，MapStruct会生成此接口的实现。该实现使用纯java方法调用的源和目标对象之间的映射，MapStruct节省了时间，通过生成代码完成繁琐和容易出错的代码逻辑。下面我们来揭开它的神秘面纱 本章目标 基于SpringBoot平台完成M...
【SpringBoot】MapStruct实现优雅的数据复制
k123456kah的博客
05-20 2189
1.为什么选择MapStruct2.MapStruct快速入门3.MapStruct进阶4.字段的逻辑处理一般来说，不使用MapStruct框架进行属性映射，常有的方法以下两种：这种方法最朴素，手动编写代码将源对象的属性存入目标对象，需要注意实体类中嵌套属性的判空操作以防止空指针异常。底层使用的是反射机制实现属性的映射。反射是一种在运行时动态获取类信息、调用方法或访问字段的机制，无法利用JVM的优化机制，因此通常比直接方法调用慢得多。此外， 只能同属性映射，或者在属性相同的情况下，允许被映射的对象属性少；但
Springboot整合MapStruct 简单使用
音乐土豆
01-27 6522
Springboot整合 MapStruct 简单应用
springboot集成mapstruct快速入门指南
wjianwei666的专栏
07-13 855
这里以成员变量的参数名为依据，如果有嵌套比如 Car 里面有个 CarType 类型的成员变量 carType，其 type 属性 来映射 CarDTO 中的 type 字符串，我们使用 type.type 来获取属性值。这也是其性能比较好的原因之一。MapStruct 就是这样的一个属性映射工具，只需要定义一个 Mapper 接口，MapStruct就会自动实现这个映射接口，避免了复杂繁琐的映射实现。输出结果 {"make":"make","seatCount":1,"type":"type"}
SpringBoot集成MapStruct
程序员必须坚持写博客，没人看也要写
11-24 1370
SpringBoot集成MapStruct
spring boot3+jpa+lombok+mapstruct实现的restful api例子
05-08
在本项目中，"spring boot3+jpa+lombok+mapstruct实现的restful api例子"是一个集成多种技术的示例，旨在展示如何高效地构建RESTful API服务。下面将详细介绍这些关键技术及其相互间的配合。 1. **Spring Boot 3**:...
如何在SpringBoot集成mapstruct实现类型转换？一篇文章搞定！
网络技术联盟站
12-25 3168
MapStruct是一款用于生成Java bean映射代码的代码生成器。它通过使用注解处理器，在编译时生成映射代码，避免了手动编写重复且容易出错的映射逻辑。MapStruct的生成代码非常高效，接近手动编写的性能，同时提供了丰富的注解配置，支持灵活的映射规则。MapStruct使用@Mapper注解标识接口，通过在接口的抽象方法上添加@Mapping等注解来配置映射规则。MapStruct在编译时生成映射代码，消除了运行时的性能开销，同时提高了代码的类型安全性。
个人使用:16 Springboot中MapStruct的项目实践
qq_32871365的博客
08-23 651
场景: 启动项目报错，报错内容是 org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type "XXX" 探索方法: 1.对应spring注解是否正常写入 @Service 等等 经过判断，正常写入 2.是否是对应放置位置错误，对应启动项未正常扫描 经过判断，放置位置在其他包等同位置，正常可以扫描到。 3.删除上一个版本改动代码，项目正常启动。 通过排除法可以确定，使得项.
Spring Boot中使用MapStruct进行对象映射
省赚客开发者博客
06-26 486
通过本文的介绍，你现在应该对如何在Spring Boot项目中使用MapStruct进行对象映射有了更深入的理解。MapStruct不仅能够简化对象之间的复杂映射转换，还能够提升代码的可维护性和性能。在实际项目中，合理利用MapStruct可以显著减少开发工作量，同时保证映射转换的准确性和效率。
idea整合git_SpringBoot2.0实战（7）整合MapStruct优雅地复制属性
weixin_39997696的博客
11-28 509
在之前章节的例子中，我们在接收参数的时候都是使用的 User 类对象，这是一个 DO 对象，是用于与数据库进行交互的，而不是用于与前端业务进行交互的，所以需要创建一个 BO 业务对象用来与前端业务进行交互，保证数据隔离性及安全性。接收参数换成了 BO 对象，但数据入库使用的是 DO 对象，这中间就需要将 BO 对象的属性复制到 DO 对象，然后代码里就会出现大量的 do.set(bo.get())...
springboot整合mapstruct的基础使用
m0_51294769的博客
12-16 908
springboot整合mapstruc的使用
spring boot 之使用mapstruct
weixin_38168559的博客
08-19 1241
　　最近在阅读swagger源码，当看到 springfox.documentation.swagger2.mappers.ModelMapper 类时，无意中看到该类上面使用的 org.mapstruct.Mapper 注解时，对这个注解一时竟想不出个所意然来。便打开百度搜索了一番，有关这个注解的文章不是很多，从这些文章中了解到，这个注解跟JSR 269 有关，下面列出这个注解相关的文...
springboot使用mapstruct
09-10
在Spring Boot中使用MapStruct可以帮助我们快速、方便地进行对象之间的转换。 首先，我们需要在pom.xml文件中添加MapStruct的依赖： ```xml <groupId>org.mapstruct <artifactId>mapstruct <version>1.4.2.Final...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

qinxun2008081

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值