MapStruct入门使用

最新推荐文章于 2024-08-16 18:50:36 发布
最新推荐文章于 2024-08-16 18:50:36 发布
阅读量474 收藏 1
点赞数
分类专栏： Java 文章标签： java spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/oschina_41731918/article/details/126089996
版权

文章目录

背景

在实际的项目开发中会大量的使用POJO作为数据载体，通常有如下的：

实体名实体含义说明
DOData Object与数据库表结构一一对应，通过DAO层向上传输数据源对象
DTOData Transfer Object数据传输对象，Service或Manager向外传输的对象
BOBusiness Object业务对象，由Service层输出的封装业务逻辑的对象
VOView Object显示层对象，通常是 Web 向模板渲染引擎层传输的对象
  • Spring BeanUtils
  • Apache BeanUtils
  • Orika的MapperFacade和MapperFactory
  • MapStruct
    可以选择MapStruct，功能十分强大，而且很灵活，可以满足我们需要的各种需求。

入门案例

Maven项目引入

只需要在pom.xml文件中加入以下依赖即可：

...
<properties>
        <java.version>1.8</java.version>
        <mapstruct.version>1.3.1.Final</mapstruct.version>
    </properties>
...
    <dependencies>
        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct</artifactId>
            <version>${mapstruct.version}</version>
        </dependency>
    </dependencies>
...
    <build>
        <plugins>
            <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>
                    </annotationProcessorPaths>
                </configuration>
            </plugin>
        </plugins>
    </build>
...

源对象

在这里插入图片描述

CarDO

package com.linfanchen.springboot.lab.mapstruct.domain;

public class CarDO {
    /**
     * 主键ID
     */
    private Integer id;

    /**
     * 名称
     */
    private String name;

    /**
     * 品牌
     */
    private String brand;

    /**
     * 车价
     */
    private Integer price;

    /**
     * 轮胎属性
     */
    private TyreDO tyreDO;

    /**
     * 汽车图片
     */
    private String images;

    public String getImages() {
        return images;
    }

    public void setImages(String images) {
        this.images = images;
    }

    public TyreDO getTyreDO() {
        return tyreDO;
    }

    public void setTyreDO(TyreDO tyreDO) {
        this.tyreDO = tyreDO;
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getBrand() {
        return brand;
    }

    public void setBrand(String brand) {
        this.brand = brand;
    }

    public Integer getPrice() {
        return price;
    }

    public void setPrice(Integer price) {
        this.price = price;
    }
}

TyreDO

package com.linfanchen.springboot.lab.mapstruct.domain;

/**
 * 轮胎
 */
public class TyreDO {
    /**
     * 主键ID
     */
    private Integer id;

    /**
     * 轮胎名称
     */
    private String name;

    /**
     * 轮胎尺寸
     */
    private Integer size;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getSize() {
        return size;
    }

    public void setSize(Integer size) {
        this.size = size;
    }
}

目标对象

CarBO

package com.linfanchen.springboot.lab.mapstruct.bo;

import com.linfanchen.springboot.lab.mapstruct.domain.TyreDO;

import java.util.List;

/**
 * 汽车业务对象
 */
public class CarBO {
    /**
     * 主键ID
     */
    private Integer id;

    /**
     * 名称
     */
    private String name;

    /**
     * 品牌
     */
    private String brand;

    /**
     * 车价
     */
    private Integer price;

    /**
     * 轮胎属性
     */
    private TyreDO tyreDO;

    /**
     * 汽车图片
     */
    private String images;


    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getBrand() {
        return brand;
    }

    public void setBrand(String brand) {
        this.brand = brand;
    }

    public Integer getPrice() {
        return price;
    }

    public void setPrice(Integer price) {
        this.price = price;
    }

    public TyreDO getTyreDO() {
        return tyreDO;
    }

    public void setTyreDO(TyreDO tyreDO) {
        this.tyreDO = tyreDO;
    }

    public String getImages() {
        return images;
    }

    public void setImages(String images) {
        this.images = images;
    }
}

CarDetailBO

package com.linfanchen.springboot.lab.mapstruct.bo;

import com.linfanchen.springboot.lab.mapstruct.domain.TyreDO;

import java.util.List;

/**
 * 汽车业务对象
 */
public class CarDetailBO {
    /**
     * 主键ID
     */
    private Integer carId;

    /**
     * 名称
     */
    private String carName;

    /**
     * 品牌
     */
    private String carBrand;

    /**
     * 车价
     */
    private Integer price;

    /**
     * 轮胎属性
     */
    private TyreDO tyreDetail;

    /**
     * 汽车图片
     */
    private List<String> images;


    public Integer getCarId() {
        return carId;
    }

    public void setCarId(Integer carId) {
        this.carId = carId;
    }

    public String getCarName() {
        return carName;
    }

    public void setCarName(String carName) {
        this.carName = carName;
    }

    public String getCarBrand() {
        return carBrand;
    }

    public void setCarBrand(String carBrand) {
        this.carBrand = carBrand;
    }

    public Integer getPrice() {
        return price;
    }

    public void setPrice(Integer price) {
        this.price = price;
    }

    public TyreDO getTyreDetail() {
        return tyreDetail;
    }

    public void setTyreDetail(TyreDO tyreDetail) {
        this.tyreDetail = tyreDetail;
    }

    public List<String> getImages() {
        return images;
    }

    public void setImages(List<String> images) {
        this.images = images;
    }
}

转换器 CarConvert

说明：

  • INSTANCE 是MapStruct为我们提供的映射工厂，指定接口类型后自动帮我们创建接口的实现，且保证是线程安全的单例，无需自己手动创建。
package com.linfanchen.springboot.lab.mapstruct.convert;

import com.linfanchen.springboot.lab.mapstruct.bo.CarBO;
import com.linfanchen.springboot.lab.mapstruct.bo.CarDetailBO;
import com.linfanchen.springboot.lab.mapstruct.domain.CarDO;
import org.apache.commons.lang3.StringUtils;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.Named;
import org.mapstruct.factory.Mappers;

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

/**
 * 转换类
 */
@Mapper
public interface CarConvert {

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

    /**
     * 来源和目标类的直接转换
     */
    CarBO convert(CarDO carDO);

    /**
     * 添加字段处理和映射关系后的转换
     */
    @Mappings({
            @Mapping(source = "id", target = "carId"),
            @Mapping(source = "name", target = "carName"),
            @Mapping(source = "brand", target = "carBrand"),
            @Mapping(source = "tyreDO.id", target = "tyreDetail.id"),
            @Mapping(source = "tyreDO.name", target = "tyreDetail.name"),
            @Mapping(source = "tyreDO.size", target = "tyreDetail.size"),
            @Mapping(source = "images", target = "images", qualifiedByName = "convertImagesStrToList")

    })
    CarDetailBO convertDetail(CarDO carDO);

    @Named("convertImagesStrToList")
    default List<String> convertImagesStrToList(String images) {
        String[] splitArr = org.springframework.util.StringUtils.split(images, ",");
        return new ArrayList<>(Arrays.asList(splitArr));
    }

}

使用 CarTest

package com.linfanchen.springboot.lab.mapstruct;

import com.linfanchen.springboot.lab.mapstruct.bo.CarBO;
import com.linfanchen.springboot.lab.mapstruct.bo.CarDetailBO;
import com.linfanchen.springboot.lab.mapstruct.convert.CarConvert;
import com.linfanchen.springboot.lab.mapstruct.domain.CarDO;
import com.linfanchen.springboot.lab.mapstruct.domain.TyreDO;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

@RunWith(SpringRunner.class)
@SpringBootTest
public class CarTest {

    @Test
    public void test() {
        // 创建轮胎对象
        TyreDO tyreDO = new TyreDO();
        tyreDO.setId(888);
        tyreDO.setName("米其林245/45R19");
        tyreDO.setSize(19);

        // 汽车图片地址，通过半角逗号分隔的http地址
        List<String> imageList = new ArrayList<>();
        imageList.add("https://www.bmw.com.cn/image.1601043751651.jpg");
        imageList.add("https://www.bmw.com.cn/image.1623295725814.jpg");
        imageList.add("https://www.bmw.com.cn/image.1611042489480.jpg");
        String imageStr = imageList.stream().map(String::valueOf).collect(Collectors.joining(","));

        // 创建汽车对象
        CarDO carDO = new CarDO();
        carDO.setId(123);
        carDO.setBrand("BMW");
        carDO.setName("宝马530Li行政版");
        carDO.setPrice(540000);
        carDO.setTyreDO(tyreDO);
        carDO.setImages(imageStr);

        // 直接的数据拷贝
        CarBO carBO = CarConvert.INSTANCE.convert(carDO);
        System.out.println(carBO.getImages());
        System.out.println(carBO.getBrand());
        System.out.println(carBO.getName());
        System.out.println(carBO.getTyreDO());

        // 带数据转换的拷贝
        CarDetailBO carDetailBO = CarConvert.INSTANCE.convertDetail(carDO);
        System.out.println(carDetailBO.getImages());
        System.out.println(carDetailBO.getTyreDetail().getName());
    }

}

总结

在需要进行对象的转换的时候，我们可以使用MapStruct进行各种灵活的转换，最终得到我们想要的数据。

参考文档：

官方文档

MapStruct使用指南

凡尘技术
关注
专栏目录
【项目实战】基于Java的代码生成器——MapStruct入门介绍
本本本添哥
04-10 386
MapStruct是一个非常实用的Java注解处理器，可以大大简化Java对象之间的转换工作。通过使用MapStruct，可以提高开发效率、减少错误，并且具有良好的类型安全和性能表现。
springboot集成mapstruct快速入门指南
wjianwei666的专栏
07-13 821
这里以成员变量的参数名为依据，如果有嵌套比如 Car 里面有个 CarType 类型的成员变量 carType，其 type 属性 来映射 CarDTO 中的 type 字符串，我们使用 type.type 来获取属性值。这也是其性能比较好的原因之一。MapStruct 就是这样的一个属性映射工具，只需要定义一个 Mapper 接口，MapStruct就会自动实现这个映射接口，避免了复杂繁琐的映射实现。输出结果 {"make":"make","seatCount":1,"type":"type"}
MapStruct简单入门
白萝卜弟弟的专栏
09-01 308
与动态映射框架相比，MapStruct 具有以下优点：通过使用普通方法调用而不是反射来快速执行编译时类型安全：只能映射相互映射的对象和属性。在构建时清除错误报告，如果映射不完整（并非所有目标属性都已映射）映射不正确（找不到合适的映射方法或类型转换）缺点：通过在开发中生成源代码的方式实现，所以对于动态对象数据拷贝并不适合。
mapstruct
最新发布
weixin_46455069的博客
08-16 816
MapStruct 核心概念MapStruct是一个Java注解处理器，它的主要功能是自动生成类型安全、高性能且无依赖的bean映射代码。这个工具基于“约定优于配置”的原则，极大地简化了Java Bean类型之间的映射实现过程。在多层架构的应用中，经常需要在不同的对象模型之间进行转换，例如在持久层的实体和传输层的DTO（Data Transfer Object，数据传输对象）之间。手动编写这种映射代码是一项繁琐且容易出错的任务。
MapStruct 快速入门
SmartSi
05-26 331
MapStruct 是一个代码生成器，极大地简化了 Java Bean 之间映射的实现。通过简单的配置就能快速实现字段映射，非常快速，安全，简单。
【高效开发工具系列】MapStruct入门使用
热门推荐
檀越的博客
11-27 1万+
MapStruct 是一个 Java 注解处理器框架，用于简化 Java Bean 之间的映射。它通过生成映射代码来消除手动编写映射代码的繁琐工作，从而提高开发效率。创建一个带有@Mapper注解的接口，定义映射方法。@MapperMapStruct、Apache BeanUtils 以及 Spring BeanUtils 都是用于 Java Bean 之间属性复制的工具，但它们有一些区别，包括实现方式、性能、功能等方面。MapStruct。
java map 结构体_MapStruct快速入门
weixin_42126399的博客
02-12 1503
MapStruct是一个代码生成器，简化了不同的Java Bean之间映射的处理，所以映射指的就是从一个实体变化成一个实体。例如我们在实际开发中，DAO层的实体和一些数据传输对象(DTO)，大部分属性都是相同的，只有少部分的不同，通过mapStruct，可以让不同实体之间的转换变的简单。我们只需要按照约定的方式进行配置即可。MapStruct是一个可以处理注解的Java编译器插件，可以在命令行中使...
MapStruct从入门到出门（二）
printf_scnaf的博客
06-15 533
在平常的对象映射中，总会有很多类型不完全一致的情况，例如转，转或者两个自定义对象之间的转换等。在中定义了一些类型的自动类型转换或者说是隐形类型转换。例如在上节中提到的基本数据类型和其包装类型之间的转换，和数字类型的转换，和时间类型的转换等。在注解中还可以自定义转换格式。例如数字类型转类型，使用属性。 使用属性本质上就是使用来实现转换的。下面是生成的方法代码 在注解中也有属性，效果跟上面是一样的。 dateFormat属性 时间类型字段例如，，等转类型，可以使用指定转换格式。 如果是类型和互相转换就是使用类
MapStruct快速入门
jar壳虫的博文
09-01 502
MapStruct快速入门 前言 随着软件架构分层越来越多，那么各个层次之间的数据模型就要面临着相互转换的问题，典型的就是我们可以在代码中见到各种O，如DO、DTO、VO等。 如在数据存储层，我们使用DO来抽象一个业务实体；在业务逻辑层，我们使用DTO来表示数据传输对象；到了展示层，我们又把对象封装成VO来与前端进行交互。 先来看一张图 想必大家伙原来都写过类似格式的代码，额···看着就不说了，冗长而繁琐，于是MapStruct这一类框架应运而生 包括： Spring BeanUtils Cglib
mapstruct.zip
06-03
相对于springBeanUtils更加高效的对象复制方法mapstruct
MapStruct-简化不同类型bean之间映射的代码生成器
08-07
MapStruct - 简化不同类型bean之间映射的代码生成器，基于一个约定优于配置的方式。
MapStruct 教程
里查叔叔
03-03 2022
MapStruct 支持装饰器模式，允许你在不修改生成的 Mapper 实现的情况下增强 Mapper 的功能。通过定义一个实现了 Mapper 接口的类，并在该类中添加额外的映射逻辑，你可以扩展 Mapper 的行为。如果需要自定义嵌套对象或集合的映射行为，我们可以在 Mapper 接口中定义相应的方法，并使用。这个参数代表了被装饰的 Mapper 实现，我们可以在装饰器类中调用它的方法来执行基本的映射操作，并添加自定义的逻辑。当然，你也可以通过依赖注入的方式将 Mapper 注入到你的组件中。
MapStruct
高精尖发展
10-17 300
之前写的文章现在都看不上了，为了提高点博客的质量还是写一点东西吧 先说一下： 注解处理器 编译时自动运行注解处理器，扫描 编译 和处理注解，可自定义；以java代码或字节码作为输入，生成文件(java代码)，通过反射调用新生成的文件中的类或方法，jvm编译 继承abstractProcessor，重写方法： init(ProcessingEnvironment processingEnv...
mapstruct 总会报找不到
09-01
总结起来，如果你在使用MapStruct时遇到找不到映射方法的问题，你可以尝试让MapStruct自动生成映射方法。此外，你可以查阅官方文档以获得更多关于映射引用对象以及在Spring Boot中配置MapStruct的信息。...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值