官网地址：http://mapstruct.org/

MapStruct 是一个代码生成器，简化了不同的 Java Bean 之间映射的处理，所谓的映射指的就是从一个实体变化成一个实体。例如我们在实际开发中，DAO 层的实体(PO)和一些数据传输对象(DTO)，大部分属性都是相同的，只有少部分的不同，通过 mapStruct，可以让不同实体之间的转换变的简单。我们只需要按照约定的方式进行配置即可。

MapStruct 是一个可以处理注解的 Java 编译器插件，可以在命令行中使用，也可以在 IDE 中使用。MapStruct 有一些默认配置，但是也为用户提供了自己进行配置的途径。

下面进行 MapStruct 的使用。

2. 添加依赖

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

3. 创建模拟类

假设数据库中有 user 表(包含 id ，用户名，地址，角色这些字段)与 role 表（包含 id ，角色名，描述这些字段)。

假设前端查询 user 的时候只需要用到 userId 、 userName 、 userAddr 与 role 的 roleId 字段时，如果将整个 user 都输出到前端会多出许多没有用的属性。更通用的方式是需要用到的属性封装成一个类( DTO )，通过传输这个类的实例来完成数据传输。

User.java

public class  {
    private Long id;
    private String name;
    private String addr;
    private Role role;
}

Role.java

public class Role {
    private Long id;
    private String name;
    private String description;
}

UserRoleDto.java

public class UserRoleDto {
    private Long userId;
    private String userName;
    private String userAddr;
    private String roleName;
}

4. 编写映射类

新建一个 UserRoleMapper.java ，这个类用来定义 User.java 、 Role.java 和 UserRoleDto.java 之间属性对应规则。

@Mapper(componentModel = "spring")
public interface UserMapper {

    @Mappings({
            @Mapping(source = "id", target = "userId"),
            @Mapping(source = "name", target = "userName"),
            @Mapping(source = "addr", target = "userAddr"),
            @Mapping(source = "role.name", target = "roleName"),
    })
    UserRoleDto toUserRoleDto(User user);
}

MapStruct中的注解

@Mapper：注解在接口、类上，这样 MapStruct 才会去实现该接口
componentModel：该属性用于指定实现类的类型，有几个属性：
default：默认，不使用任何组建类型，可以通过Mappers.getMapper(Class) 方式获取实例对象

spring：在实现类上注解 @Component，可通过 @Autowired 方式注入

cdi: the generated mapper is an application-scoped CDI bean and can be retrieved via @Inject

jsr330：实现类上添加@javax.inject.Named 和@Singleton注解，可以通过 @Inject注解获取。

@Mappings：配置多个@Mapping

@Mapping：配置属性映射，若源对象属性与目标对象名字一致，会自动映射对应属性
source：源属性、target：目标属性

dateFormat：可将 String 到 Date 日期之间相互转换，通过 SimpleDateFormat，该值为 SimpleDateFormat 的日期格式

写完该映射类后，当启动 IDE 的时候 IDE 会帮我们编译，会自动在 target/classes 下生成对应的实现类，可以查看其实现的方法。

@Generated(
    value = "org.mapstruct.ap.MappingProcessor",
    date = "2019-07-17T21:00:35+0800",
    comments = "version: 1.2.0.Final, compiler: javac, environment: Java 1.8.0_191 (Oracle Corporation)"
)
@Component
public class UserMapperImpl implements UserMapper {

    @Override
    public UserRoleDto toUserRoleDto(User user) {
        if ( user == null ) {
            return null;
        }

        UserRoleDto userRoleDto = new UserRoleDto();

        String name = userRoleName( user );
        if ( name != null ) {
            userRoleDto.setRoleName( name );
        }
        userRoleDto.setUserAddr( user.getAddr() );
        userRoleDto.setUserName( user.getName() );
        userRoleDto.setUserId( user.getId() );

        return userRoleDto;
    }

    private String userRoleName(User user) {
        if ( user == null ) {
            return null;
        }
        Role role = user.getRole();
        if ( role == null ) {
            return null;
        }
        String name = role.getName();
        if ( name == null ) {
            return null;
        }
        return name;
    }
}

5. 测试

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootMapstructApplicationTests {
 大专栏  Java实体映射工具MapStruct的使用
    @Autowired
    UserMapper userMapper;

    User user;

    Role role;

    @Before
    public void before() {
        // 模拟数据库数据
        role = new Role(2L, "admin", "管理员哦");
        user = new User(1L, "sgh", "China", role);
    }

    @Test
    public void contextLoads() {
        System.out.println("----------------user---------------");
        System.out.println(user);
        UserRoleDto userRoleDto = userMapper.toUserRoleDto(user);
        System.out.println("----------------touserDto--------------");
        System.out.println(userRoleDto);
    }

}

运行结果

可以看到 user.role.name 字段成功映射到了 userRoleDto 的 roleName 字段上。

6. 使用实现类的实例进行转换

UserRoleMapper.java 类修改如下

@Mapper
public interface UserRoleMapper {

    // 获取该类自动生成的实现类的实例
    UserRoleMapper INSTANCE = Mappers.getMapper(UserRoleMapper.class);

    @Mappings({
            @Mapping(source = "id", target = "userId"),
            @Mapping(source = "name", target = "userName"),
            @Mapping(source = "addr", target = "userAddr"),
            @Mapping(source = "role.name", target = "roleName"),
    })
    UserRoleDto toUserRoleDto(User user);
}

Mapper 的 componentModel 属性使用默认的 default (不写即为 default)

测试类修改为

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootMapstructApplicationTests {
    User user;

    Role role;

    @Before
    public void before() {
        // 模拟数据库数据
        role = new Role(2L, "admin", "管理员哦");
        user = new User(1L, "sgh", "China", role);
    }

    @Test
    public void contextLoads() {
        System.out.println("----------------user---------------");
        System.out.println(user);
        UserRoleMapper INSTANCE = UserRoleMapper.INSTANCE;
        UserRoleDto userRoleDto = INSTANCE.toUserRoleDto(user);
        System.out.println("----------------touserDto--------------");
        System.out.println(userRoleDto);
    }

}

注意区别，因为映射类的 componentModel 不使用 spring , 因此不能通过 @Autowired 来自动注入，需要使用该类的实例来进行转换。

具体体现在以下两行代码中

UserRoleMapper INSTANCE = UserRoleMapper.INSTANCE;
UserRoleDto userRoleDto = INSTANCE.toUserRoleDto(user);

7. 多个参数

可以绑定多个对象的属性值到目标对象中

@Mapper(componentModel = "spring")
public interface UserRoleMapper {

    // 使用单一对象
    @Mappings({
            @Mapping(source = "id", target = "userId"),
            @Mapping(source = "name", target = "userName"),
            @Mapping(source = "addr", target = "userAddr"),
            @Mapping(source = "role.name", target = "roleName"),
    })
    UserRoleDto toUserRoleDto(User user);

    // 使用两个对象
    @Mappings({
            @Mapping(source = "user.id", target = "userId"),
            @Mapping(source = "user.name", target = "userName"),
            @Mapping(source = "user.addr", target = "userAddr"),
            @Mapping(source = "role.name", target = "roleName"),
    })
    UserRoleDto toUserRoleDto(User user, Role role);
}

测试类修改为

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

    @Autowired
    UserRoleMapper userRoleMapper;

    User user;

    Role role;

    @Before
    public void before() {
        // 模拟数据库数据
        role = new Role(2L, "admin", "管理员哦");
        user = new User(1L, "sgh", "China", role);
    }

    @Test
    public void contextLoads() {
        System.out.println("----------------user---------------");
        System.out.println(user);
        UserRoleDto userRoleDto = userRoleMapper.toUserRoleDto(user, role);
        System.out.println("----------------touserDto--------------");
        System.out.println(userRoleDto);
    }

}

这里使用传两个参数进行属性映射，结果一致

项目代码: https://github.com/ShangguanHong/SpringBootDemo/tree/master/springboot-mapstruct

8. 参考资料

MapStruct超级简单的学习笔记

Java实体映射工具MapStruct的使用的更多相关文章

推荐一个 Java 实体映射工具 MapStruct
声明: 1.DO(业务实体对象),DTO(数据传输对象). 2.我的代码中用到了 Lombok ,不了解的可以自行了解一下,了解的忽略这条就好. 在一个成熟的工程中,尤其是现在的分布式系统中,应用与应 ...
【工具库】Java实体映射工具MapStruct
一.什么是MapStruct? MapStruct是用于代码中JavaBean对象之间的转换,例如DO转换为DTO,DTO转换为VO,或Entity转换为VO等场景,虽然Spring库和 Apache ...
Java实体映射工具MapStruct使用详解
1.序通常在后端开发中经常不直接返回实体Entity类,经过处理转换返回前端,前端提交过来的对象也需要经过转换Entity实体才做存储:通常使用的BeanUtils.copyProperties方法 ...
在线数据库表(sql语句)生成java实体类工具
相信每个做java开发的读者,都接触过SQL建表语句,尤其是在项目开发初期,因为数据库是项目的基石. 在现代项目开发中,出现了许多ORM框架,通过简单的实体映射,即可实现与数据库的交互,然而我们最初设 ...
Mybatis自动生成实体类和实体映射工具
Mybatis Mysql生成实体类用到的Lib包: mybatis-generator-core-1.3.2.jarmysql-connector-java-5.1.30.jar 1. 创建一个文 ...
Dozer JAVA的POJO 映射工具
Dozerhttp://www.manongjc.com/article/50949.html JAVA的映射工具 BeanUtils dozer的使用方法https://blog.csdn.net/ ...
xml文档的解析并通过工具类实现java实体类的映射：XML工具-XmlUtil
若有疑问,可以联系我本人微信:Y1141100952 声明:本文章为原稿,转载必须说明本文章地址,否则一旦发现,必追究法律责任 1:本文章显示通过 XML工具-XmlUtil工具实现解析soap报文 ...
MapStruct 映射工具
# MapStruct 映射工具本篇主要讲解MapStruct 一款映射工具,只需简单的定义一个Mapper接口,在编译期间,MapStruct将生成此接口的实现,据说MapStruct性能最高是 ...
EF架构~AutoMapper对象映射工具简化了实体赋值的过程
回到目录 AutoMapper是一个.NET的对象映射工具,一般地,我们进行面向服务的开发时,都会涉及到DTO的概念,即数据传输对象,而为了减少系统的负载,一般我们不会把整个表的字段作为传输的数据,而 ...

随机推荐

Python笔记_第三篇_面向对象_1.面向对象的基本概念和作用域
1. 软件编程的实质: 软件编程就是将我们的思维转变成计算机能够识别语言的一个过程.重要的是思想,代码技术反而次要.因此思想也是最难的,突破固定的思想是关键 2. 什么是面向过程: * 自上而下顺序执 ...
BTree
hash.平衡二叉树.BTree.B+tree的区别 https://blog.csdn.net/qq_40673786/article/details/90082444 联合索引在B+树上的结构介绍 ...
[原]CreateFile中的dwShareMode
原总结 API 一直对CreateFile的参数dwDesiredAccess和dwShareMode有什么不同不是很清楚,今天重读 windows核心编程的时候终于豁然开朗了. 真是书读百遍,其 ...
VS2010无法调试页面问题
图片: VS2010报:未能将脚本调试器附加到计算机XXX上的进程iexplore.exe . 已附加了一个调试器”.启动调试失败. 解决:1.以管理员身份打开CMD; 2.运行:regsvr32.e ...
i2c驱动dht12的原理和步骤
一.步骤 1.首先匹配i2c的控制器设备和控制器驱动,会生成一个struct i2c_adapter对象, 2.根据i2c_board_info ,在 arch/arm/mach-sunxi/s ...
【转】高频使用的git清单
侵删作者: 阮一峰链接: http://www.ruanyifeng.com/blog/2015/12/git-cheat-sheet.html 我每天使用 Git ,但是很多命令记不住. 一般来 ...
$.proxy和$.extend
$.proxy用法详解参考:https://www.cnblogs.com/alice626/p/6004864.html jQuery中的$.proxy官方描述为: 描述:接受一个函数,然后返回一 ...
iOS 自定义UITabBar
推荐一篇非常好的集成各种UITabBar的三方库 <点击这里直取demo> 另外一篇根据runtime定制了一款可以出轨的UITarBar <Runtime实战之定制TabBarIt ...
HDU-1828 Picture（扫描线求矩形并的周长）
http://acm.hdu.edu.cn/showproblem.php?pid=1828 Time Limit: 6000/2000 MS (Java/Others) Memory Limi ...
SLAM——视觉里程计（一）feature
从现在开始下面两篇文章来介绍SLAM中的视觉里程计(Visual Odometry).这个是我们正式进入SLAM工程的第一步,而之前介绍的更多的是一些基础理论.视觉里程计完成的事情是视觉里程计VO的目 ...

Java实体映射工具MapStruct的使用