关于java:干掉-BeanUtils试试这款-Bean-自动映射工具真心强大

8次阅读

共计 9382 个字符，预计需要花费 24 分钟才能阅读完成。

服务通过接口对外提供数据，或者服务之间进行数据交互，首先查询数据库并映射成数据对象（XxxDO）。

失常状况下，接口是不容许间接以数据库数据对象 XxxDO 模式对外提供数据的，而是要再封装成数据传输对象（XxxDTO）提供进来。

1）依据繁多设计准则，DO 只能对应数据实体对象，不能承当其余职责；

2）DO 可能蕴含表所有字段数据，不合乎接口的参数定义，数据如果过大会影响传输速度，也不合乎数据安全准则；

3）依据《阿里 Java 开发手册》分层畛域模型规约，不能一个对象走天下，须要定义成 POJO/DO/BO/DTO/VO/Query 等数据对象，残缺的定义能够参考阿里开发手册，关注公众号：Java 技术栈，在后盾回复：手册，能够获取最新高清完整版。

XxxDTO 可能蕴含 XxxDO 大部分数据，或者组合其余 DO 的局部数据，传统的做法有以下几种：

get/ set
结构器
BeanUtils 工具类
Builder 模式

我置信大部分人的做法都是这样的，尽管很间接，然而广泛真的很 Low，耦合性又强，还常常丢参数，或者搞错参数值，在这个开发场景，我集体感觉这些都不是最佳的形式。

这种开发场景又切实是太常见了，那有没有一种 Java bean 主动映射工具？

没错——正是 MapStruct！！

官网地址：

https://mapstruct.org/

开源地址：

https://github.com/mapstruct/…

Java bean mappings, the easy way!

以简略的形式进行 Java bean 映射。

MapStruct 是一个代码生成器，它和 Spring Boot、Maven 一样也是基于约定优于配置的理念，极大地简化了 Java bean 之间数据映射的实现。

MapStruct 的劣势：

1、MapStruct 应用简略的办法调用生成映射代码，因而 速度十分快；

2、类型平安，防止出错，只能映射互相映射的对象和属性，因而不会谬误将用户实体谬误地映射到订单 DTO；

3、只须要 JDK 1.8+，不必其余任何依赖，自蕴含所有代码；

4、易于调试；

5、易于了解；

反对的形式：

MapStruct 反对命令行编译，如：纯 javac 命令、Maven、Gradle、Ant 等等，也反对 Eclipse、IntelliJ IDEA 等 IDEs。

本文栈长基于 IntelliJ IDEA、Spring Boot、Maven 进行演示。

新增两个数据库 DO 类：

一个用户主类，一个用户扩大类。

/**
 * 微信公众号：Java 技术栈
 * @author 栈长
 */
@Data
public class UserDO {

    private String name;

    private int sex;

    private int age;

    private Date birthday;

    private String phone;

    private boolean married;

    private Date regDate;

    private Date loginDate;

    private String memo;

    private UserExtDO userExtDO;


}

/**
 * 微信公众号：Java 技术栈
 * @author 栈长
 */
@Data
public class UserExtDO {

    private String regSource;

    private String favorite;

    private String school;

    private int kids;

    private String memo;

}

新增一个数据传输 DTO 类：

用户展现类，蕴含用户主类、用户扩大类的局部数据。

/**
 * 微信公众号：Java 技术栈
 * @author 栈长
 */
@Data
public class UserShowDTO {

    private String name;

    private int sex;

    private boolean married;

    private String birthday;

    private String regDate;

    private String registerSource;

    private String favorite;

    private String memo;

}

重点来了，不要 get/set，不要 BeanUtils，怎么把两个用户对象的数据封装到 DTO 对象？

Spring Boot 根底这篇就不介绍了，系列基础教程和示例源码能够看这里：https://github.com/javastacks…

引入 MapStruct 依赖：

<dependencies>
    <dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>${org.mapstruct.version}</version>
    </dependency>
</dependencies>

Maven 插件相干配置：

MapStruct 和 Lombok 联合应用会有版本抵触问题，留神以下配置。

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
                <annotationProcessorPaths>
                    <path>
                        <groupId>org.mapstruct</groupId>
                        <artifactId>mapstruct-processor</artifactId>
                        <version>${org.mapstruct.version}</version>
                    </path>
                    <!-- 应用 Lombok 须要增加 -->
                    <path>
                        <groupId>org.projectlombok</groupId>
                        <artifactId>lombok</artifactId>
                        <version>${org.projectlombok.version}</version>
                    </path>
                    <!-- Lombok 1.18.16 及以上须要增加，不然报错 -->
                    <path>
                        <groupId>org.projectlombok</groupId>
                        <artifactId>lombok-mapstruct-binding</artifactId>
                        <version>${lombok-mapstruct-binding.version}</version>
                    </path>
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>

增加 MapStruct 映射：

/**
 * 微信公众号：Java 技术栈
 * @author 栈长
 */
@Mapper
public interface UserStruct {UserStruct INSTANCE = Mappers.getMapper(UserStruct.class);

    @Mappings({@Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd")
        @Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))")
        @Mapping(source = "userExtDO.regSource", target = "registerSource")
        @Mapping(source = "userExtDO.favorite", target = "favorite")
        @Mapping(target = "memo", ignore = true)
    })
    UserShowDTO toUserShowDTO(UserDO userDO);

    List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOs);

}

重点阐明：

1）增加一个 interface 接口，应用 MapStruct 的 @Mapper 注解润饰，这里取名 XxxStruct，是为了不和 MyBatis 的 Mapper 混同；

2）应用 Mappers 增加一个 INSTANCE 实例，也能够应用 Spring 注入，前面会讲到；

3）增加两个映射办法，返回单个对象、对象列表；

4）应用 @Mappings + @Mapping 组合映射，如果两个字段名雷同能够不必写，能够指定映射的日期格局、数字格局、表达式等，ignore 示意疏忽该字段映射；

5）List 办法的映射会调用单个办法映射，不必独自映射，前面看源码就晓得了；

另外，Java 8+ 以上版本不须要 @Mappings 注解，间接应用 @Mapping 注解就行了：

Java 8 批改之后：

/**
 * 微信公众号：Java 技术栈
 * @author 栈长
 */
@Mapper
public interface UserStruct {UserStruct INSTANCE = Mappers.getMapper(UserStruct.class);

    @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd")
    @Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))")
    @Mapping(source = "userExtDO.regSource", target = "registerSource")
    @Mapping(source = "userExtDO.favorite", target = "favorite")
    @Mapping(target = "memo", ignore = true)
    UserShowDTO toUserShowDTO(UserDO userDO);

    List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOs);

}

测试一下：

/**
 * 微信公众号：Java 技术栈
 * @author 栈长
 */
public class UserStructTest {

    @Test
    public void test1() {UserExtDO userExtDO = new UserExtDO();
        userExtDO.setRegSource("公众号：Java 技术栈");
        userExtDO.setFavorite("写代码");
        userExtDO.setSchool("社会大学");

        UserDO userDO = new UserDO();
        userDO.setName("栈长");
        userDO.setSex(1);
        userDO.setAge(18);
        userDO.setBirthday(new Date());
        userDO.setPhone("18888888888");
        userDO.setMarried(true);
        userDO.setRegDate(new Date());
        userDO.setMemo("666");
        userDO.setUserExtDO(userExtDO);

        UserShowDTO userShowDTO = UserStruct.INSTANCE.toUserShowDTO(userDO);
        System.out.println("===== 单个对象映射 =====");
        System.out.println(userShowDTO);

        List<UserDO> userDOs = new ArrayList<>();
        UserDO userDO2 = new UserDO();
        BeanUtils.copyProperties(userDO, userDO2);
        userDO2.setName("栈长 2");
        userDOs.add(userDO);
        userDOs.add(userDO2);
        List<UserShowDTO> userShowDTOs = UserStruct.INSTANCE.toUserShowDTOs(userDOs);
        System.out.println("===== 对象列表映射 =====");
        userShowDTOs.forEach(System.out::println);
    }
}

输入后果：

来看后果，数据转换后果胜利。

如上咱们晓得，通过一个注解润饰接口就能够搞定了，是什么原理呢？

来看编译后的目录：

原理就是在编译期间生成了一个该接口的实现类。

关上看下其源码：

public class UserStructImpl implements UserStruct {public UserStructImpl() {}    public UserShowDTO toUserShowDTO(UserDO userDO) {if (userDO == null) {return null;} else {UserShowDTO userShowDTO = new UserShowDTO();            if (userDO.getBirthday() != null) {userShowDTO.setBirthday((new SimpleDateFormat("yyyy-MM-dd")).format(userDO.getBirthday()));            }            userShowDTO.setRegisterSource(this.userDOUserExtDORegSource(userDO));            userShowDTO.setFavorite(this.userDOUserExtDOFavorite(userDO));            userShowDTO.setName(userDO.getName());            userShowDTO.setSex(userDO.getSex());            userShowDTO.setMarried(userDO.isMarried());            userShowDTO.setRegDate(DateFormatUtils.format(userDO.getRegDate(), "yyyy-MM-dd HH:mm:ss"));            return userShowDTO;        }    }    public List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOs) {if (userDOs == null) {return null;} else {List<UserShowDTO> list = new ArrayList(userDOs.size());            Iterator var3 = userDOs.iterator();            while(var3.hasNext()) {UserDO userDO = (UserDO)var3.next();                list.add(this.toUserShowDTO(userDO));            }            return list;        }    }    private String userDOUserExtDORegSource(UserDO userDO) {if (userDO == null) {return null;} else {UserExtDO userExtDO = userDO.getUserExtDO();            if (userExtDO == null) {return null;} else {String regSource = userExtDO.getRegSource();                return regSource == null ? null : regSource;            }        }    }    private String userDOUserExtDOFavorite(UserDO userDO) {if (userDO == null) {return null;} else {UserExtDO userExtDO = userDO.getUserExtDO();            if (userExtDO == null) {return null;} else {String favorite = userExtDO.getFavorite();                return favorite == null ? null : favorite;            }        }    }}

其实实现类就是调用了对象的 get/set 等其余惯例操作，而 List 就是循环调用的该对象的单个映射办法，这下就分明了吧！

下面的示例创立了一个 UserStruct 实例：

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

如 @Mapper 注解源码所示：

参数 componentModel 默认值是 default，也就是手动创立实例，也能够通过 Spring 注入。

Spring 修改版如下：

干掉了 INSTANCE，@Mapper 注解退出了 componentModel = “spring” 值。

/** * 微信公众号：Java 技术栈 * @author 栈长 */@Mapper(componentModel = "spring")public interface UserSpringStruct {@Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd")    @Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))")    @Mapping(source = "userExtDO.regSource", target = "registerSource")    @Mapping(source = "userExtDO.favorite", target = "favorite")    @Mapping(target = "memo", ignore = true)    UserShowDTO toUserShowDTO(UserDO userDO);    List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOS);}

测试一下：

本文用到了 Spring Boot，所以这里就要用到 Spring Boot 的单元测试办法。Spring Boot 单元测试不懂的能够关注公众号：Java 技术栈，在后盾回复：boot，系列教程都整顿好了。

/** * 微信公众号：Java 技术栈 * @author 栈长 */@RunWith(SpringRunner.class)@SpringBootTestpublic class UserSpringStructTest {@Autowired    private UserSpringStruct userSpringStruct;    @Test    public void test1() {UserExtDO userExtDO = new UserExtDO();        userExtDO.setRegSource("公众号：Java 技术栈");        userExtDO.setFavorite("写代码");        userExtDO.setSchool("社会大学");        UserDO userDO = new UserDO();        userDO.setName("栈长 Spring");        userDO.setSex(1);        userDO.setAge(18);        userDO.setBirthday(new Date());        userDO.setPhone("18888888888");        userDO.setMarried(true);        userDO.setRegDate(new Date());        userDO.setMemo("666");        userDO.setUserExtDO(userExtDO);        UserShowDTO userShowDTO = userSpringStruct.toUserShowDTO(userDO);        System.out.println("===== 单个对象映射 =====");        System.out.println(userShowDTO);        List<UserDO> userDOs = new ArrayList<>();        UserDO userDO2 = new UserDO();        BeanUtils.copyProperties(userDO, userDO2);        userDO2.setName("栈长 Spring2");        userDOs.add(userDO);        userDOs.add(userDO2);        List<UserShowDTO> userShowDTOs = userSpringStruct.toUserShowDTOs(userDOs);        System.out.println("===== 对象列表映射 =====");        userShowDTOs.forEach(System.out::println);    }}

如上所示，间接应用 @Autowired 注入就行，应用更不便。

输入后果：

没故障，稳如狗。

本文栈长只是介绍了 MapStruct 的简略用法，应用 MapStruct 能够使代码更优雅，还能防止出错，其实还有很多简单的、个性化用法，一篇难以写完，栈长前面有工夫会整理出来，陆续给大家分享。

感兴趣的也能够参考官网文档：

https://mapstruct.org/documen…

本文实战源代码完整版曾经上传：

https://github.com/javastacks…

欢送 Star 学习，前面 Spring Boot 示例都会在这下面提供！

好了，明天的分享就到这了，前面我还会陆续解读更多的好玩的 Java 技术，关注公众号 Java 技术栈第一工夫推送。另外，我也将 Spring Boot 系列支流面试题和参考答案都整顿好了，关注公众号 Java 技术栈回复关键字 “ 面试 ” 进行刷题。

最初，感觉我的文章对你用播种的话，动动小手，给个在看、转发，原创不易，栈长须要你的激励。

版权申明：本文系公众号 “Java 技术栈 ” 原创，原创实属不易，转载、援用本文内容请注明出处，禁止剽窃、洗稿，请自重，尊重大家的劳动成果和知识产权，剽窃必究。

近期热文举荐：

1.1,000+ 道 Java 面试题及答案整顿(2021 最新版)

2. 别在再满屏的 if/ else 了，试试策略模式，真香！！

3. 卧槽！Java 中的 xx ≠ null 是什么新语法？

4.Spring Boot 2.5 重磅公布，光明模式太炸了！

5.《Java 开发手册（嵩山版）》最新公布，速速下载！

感觉不错，别忘了顺手点赞 + 转发哦！

正文完

java

发表至： java

2021-09-06

0

关于java:LeetCode078子集

关于java:JZ058对称的二叉树

final关键字的作用skycto-JEEditor

关于java:我所知道并发编程之理解死锁与重入锁

关于linux:Dutree-–-Linux上的命令行磁盘使用情况分析工具

关于java:干掉-BeanUtils试试这款-Bean-自动映射工具真心强大

开发背景

你有没有遇到过这样的开发场景？

为什么不能间接提供 DO？

传统 DO -> DTO 做法

MapStruct 简介

MapStruct 实战

根本筹备

开始实战

什么原理？

Spring 注入法

总结

站内搜索