mapStruct笔记
背景
mapStruct 是一个方便对象转换的工具，类似的工具还有 Dozer, BeanUtils。
实现
mapStruct的核心是在编译期生成基于转换规则的 Impl 文件，运行时直接调用 Impl 文件中的函数。整个 mapStruct 分成三个部分：
自定义注解，指定转换的规则。例如 source, target 等。
freemarker 模板，用来生成 impl 文件。
基于
javax.annotation.processing的处理模块。
基本流程是
color: rgb(0, 0, 0);
font: normal normal 400 normal 14px / 25.2px Verdana, Arial, Helvetica, sans-serif;
}
具体解析
具体的解析逻辑是将解析注解内容转化为 Mapper model 对象，然后将 Mapper model 写入 freemarker 模板中。
处理框架
整个注解的解析是通过 java compile[1] 实现的，逻辑包含在MappingProcessor.process 函数中，并通过 MapperGenerationVisitor 进行解析。
@Override
public boolean process(
final Set<? extends TypeElement> annotations,
final RoundEnvironment roundEnvironment) {
// 遍历需要处理的注解
for ( TypeElement oneAnnotation : annotations ) {
<span class="hljs-comment">//Indicates that the annotation's type isn't on the class path of the compiled</span>
<span class="hljs-comment">//project. Let the compiler deal with that and print an appropriate error.</span>
<span class="hljs-keyword">if</span> ( oneAnnotation.getKind() != ElementKind.ANNOTATION_TYPE ) {
<span class="hljs-keyword">continue</span>;
}
// 遍历包含 Mapper 注解的 interface and class , 例如 org.mapstruct.ap.test.conversion.SourceTargetMapper
for ( Element oneAnnotatedElement : roundEnvironment.getElementsAnnotatedWith( oneAnnotation ) ) {
// MapperGenerationVisitor 解析每个Mapper 注解的内容 成为一个 Model
oneAnnotatedElement.accept( new MapperGenerationVisitor( processingEnv ), null );
}
}
<span class="hljs-keyword">return</span> ANNOTATIONS_CLAIMED_EXCLUSIVELY;
}
解析逻辑
MapperGenerationVisitor 负责解析注解为 Mapper model， 并写入 ftl 模板文件中。
MapperGenerationVisitor.retrieveModel 包含了具体的解析逻辑，将注解内容转化为 Mapper Model。
ModelWriter 负责将 Mapper Model 写入 ftl 模板中。
整个逻辑都是围绕 Mapper model 展开的， Mapper 包含如下内容：
private final String packageName; // 包的名称
<span class="hljs-keyword">private</span> <span class="hljs-keyword">final</span> String interfaceName; <span class="hljs-comment">// 接口名称</span>
<span class="hljs-keyword">private</span> <span class="hljs-keyword">final</span> String implementationName; <span class="hljs-comment">// 应用名称</span>
<span class="hljs-keyword">private</span> <span class="hljs-keyword">final</span> List<BeanMapping> beanMappings; <span class="hljs-comment">// 一系列的 mapping 信息, 每个 method 对应一个 BeanMapping</span>
每一个 BeanMapping 对应一个转换函数，它的格式如下：
private final Type sourceType; // 函数的输入参数类型
private final Type targetType; // 函数的结果参数类型
private final List<PropertyMapping> propertyMappings; // 转换函数的每个属性的信息
private final MappingMethod mappingMethod; // 映射的函数
private final MappingMethod reverseMappingMethod; // 翻转映射的函数
private final boolean isIterableMapping; // 是不是迭代
例如 SourceTargetMapper 接口：
@Mapper
public interface SourceTargetMapper {
<span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
<span class="hljs-meta">@Mappings</span>({
<span class="hljs-meta">@Mapping</span>(source = <span class="hljs-string">"qax"</span>, target = <span class="hljs-string">"baz"</span>),
<span class="hljs-meta">@Mapping</span>(source = <span class="hljs-string">"baz"</span>, target = <span class="hljs-string">"qax"</span>)
})
<span class="hljs-function">Target <span class="hljs-title">sourceToTarget</span><span class="hljs-params">(Source source)</span></span>;
<span class="hljs-function">Source <span class="hljs-title">targetToSource</span><span class="hljs-params">(Target target)</span></span>;
}
映射为 Mapper Model 为：
{
"beanMappings":[
{
"iterableMapping":false,
"mappingMethod":{
"name":"sourceToTarget",
"parameterName":"source"
},
"propertyMappings":[
{
"fromConversion":"target.getFoo().intValue()",
"sourceName":"foo",
"sourceType":{
"name":"int",
"primitive":true
},
"targetName":"foo",
"targetType":{
"name":"Long",
"packageName":"java.lang",
"primitive":false
},
"toConversion":"Long.valueOf( source.getFoo() )"
},
Object{...},
Object{...},
Object{...},
Object{...}
],
"reverseMappingMethod":{
"name":"targetToSource",
"parameterName":"target"
},
"sourceType":{
"name":"Source",
"packageName":"org.mapstruct.ap.test.conversion",
"primitive":false
},
"targetType":{
"name":"Target",
"packageName":"org.mapstruct.ap.test.conversion",
"primitive":false
}
}
],
"implementationName":"SourceTargetMapperImpl",
"interfaceName":"SourceTargetMapper",
"packageName":"org.mapstruct.ap.test.conversion"
}
写入模板
写入模板是使用 freemarker 进行编写的，最初写入逻辑很简单，直接使用 ModelWriter 进行写入。ftl 模板的部分内容如下：
package ${packageName};
import java.util.ArrayList;
import java.util.List;
public class ${implementationName} implements ${interfaceName} {
上面的 ${packageName}对应的就是 Mapper Model 中的 packageName。
参考
原文地址：https://www.cnblogs.com/SpeakSoftlyLove/p/9794661.html
mapStruct笔记的更多相关文章
- Java实体映射工具MapStruct的使用
官网地址:http://mapstruct.org/ MapStruct 是一个代码生成器,简化了不同的 Java Bean 之间映射的处理,所谓的映射指的就是从一个实体变化成一个实体.例如我们在实际 ...
- mapstruct 快速使用
mapstruct 快速使用 mapstruct 主要的作用则是用来复制对象字段使用,功能非常的强大.在没有使用 mapstruct 之前可能都在使用 BeanUtils ,但是 BeanUtils ...
- git-简单流程（学习笔记）
这是阅读廖雪峰的官方网站的笔记,用于自己以后回看 1.进入项目文件夹 初始化一个Git仓库,使用git init命令. 添加文件到Git仓库,分两步: 第一步,使用命令git add <file ...
- js学习笔记：webpack基础入门（一）
之前听说过webpack,今天想正式的接触一下,先跟着webpack的官方用户指南走: 在这里有: 如何安装webpack 如何使用webpack 如何使用loader 如何使用webpack的开发者 ...
- SQL Server技术内幕笔记合集
SQL Server技术内幕笔记合集 发这一篇文章主要是方便大家找到我的笔记入口,方便大家o(∩_∩)o Microsoft SQL Server 6.5 技术内幕 笔记http://www.cnbl ...
- PHP-自定义模板-学习笔记
1. 开始 这几天,看了李炎恢老师的<PHP第二季度视频>中的“章节7:创建TPL自定义模板”,做一个学习笔记,通过绘制架构图.UML类图和思维导图,来对加深理解. 2. 整体架构图 ...
- PHP-会员登录与注册例子解析-学习笔记
1.开始 最近开始学习李炎恢老师的<PHP第二季度视频>中的“章节5:使用OOP注册会员”,做一个学习笔记,通过绘制基本页面流程和UML类图,来对加深理解. 2.基本页面流程 3.通过UM ...
- NET Core-学习笔记（三）
这里将要和大家分享的是学习总结第三篇:首先感慨一下这周跟随netcore官网学习是遇到的一些问题: a.官网的英文版教程使用的部分nuget包和我当时安装的最新包版本不一致,所以没法按照教材上给出的列 ...
- springMVC学习笔记--知识点总结1
以下是学习springmvc框架时的笔记整理: 结果跳转方式 1.设置ModelAndView,根据view的名称,和视图渲染器跳转到指定的页面. 比如jsp的视图渲染器是如下配置的: <!-- ...
随机推荐
- AJPFX总结java开发常用类（包装，数字处理集合等）（二）
二:进军集合类 集合其实就是存放对象的容器,专业点说就是集合是用来存储和管理其他对象的对象,即对象的容器.集合可以扩容,长度可变,可以存储多种类型的数据,而数组长度不可变,只能存储单一类型的元素 用一 ...
- Intent实现界面跳转、程序跳转
一个程序往往由多个界面组成,界面之间的跳转,实质是Activity之间的跳转. 从当前程序跳转到其它程序,实质是启动了目标程序的入口Activity. Intent被称为意图,常用于组件之间的交互,可 ...
- shutil模块详解2
1.shutil.make_archive() 实际上是调用了两个模块来实现压缩打包的功能. zipfile和tarfile两个模块,shutil的两个封装的模块. zip是压缩文件,文件内存会变小, ...
- 洛谷P1251 餐巾计划问题(最小费用最大流)
题意 一家餐厅,第$i$天需要$r_i$块餐巾,每天获取餐巾有三种途径 1.以$p$的费用买 2.以$f$的费用送到快洗部,并在$m$天后取出 3.以$s$的费用送到慢洗部,并在$n$天后取出 问满足 ...
- uva1336 Fixing the Great Wall
用到了kase避免memset超时 #include<cstdio> #include<cstring> #include<cmath> #include<a ...
- 在Vue中遇到的各种坑 及性能提升
Vue: (1) 没有再模板里引用data数据,会不会引起update.beforeUpdate生命周期函数的执行? 不会 (2)组件改成异步 (3)v-once (4)如果不用template ...
- QT_仅仅直接在构造函数中创建对象的不可行的原因
#include "mainwidget.h" #include <QApplication> int main(int argc, char *argv[]) { Q ...
- centOS出现 -bash: vim: command not found
问题描述 用centos 的主机的時候, 用 vim 时出现 -bash: vim: command not found. 只能使用 vi. 那么如何安裝 vim 呢? 解决步骤 1.查看是否安装 输 ...
- Spring boot 项目打成war包并在idea中运行
1. 修改pom文件原来是jar改成<packaging>war</packaging> 2. 在pom文件中添加移除内置tomcat并且添加添加servlet-api的依赖. ...
- 【转载】Shell 基础 -- 总结几种括号、引号的用法
原作者:tongye 原文链接:https://www.cnblogs.com/tongye/p/10646211.html 以下为原文: Shell 脚本中经常需要用到一些括号.引号表达式,功能各不 ...