MapStruct 使用指南

已于 2022-11-02 16:33:37 修改
阅读量487 收藏
点赞数
文章标签： java
于 2022-10-31 10:48:58 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_34160623/article/details/127610682
版权

Spring的BeanUtils.copyProperties()与MapStruct 都是浅拷贝，BeanUtils.copyProperties()底层使用的是反射拷贝，而MapStruct底层方法是使用get(),set()拷贝，故速度比Spring的copy要快上不少

与Spring.BeanUtils.copy(source,target)对比结果图：

拷贝对象：TradeOrder 10 - 20 个有值字段进行拷贝

从图上来看，100000次拷贝速度，set > mapStruct > BeanCopier.copy > BeanUtils.copyProperties

使用步骤

1、引入依赖

<dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct</artifactId>
            <version>1.5.3.Final</version>
        </dependency>
        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct-processor</artifactId>
            <version>1.5.3.Final</version>
        </dependency>

⚠️：以下所有Mapper相关，都是MapStruct 包下的类（易与mybatis的Mapper混淆），便于区分可以在声明接口以其他标识作为后缀

2、调用方式

  2.1  Mapper工厂：声明一个接口，接口上加上@Mapper 注解 ,Mapper实例可以通过mapStruct 包下的Mappers类来获取，调用getMapper()方法

声明：

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

@Mapper
public interface MapStructMapper {
    MapStructMapper INSTANCE = Mappers.getMapper(MapStructMapper.class);


    TradeOrder convert(TradeOrder tradeOrder);

    Test2 convert(Test1 test1);

    TestDO convert(TestDO testDO);
}

    2.2 Spring 注入：需要在声明的拷贝接口上的注解加上componentModel = "spring"的参数（@Mapper(componentModel = "spring")），即可注册为Spring Bean对象，使用的时候注入使用即可

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

@Mapper(componentModel = "spring")
public interface MapStructMapper {
    MapStructMapper INSTANCE = Mappers.getMapper(MapStructMapper.class);


    TradeOrder convert(TradeOrder tradeOrder);

    Test2 convert(Test1 test1);

    TestDO convert(TestDO testDO);
}

3、基本原理：被@Mapper声明的接口，在编译期会生成impl文件，该文件的内容为声明方法的拷贝，内部都是使用get()/set()方法实现

        例：声明方法TradeOredr copyTradeOrderSelf(TradeOrder tradeOrder);

入参就是拷贝对象（等效于BeanUtils.copyProperties中 source），返回参数为拷贝后对象（等效于BeanUtils.copyProperties中 target）

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//

package com.xcode.server.common.mapstruct;

import com.xcode.server.common.base.TestDO;
import com.xcode.server.common.base.TradeOrder;
import com.xcode.server.entity.ProductDO;
import com.xcode.server.entity.Test1;
import com.xcode.server.entity.Test2;
import java.util.ArrayList;
import java.util.List;

public class MapStructMapperImpl implements MapStructMapper {
    public MapStructMapperImpl() {
    }

    public TradeOrder convert(TradeOrder tradeOrder) {
        if (tradeOrder == null) {
            return null;
        } else {
            TradeOrder tradeOrder1 = new TradeOrder();
            tradeOrder1.setId(tradeOrder.getId());
            tradeOrder1.setTradeId(tradeOrder.getTradeId());
            tradeOrder1.setSourceTradeId(tradeOrder.getSourceTradeId());
            tradeOrder1.setTradeNo(tradeOrder.getTradeNo());
            tradeOrder1.setTradeFrom(tradeOrder.getTradeFrom());
            tradeOrder1.setTradeStatus(tradeOrder.getTradeStatus());
            tradeOrder1.setProcessStatus(tradeOrder.getProcessStatus());
            tradeOrder1.setTradeTime(tradeOrder.getTradeTime());
            tradeOrder1.setPayTime(tradeOrder.getPayTime());
            tradeOrder1.setAuditTime(tradeOrder.getAuditTime());
            tradeOrder1.setReviewTime(tradeOrder.getReviewTime());
            tradeOrder1.setNotifyPickTime(tradeOrder.getNotifyPickTime());
            tradeOrder1.setConsignTime(tradeOrder.getConsignTime());
            tradeOrder1.setConfirmTime(tradeOrder.getConfirmTime());
            tradeOrder1.setOrderNo(tradeOrder.getOrderNo());
            tradeOrder1.setShopId(tradeOrder.getShopId());
            tradeOrder1.setShopName(tradeOrder.getShopName());
            tradeOrder1.setCompanyId(tradeOrder.getCompanyId());
            tradeOrder1.setCompanyName(tradeOrder.getCompanyName());
            tradeOrder1.setDepartId(tradeOrder.getDepartId());
            tradeOrder1.setDepartName(tradeOrder.getDepartName());
            tradeOrder1.setWarehouseId(tradeOrder.getWarehouseId());
            tradeOrder1.setWarehouseName(tradeOrder.getWarehouseName());
            tradeOrder1.setLogisticId(tradeOrder.getLogisticId());
            tradeOrder1.setLogisticName(tradeOrder.getLogisticName());
            tradeOrder1.setLogisticType(tradeOrder.getLogisticType());
            tradeOrder1.setMainPostid(tradeOrder.getMainPostid());
            tradeOrder1.setTradeType(tradeOrder.getTradeType());
            tradeOrder1.setTotalFee(tradeOrder.getTotalFee());
            tradeOrder1.setTaxFee(tradeOrder.getTaxFee());
            tradeOrder1.setReceivedPostFee(tradeOrder.getReceivedPostFee());
            tradeOrder1.setDiscountFee(tradeOrder.getDiscountFee());
            tradeOrder1.setPayment(tradeOrder.getPayment());
            tradeOrder1.setCouponFee(tradeOrder.getCouponFee());
            tradeOrder1.setReceivedTotal(tradeOrder.getReceivedTotal());
            tradeOrder1.setPostFee(tradeOrder.getPostFee());
            tradeOrder1.setOtherFee(tradeOrder.getOtherFee());
            tradeOrder1.setIsMultiChargeType(tradeOrder.getIsMultiChargeType());
            tradeOrder1.setChargeType(tradeOrder.getChargeType());
            tradeOrder1.setChargeCurrency(tradeOrder.getChargeCurrency());
            tradeOrder1.setChargeAccount(tradeOrder.getChargeAccount());
            tradeOrder1.setAccountName(tradeOrder.getAccountName());
            tradeOrder1.setPayType(tradeOrder.getPayType());
            tradeOrder1.setPayAccount(tradeOrder.getPayAccount());
            tradeOrder1.setPayNo(tradeOrder.getPayNo());
            tradeOrder1.setSellerMemo(tradeOrder.getSellerMemo());
            tradeOrder1.setBuyerMemo(tradeOrder.getBuyerMemo());
            tradeOrder1.setAppendMemo(tradeOrder.getAppendMemo());
            tradeOrder1.setRegister(tradeOrder.getRegister());
            tradeOrder1.setRegisterId(tradeOrder.getRegisterId());
            tradeOrder1.setSellerId(tradeOrder.getSellerId());
            tradeOrder1.setSeller(tradeOrder.getSeller());
            tradeOrder1.setAuditorId(tradeOrder.getAuditorId());
            tradeOrder1.setAuditor(tradeOrder.getAuditor());
            tradeOrder1.setReviewerId(tradeOrder.getReviewerId());
            tradeOrder1.setReviewer(tradeOrder.getReviewer());
            tradeOrder1.setEstimateWeight(tradeOrder.getEstimateWeight());
            tradeOrder1.setPackageWeight(tradeOrder.getPackageWeight());
            tradeOrder1.setTradeCount(tradeOrder.getTradeCount());
            tradeOrder1.setGoodsTypeCount(tradeOrder.getGoodsTypeCount());
            tradeOrder1.setIsDeliveryBatch(tradeOrder.getIsDeliveryBatch());
            tradeOrder1.setIsFreeze(tradeOrder.getIsFreeze());
            tradeOrder1.setFreezeReason(tradeOrder.getFreezeReason());
            tradeOrder1.setIsAbnormal(tradeOrder.getIsAbnormal());
            tradeOrder1.setAbnormalDescription(tradeOrder.getAbnormalDescription());
            tradeOrder1.setGoodslist(tradeOrder.getGoodslist());
            tradeOrder1.setPrice(tradeOrder.getPrice());
            tradeOrder1.setIsDelete(tradeOrder.getIsDelete());
            tradeOrder1.setSettleStatus(tradeOrder.getSettleStatus());
            tradeOrder1.setGmtCreate(tradeOrder.getGmtCreate());
            tradeOrder1.setGmtModified(tradeOrder.getGmtModified());
            tradeOrder1.setStockoutNo(tradeOrder.getStockoutNo());
            tradeOrder1.setFlagIds(tradeOrder.getFlagIds());
            tradeOrder1.setSysFlagIds(tradeOrder.getSysFlagIds());
            tradeOrder1.setLastShipTime(tradeOrder.getLastShipTime());
            tradeOrder1.setPayStatus(tradeOrder.getPayStatus());
            tradeOrder1.setChargeCurrencyCode(tradeOrder.getChargeCurrencyCode());
            tradeOrder1.setChargeExchangeRate(tradeOrder.getChargeExchangeRate());
            tradeOrder1.setGrossProfit(tradeOrder.getGrossProfit());
            tradeOrder1.setEstimateVolume(tradeOrder.getEstimateVolume());
            tradeOrder1.setCancelReason(tradeOrder.getCancelReason());
            tradeOrder1.setCommision(tradeOrder.getCommision());
            tradeOrder1.setOnlineTradeNo(tradeOrder.getOnlineTradeNo());
            tradeOrder1.setPayDueDate(tradeOrder.getPayDueDate());
            tradeOrder1.setLocalExchangeRate(tradeOrder.getLocalExchangeRate());
            tradeOrder1.setLocalCurrencyCode(tradeOrder.getLocalCurrencyCode());
            tradeOrder1.setArriveTime(tradeOrder.getArriveTime());
            tradeOrder1.setIsManualCompleteDelivery(tradeOrder.getIsManualCompleteDelivery());
            tradeOrder1.setJmallAccountName(tradeOrder.getJmallAccountName());
            tradeOrder1.setCustomerPayment(tradeOrder.getCustomerPayment());
            tradeOrder1.setCustomerDiscountFee(tradeOrder.getCustomerDiscountFee());
            tradeOrder1.setCustomerPostFee(tradeOrder.getCustomerPostFee());
            tradeOrder1.setCustomerTotalFee(tradeOrder.getCustomerTotalFee());
            tradeOrder1.setLogisticStatus(tradeOrder.getLogisticStatus());
            tradeOrder1.setIsUploadMart(tradeOrder.getIsUploadMart());
            tradeOrder1.setExpectReachTime(tradeOrder.getExpectReachTime());
            tradeOrder1.setDistributeLimitation(tradeOrder.getDistributeLimitation());
            tradeOrder1.setCustomerPayNo(tradeOrder.getCustomerPayNo());
            tradeOrder1.setCustomerTaxFee(tradeOrder.getCustomerTaxFee());
            tradeOrder1.setCustomerShopId(tradeOrder.getCustomerShopId());
            tradeOrder1.setInsuredValue(tradeOrder.getInsuredValue());
            tradeOrder1.setDistributionStationId(tradeOrder.getDistributionStationId());
            tradeOrder1.setDistributionStation(tradeOrder.getDistributionStation());
            tradeOrder1.setPickupTime(tradeOrder.getPickupTime());
            tradeOrder1.setPickupTimeId(tradeOrder.getPickupTimeId());
            tradeOrder1.setMerchandiserId(tradeOrder.getMerchandiserId());
            tradeOrder1.setMerchandiser(tradeOrder.getMerchandiser());
            tradeOrder1.setSourceTradeType(tradeOrder.getSourceTradeType());
            tradeOrder1.setApiType(tradeOrder.getApiType());
            tradeOrder1.setSalesId(tradeOrder.getSalesId());
            tradeOrder1.setSalesName(tradeOrder.getSalesName());
            tradeOrder1.setPickUpTime(tradeOrder.getPickUpTime());
            tradeOrder1.setSigningTime(tradeOrder.getSigningTime());
            tradeOrder1.setWarehouseFee(tradeOrder.getWarehouseFee());
            tradeOrder1.setCompleteTime(tradeOrder.getCompleteTime());
            tradeOrder1.setMemberId(tradeOrder.getMemberId());
            tradeOrder1.setMemberName(tradeOrder.getMemberName());
            tradeOrder1.setInTransitTime(tradeOrder.getInTransitTime());
            tradeOrder1.setDeliveryingTime(tradeOrder.getDeliveryingTime());
            tradeOrder1.setTestDO(this.convert(tradeOrder.getTestDO()));
            return tradeOrder1;
        }
    }

    public Test2 convert(Test1 test1) {
        if (test1 == null) {
            return null;
        } else {
            Test2 test2 = new Test2();
            test2.setAsda(test1.getAsda());
            if (test1.getTrueStr() != null) {
                test2.setTrueStr(Boolean.parseBoolean(test1.getTrueStr()));
            }

            test2.setAaa(test1.isAaa());
            test2.setBbb(test1.getBbb());
            return test2;
        }
    }

    public TestDO convert(TestDO testDO) {
        if (testDO == null) {
            return null;
        } else {
            TestDO testDO1 = new TestDO();
            testDO1.setYes(testDO.isYes());
            testDO1.setName(testDO.getName());
            testDO1.setStock(testDO.getStock());
            testDO1.setTt(testDO.getTt());
            testDO1.setProductDO(testDO.getProductDO());
            testDO1.setIsDelete(testDO.getIsDelete());
            testDO1.setTrue(testDO.isTrue());
            List<ProductDO> list = testDO.getProductDOs();
            if (list != null) {
                testDO1.setProductDOs(new ArrayList(list));
            }

            return testDO1;
        }
    }
}

如果需要映射不同字段的：需要在Mapper接口方法上使用@Mapping(source = "fieldName", target = "targetName")即可，例：

@Mapping(source = "field2", target = "field1")
TradeOrder convert(TradeOrder tradeOrder);

⚠️需注意点：存在类型从大转到小会丢失精度问题，需要在方法上添加参数 typeConversionPolicy = ReportingPolicy.ERROR 

@Mapper(componentModel = "spring", typeConversionPolicy = ReportingPolicy.ERROR)
public interface MapStructCopyComponent {
}

这样在编译期间如果发现该种字段，会编译报错，如果一定要两个拷贝的对象进行编译成功，可以在具体方法上添加注解，忽略对象拷贝

@Mappings(
        {@Mapping(target = "strLong", ignore = true),
         @Mapping(target = "stock", ignore = true)}
)
TestDto convert11(TestDO testDO);

String <-> Integer/Long/Byte 等，会进行隐式转换，

例“a123“ 转成 Integer/Long/Byte 会直接报错

目前没有什么方法进行避免，转换错会抛出异常

 

山海丶
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
MapStruct 1.2.0 参考指南
07-12
MapStruct是一个代码生成器的工具类，简化了不同的Java Bean之间映射的处理，所以映射指的就是从一个实体变化成一个实体。（带目录标签）
mapstruct-spi-protobuf:Mapstruct的Protobuf访问器命名策略
03-31
用于协议缓冲区的Mapstruct SPI实现 这种命名策略有助于在您的域类和protobuf类之间生成有效的映射代码。 无论和类支载。 注意：取决于mapstruct 1.4.0.CR1ProtobufAccessor命名策略扩展...
记录一次mapstruct使用的坑
lsc210的博客
07-12 634
mapstruct使用的坑
MapStruct详细使用指南
qq_35987776的博客
05-24 251
MapStruct使用指南_不知所言的博客-CSDN博客_mapstruct使用教程
MapStruct使用教程
Good Luck
04-25 338
Mapper。
MapStruct的使用方法
Clsrm的博客
09-02 1824
Mapping(target = “userNick1”, source = “userNick”)，此处的意思就是在转化的过程中，将UserPo的userNick属性值赋值给UserEntity的userNick1属性。对于属性名称不同的属性进行处理时，需要使用@Mapping，比如修改UserEntity中的userNick为userNick1，然后进行转换。看实现类，可以看到，Mapstruct帮我们做了处理，把po的userNick属性赋值给了entity的userNick1。
MapStruct使用
m0_37670016的博客
06-10 1399
MapStruct使用
Mapstruct 使用教程
digital2013的博客
04-16 639
MapStruct是一个Java注释处理器，用于生成类型安全的bean映射类。开发者要做的就是定义一个映射器接口，该接口声明任何必需的映射方法。在编译期间，MapStruct将生成此接口的实现。此实现使用简单的Java方法调用在源对象和目标对象之间进行映射，即没有反射或类似内容。与手动编写映射代码相比，MapStruct通过生成繁琐且易于出错的代码来节省时间。遵循配置方法上的约定，MapStruct使用合理的默认值，但在配置或实现特殊行为时不加理会。
mapstruct-1.3.1.Final-API文档-中英对照版.zip
05-03
赠送jar包：mapstruct-1.3.1.Final.jar； 赠送原API文档：mapstruct-1.3.1.Final-javadoc.jar； 赠送源代码：mapstruct-1.3.1.Final-sources.jar； 赠送Maven依赖信息文件：mapstruct-1.3.1.Final.pom； 包含翻译后...
Hive实战使用指南1
08-08
除了基本数据类型，Hive还引入了复杂数据类型，如数组（Array）、映射（Map）、结构体（Struct）和联合体（UnionType），以适应复杂的数据模型。 4.3 数据类型建议 选择合适的数据类型对于优化查询性能至关重要...
MapStruct使用指南
qq_28344049的博客
12-30 3764
MapStruct使用指南
MapStruct使用教程(内含代码实战)
代码大师麦克拉瑞的博客
10-24 1094
有时候，可能需要自定义映射行为，例如处理特定字段的转换或执行复杂逻辑。MapStruct 允许使用@Mapping注解来自定义映射。@Mapper在上面的示例中，我们使用@Mapping注解来指定目标属性和源属性之间的映射关系。这允许在不同属性名的情况下进行映射。MapStruct是一个Java注解处理器库，用于生成对象之间的映射代码。它的主要目的是简化对象之间的转换，特别是在DTO（Data Transfer Object）和领域对象之间进行映射的情况下非常有用。
Mapstruct的具体介绍与使用
热门推荐
欢迎来到 ABin-阿斌的博客：写一生代码，创一世佳话，筑一览芳华。
01-12 2万+
mapstruct是一种实体类映射框架，能够通过Java注解将一个实体类的属性安全地赋值给另一个实体类。有了mapstruct，只需要定义一个映射器接口，声明需要映射的方法，在编译过程中，mapstruct会自动生成该接口的实现类，实现将源对象映射到目标对象的效果。在实体类下面创建即可，方便查找。
使用mapstruct_何为MapStruct，该如何使用它？
weixin_42508905的博客
01-12 232
MapStruct是一款插件，专门用来处理 domin 实体类属性与 model 类属性之间的映射，大大的节省了我们做项目的时间。下面我将以SpringBoot为例说说怎么去使用这个插件：1：在SpringBoot中的pom.xml文件中引入mapstruct依赖包2：在application.yml文件中配置数据源3：数据库user表4: user实体类4.1 由于有几个属性其他实体...
mapStruct简单使用
x871752024的博客
02-02 118
MapStruct简单使用
Java实体映射工具MapStruct使用详解
guanshengg的博客
08-26 9310
通常在后端开发中经常不直接返回实体Entity类，经过处理转换返回前端，前端提交过来的对象也需要经过转换Entity实体才做存储；通常使用的BeanUtils.copyProperties方法也比较粗暴，不仅效率低下（使用反射）而且仅映射相同名的属性，多数情况下还需要手动编写对应的转换方法实现。 插件MapStruct以接口方法结合注解优雅实现对象转换，MapStruct生成器生成代码以更贴近原生的Setter、Getter方法处理属性映射更为高效...
比 BeanUtils 更快的实体映射工具 MapStruct 原理
1999的博客
09-05 1372
比 BeanUtils 更快的实体映射工具 MapStruct 原理
Mapstruct使用之问题
qq_45604746的博客
11-04 2779
Mapstruct使用之问题 今天第一次在项目中使用Mapstruct，一切正常，本地服务一切ok； 但是部署到tomcat中产生了问题：一直报错找不到org.mapstruct.factory.Mappers类，详见下图 根据错误是没有讲Mappers加载进容器导致的，查看源码发现Mappers.getMapper方法只是对你当前类进行了实例化，故换个思路 @Mapper注解已经将当前类注入了spring容器中，故直接注入api层进行调用 调用成功 ...
java mapstruct 使用
最新发布
12-16
以下是使用Java MapStruct的步骤： 1. 添加MapStruct依赖项到Maven或Gradle项目中。 2. 创建一个Java接口，该接口定义了要映射的源和目标bean之间的映射方法。 3. 在接口上使用@Mapper注释，指定MapStruct生成的...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值