struct用法 java,MapStruct使用

最新推荐文章于 2024-08-19 22:50:39 发布
最新推荐文章于 2024-08-19 22:50:39 发布
阅读量535 收藏
点赞数
文章标签： struct用法 java

1.对象属性映射的苦恼

在日常开发中，常常涉及到接收Request对象，属性映射到内部交互的VO对象、甚至需要进一步映射到DTO对象，以完成相关的业务逻辑。

举个最近的栗子，接收的业务请求对象是这样：

@Data

@ApiModel(description = "配置信息请求体")

public class TrackingDataConfigRequest {

@NotBlank(message = "dimension不能为空，可选值：PROJECT、TENANT、BRAND、VEHICLE_SERIE、VEHICLE_MODEL、EVENT、VIN")

@ApiModelProperty(value = "dimension", required = true)

String dimension;

@ApiModelProperty(value = "brand", required = false)

String brand;

@ApiModelProperty(value = "vehicleSeries", required = false)

String vehicleSeries;

@ApiModelProperty(value = "vehicleModel", required = false)

String vehicleModel;

@ApiModelProperty(value = "eventId", required = false)

String eventId;

@ApiModelProperty(value = "vin", required = false)

String vin;

@ApiModelProperty(value = "attrs", required = false)

List attrs;

@ApiModelProperty(value = "switch", required = false)

String switchState;

@ApiModelProperty(value = "reportFrequency", required = false)

Integer reportFrequency;

@ApiModelProperty(value = "reportRecords", required = false)

Integer reportRecords;

@ApiModelProperty(value = "reportSize", required = false)

Integer reportSize;

}

请求体的非@NotBlank注解的字段为非必填(可能有值、也可以没有)。接口接收到请求参数后，需要转为如下内部交互VO结构：

public class TrackingDataConfigVo {

String projectId;

String tenantId;

String dimension;

String brand;

String vehicleSeries;

String vehicleModel;

String eventId;

String vin;

List attrs;

String switchState;

Integer reportFrequency;

Integer reportRecords;

Integer reportSize;

}

要实现这个映射有很多办法，比如：

最直接地，一个个请求体对象判断有值、设置到VO对象。更友好点， 针对VO对象提供Builder，实现链式属性赋值操作、最后build出对象

使用BeanUtils这样的工具类，比如org.springframework.beans.BeanUtils，还有Apache的org.apache.commons.beanutils.BeanUtilsBean。

痛点就不必赘述了，BeanUtils工具类的主要问题是只能针对映射对象、被映射对象同名同类型属性进行映射，但是实际开发场景还有很多属性名称不同、类型不同、属性默认值、属性需要按规则生成的场景，导致BeanUtils工具类失效。

2.MapStruct实现对象属性映射

就以文章开头提到的两个对象映射为例，大致需要如下操作。

2.1引入pom依赖

org.mapstruct

mapstruct-jdk8

${org.mapstruct.version}

org.mapstruct

mapstruct-processor

${org.mapstruct.version}

org.apache.maven.plugins

maven-compiler-plugin

1.8

1.8

org.mapstruct

mapstruct-processor

${org.mapstruct.version}

org.projectlombok

lombok

${lombook.version}

-Amapstruct.suppressGeneratorTimestamp=true

-Amapstruct.suppressGeneratorVersionInfoComment=true

mapstruct版本项目中使用的1.3.1.Final，最新的版本查了下应该是1.4.1.Final，没仔细看区别。

2.2 建立属性映射关系

需要新建一个接口，指明映射对象与被映射对象，如果有字段需要特殊的映射规则，可以在转换方法配置，比如目标映射属性与源属性名称不同、属性类型不同等等。

@Mapper(componentModel = "spring")

public interface GeneralBurrypointConfigConvertor {

/**

* 完成请求TrackingDataConfigRequest到TrackingDataConfigVo属性映射(projectId等参数无法映射)

*

* @param request

* @return

*/

@Mappings({

@Mapping(target = "projectId", defaultValue = ""),

@Mapping(target = "tenantId", defaultValue = "")})

TrackingDataConfigVo convertVo(TrackingDataConfigRequest request);

}

简单说明下：

componentModel = "spring"是因为使用Spring构建的项目，这里配置是指该接口生成的实现类上面会自动添加一个@Component注解，可以通过Spring的@Autowired方式进行注入.

由于请求的TrackingDataConfigRequest没有projectId、tenantId参数，所以映射的规则增加了这两个属性的默认值配置。

其它参数类型、属性都是一一对应，所以“约定大于配置”，就默认逐个属性都会映射。

2.3 编译生成实现类

这里补充说明下，mapstruct是在编译时期生成这个接口的实现类，所以不用有反射、性能这样的担忧。

生成的实现类如下：

@Generated(

value = "org.mapstruct.ap.MappingProcessor"

)

@Component

public class GeneralBurrypointConfigConvertorImpl implements GeneralBurrypointConfigConvertor {

@Override

public TrackingDataConfigVo convertVo(TrackingDataConfigRequest request) {

if ( request == null ) {

return null;

}

TrackingDataConfigVo trackingDataConfigVo = new TrackingDataConfigVo();

trackingDataConfigVo.setDimension( request.getDimension() );

trackingDataConfigVo.setBrand( request.getBrand() );

trackingDataConfigVo.setVehicleSeries( request.getVehicleSeries() );

trackingDataConfigVo.setVehicleModel( request.getVehicleModel() );

trackingDataConfigVo.setEventId( request.getEventId() );

trackingDataConfigVo.setVin( request.getVin() );

List list = request.getAttrs();

if ( list != null ) {

trackingDataConfigVo.setAttrs( new ArrayList( list ) );

}

trackingDataConfigVo.setSwitchState( request.getSwitchState() );

trackingDataConfigVo.setReportFrequency( request.getReportFrequency() );

trackingDataConfigVo.setReportRecords( request.getReportRecords() );

trackingDataConfigVo.setReportSize( request.getReportSize() );

return trackingDataConfigVo;

}

}

3. 其它场景展示

3.1 不同属性类型之间映射

比如源属性为String，由逗号分隔属性组成，类似：“a,b, c……”，目标对象属性为List类型。解决办法是实现一个工具类方法完成String转List，配置mapstruct规则即可：

@Mapper(componentModel = "spring",

imports = {ConfigConvertUtil.class},

unmappedTargetPolicy = ReportingPolicy.IGNORE)

public interface GeneralBurrypointConfigConvertor {

@Mappings({

@Mapping(target = "attrs", expression = "java( ConfigConvertUtil.convertStringToList( config.getAttrs() ) )")})

TrackingDataConfigVo convertVo(TdpGeneralBurrypointConfig config);

}

转换方法如下：

public static List convertStringToList(String attrs) {

if (!StringUtils.isEmpty(attrs)) {

return Arrays.asList(attrs.split(CommonConstants.COMMN_SIGN))

.stream().map(s -> (s.trim()))

.collect(Collectors.toList());

}

return new ArrayList();

}

注意需要在接口配置ConfigConvertUtil工具方法。

可以顺便看到实现类：

@Override

public TrackingDataConfigVo convertVo(TdpGeneralBurrypointConfig config) {

if ( config == null ) {

return null;

}

TrackingDataConfigVo trackingDataConfigVo = new TrackingDataConfigVo();

trackingDataConfigVo.setProjectId( config.getProjectId() );

trackingDataConfigVo.setTenantId( config.getTenantId() );

trackingDataConfigVo.setDimension( config.getDimension() );

trackingDataConfigVo.setBrand( config.getBrand() );

trackingDataConfigVo.setVehicleSeries( config.getVehicleSeries() );

trackingDataConfigVo.setVehicleModel( config.getVehicleModel() );

trackingDataConfigVo.setEventId( config.getEventId() );

trackingDataConfigVo.setVin( config.getVin() );

trackingDataConfigVo.setSwitchState( config.getSwitchState() );

trackingDataConfigVo.setReportFrequency( config.getReportFrequency() );

trackingDataConfigVo.setReportRecords( config.getReportRecords() );

trackingDataConfigVo.setReportSize( config.getReportSize() );

// 实现类使用了配置指定的工具类进行属性值处理

trackingDataConfigVo.setAttrs( ConfigConvertUtil.convertStringToList( config.getAttrs() ) );

return trackingDataConfigVo;

}

3.2 属性默认值生成

@Mapper(componentModel = "spring",

imports = {ConfigConvertUtil.class, DeleteFlagType.class, CommonConstants.class, Date.class},

unmappedTargetPolicy = ReportingPolicy.IGNORE)

public interface GeneralBurrypointConfigConvertor {

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

/**

* TrackingDataConfigVo转为数据库TdpGeneralBurrypointConfig，需要增加无法映射的一些默认值

*

* @param config

* @return

*/

@Mappings({

@Mapping(target = "configId", expression = "java( ConfigConvertUtil.generateConfigId( config ) )"),

@Mapping(target = "deleteFlag", expression = "java( DeleteFlagType.VALIDATE.getCode() )"),

@Mapping(target = "attrs", expression = "java( ConfigConvertUtil.convertListToString( config.getAttrs() ) )"),

@Mapping(target = "createBy", expression = "java( CommonConstants.DEFAULT_ADMINASTRATOR )"),

@Mapping(target = "updateBy", expression = "java( CommonConstants.DEFAULT_ADMINASTRATOR )"),

@Mapping(target = "createTime", expression = "java( new Date() )"),

@Mapping(target = "updateTime", expression = "java( new Date() )")})

TdpGeneralBurrypointConfig convertDto(TrackingDataConfigVo config);

// ……

}

注意这些属性的映射：

configId：使用工具类，对请求体提取固定参数值按规则生成，expression表示按照此规则生成。

deleteFlag：是利用了枚举类的赋值对象的默认值。

createBy、updateBy：使用的常量类的值赋值对象的默认值。

createTime、updateTime：使用的是Date实现设置赋值对象属性当前时间。

检查实现类可以进一步确认：

@Override

public TdpGeneralBurrypointConfig convertDto(TrackingDataConfigVo config) {

if ( config == null ) {

return null;

}

TdpGeneralBurrypointConfig tdpGeneralBurrypointConfig = new TdpGeneralBurrypointConfig();

tdpGeneralBurrypointConfig.setProjectId( config.getProjectId() );

tdpGeneralBurrypointConfig.setTenantId( config.getTenantId() );

tdpGeneralBurrypointConfig.setDimension( config.getDimension() );

tdpGeneralBurrypointConfig.setBrand( config.getBrand() );

tdpGeneralBurrypointConfig.setVehicleSeries( config.getVehicleSeries() );

tdpGeneralBurrypointConfig.setVehicleModel( config.getVehicleModel() );

tdpGeneralBurrypointConfig.setEventId( config.getEventId() );

tdpGeneralBurrypointConfig.setVin( config.getVin() );

tdpGeneralBurrypointConfig.setSwitchState( config.getSwitchState() );

tdpGeneralBurrypointConfig.setReportFrequency( config.getReportFrequency() );

tdpGeneralBurrypointConfig.setReportRecords( config.getReportRecords() );

tdpGeneralBurrypointConfig.setReportSize( config.getReportSize() );

// 配置的默认值生成规则

tdpGeneralBurrypointConfig.setDeleteFlag( DeleteFlagType.VALIDATE.getCode() );

tdpGeneralBurrypointConfig.setCreateBy( CommonConstants.DEFAULT_ADMINASTRATOR );

tdpGeneralBurrypointConfig.setUpdateBy( CommonConstants.DEFAULT_ADMINASTRATOR );

tdpGeneralBurrypointConfig.setCreateTime( new Date() );

tdpGeneralBurrypointConfig.setConfigId( ConfigConvertUtil.generateConfigId( config ) );

tdpGeneralBurrypointConfig.setUpdateTime( new Date() );

tdpGeneralBurrypointConfig.setAttrs( ConfigConvertUtil.convertListToString( config.getAttrs() ) );

return tdpGeneralBurrypointConfig;

}

4. 遇到的问题

在使用过程中，由于指定了MyBatis的扫描范围为整个项目的包，导致误把MapStruct的@Mapper注解也纳入扫描范围，找不到数据库操作实现。所以，教训是配置MyBatis的扫描包范围时，一定避开MapStruct的包范围，比如指定最小化到dao层：@MapperScan("com.fawvw.ms.tdp.data.config.dao")

林葭音
关注
【微服务】springboot整合对象映射工具MapStruct使用详解
congge
08-25 4501
springboot 整合 MapStruct 使用详解
Clojure语言五:StructMap
Dean Chen的专栏
12-27 3230
参考官方文档：http://clojure.org/data_structures很多自定义的map拥有部分或者全部相同的keys，将这些相同的keys抽出来定义成StructMap类型，可以提升性能，节省内存。下面这篇中文文档写的非常好，推荐，我的例子来自于它：http://xumingming.sinaapp.com/302/clojure-functional-programming-for
Java 结构体之 JavaStruct 使用教程<一> 初识 JavaStruct
SoldierJazz的专栏
07-20 1万+
Javastruct 是什么 简而言之，Javastruct 是一个第三方库，用于像处理 C 或者 C++ 结构体那样处理 java 对象。也即利用 Javastruct 可以在 java 上实现类似于结构体的功能和操作。 Javastruct 的用途 在 java 或者 Android 应用程序与一些嵌入式设备通讯或者C、C++ 应用程序通讯时，比如网络、无线、蓝牙、串口通讯等场景，由于实
java中MapStruct使用浅讲
最新发布
HGX-DJK
08-19 375
有时候，源对象与目标对象的属性名不同，或需要进行一些额外的转换逻辑，可以通过自定义映射实现。
Java 实体映射工具 MapStruct
点缀星空
03-30 319
参考
java 使用C中的struct
kemengli的专栏
07-01 7167
例3   使用JNA调用使用Struct的C函数 C语言开发 继续使用例2中的那个VSC++的dll项目。 增加一个结构和使用该结构的函数。 头文件增加如下：   #define MYLIBAPI  extern   "C"     __declspec( dllexport )  struct UserStruct{    long id;    wchar_t*  name;
java map的结构体,MapStruct的使用介绍
weixin_42157556的博客
03-13 642
MapStruct的介绍MapStruct 是一个属性映射工具，只需要定义一个 Mapper 接口，MapStruct 就会自动实现这个映射接口，避免了复杂繁琐的映射实现。在一个JavaWeb工程中会涉及到多种对象，po、vo、dto、entity、do、domain这些定义的对象运用在不同的场景模块中，这种对象与对象之间的互相转换，就需要有一个专门用来解决转换问题的工具。以前是通过反射的方法实现...
Java编码辅助工具Mapstruct用法详解
08-25
Java编码辅助工具Mapstruct用法详解 Mapstruct是一个Java编码辅助工具，主要用于简化Java Bean之间的转换工作。通过使用Mapstruct框架，可以简洁方便地完成Bean之间的转换工作，免去了手动编码setter/getter的烦恼...
mapstruct-idea:IntelliJ IDEA插件，可与MapStruct一起使用
05-02
MapStruct是一个Java用于为Java Bean类生成类型安全和高性能的映射器。 要了解有关MapStruct的更多信息，请查看存储库或 特征 代码完成 完成@Mapping注释中的target和source属性（嵌套属性也可以使用） @...
mapstruct-demo:该项目说明了如何使用mapstruct API自动执行Java映射
05-19
该项目说明了如何使用mapstruct API自动执行Java映射 什么是MapStruct MapStruct是一个代码生成器，它基于约定优于配置的方法极大地简化了Java bean类型之间映射的实现。 生成的映射代码使用简单的方法调用，因此...
MapStruct处理Java中实体与模型间不匹配属性转换的方法
08-26
"MapStruct处理Java中实体与模型间不匹配属性转换的方法" MapStruct是Java中一个常用的对象转换工具，能够帮助开发者快速实现实体与模型间的属性转换。今天我们来分享MapStruct处理Java中实体与模型间不匹配属性...
JavaStruct.jar
06-27
这是原来在Google code上的Java结构体类库——JavaStruct的jar包和使用文档，现在已经不好找了，特此放出来供大家使用，哈哈。
java mapstruct详解_Mapstruct源码解析- 框架实现原理
weixin_35125814的博客
02-24 1961
只有用过Mapstruct才知道它是有多么的好用与顺手。本篇主要讲述Mapstuct的实现原理，它是怎么去生成转换代码的过程，让大家对这个框架的实现原理有个比较透彻的了解。1. Java动态编译与JSR 269首先，我们先重温下java的编译过程：Java源代码-->编译器-->jvm可执行的Java字节码(即虚拟指令)-->jvm-->jvm中解释器-->机器可执行...
Java 结构体之 JavaStruct 使用教程<二> JavaStruct 用例分析
热门推荐
SoldierJazz的专栏
07-21 2万+
使用环境 前一篇在介绍 JavaStruct 类时指定了使用库使用环境为 Java 5 及以上，也即开发我们使用的 JDK 版本为1.5及以上就可以了。以下讲解的用例可以直接将 code 直接粘贴到 java 的 main 函数中执行就可以了，后面会给出测试用例和结果。 使用方法 JavaStruct 类用于打包和解包结构体，也即使用方法为用该类的 pack 与 unpack 方法将定义的
struct用法 java_MapStruct用法
weixin_30923011的博客
02-25 671
1 MapStruct配置MapStuct的使用非常简单，把对应的jar包引入即可。1.3.1.Finalorg.mapstructmapstruct${mapstruct.version}org.mapstructmapstruct-processor${mapstruct.version}2 原理&性能2.1 实现原理对象拷贝工具实现上一般分为2种：(1) 在运行时，通过反射调用set...
java structs_java深入探究12-框架之Structs
weixin_34169503的博客
02-20 677
注意每次修改配置文件后必须项目重启Structs2=structs1+xworkStruct2框架预先实现了一些功能：1.请求数据的封装；2.文件上传的功能3.对国际化功能的简化4.文件效验功能1.开发Structs框架的步骤：1)引入8大jar包commons-fileupload-1.2.2.jar 【文件上传相关包】commons-io-2.0.1.jarstruts2-core-2.3...
java 三大结构之Struct
github_36601823的博客
03-03 1万+
java的三大框架分别是struct，spring和Hiberate。这里我们先来看看struct。 目前，运用广泛的是struct2，及MVC框架。M是指model，V是指view，C是指controller。主要是使用一个名为FilterDispatcher的过滤器来处理客户端的请求。 其工作流程如下： 1、判断客户端是否以.action请求，如果不适，直接交由servlet引擎
beanutils工具类_你还在用 BeanUtils来做对象转换吗？快试试 MapStruct吧
weixin_39948111的博客
11-27 183
作者：阿进的写字台https://www.cnblogs.com/homejim/第一次看到 MapStruct 的时候， 我个人非常的开心。因为其跟我内心里面的想法不谋而合。1 MapStruct 是什么？1.1 JavaBean 的困扰对于代码中 JavaBean之间的转换， 一直是困扰我很久的事情。在开发的时候我看到业务代码之间有很多的 JavaBean 之间的相互转化， 非常的影...
MapStruct学习笔记
vtnews的专栏
06-14 9243
MapStruct版本号是1.2.0.Final http://mapstruct.org/documentation/stable/reference/html/ 项目配置 最小化的配置： ... plugins { ... id 'net.ltgt.apt' version '0.8' } dependencies { ... compile 'o...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值