【JS】Java对象属性复制组件-Mapstruct项目改造指南

下面给大家介绍下Java对象属性复制组件（MapStruct），以及项目中引入遇到的坑。

  1. 问题背景

日常编程中，经常会碰到对象属性复制的场景，就比如下面这样一个常见的三层MVC架构。

【JS】Java对象属性复制组件-Mapstruct项目改造指南

前端请求通过VO对象接收，并通过DTO对象进行流转，最后转换成DO对象与数据库DAO层进行交互，反之亦然。

当业务简单的时候，可以通过手动编码getter/setter函数来复制对象属性。但是当业务变的复杂，对象属性变得很多，那么手写复制属性代码不仅十分繁琐，非常耗时间，并且还可能容易出错。

为了解决这个痛点，在项目初期，小辉项目的解决方法是随手写的转换工具函数：根据变量名进行反射，对基础类型和枚举的变量进行赋值。

总结下目前该工具函数的优缺点：

优点：

  1. 开发效率高，随时想要转换的时候，传入源对象以及指定class，调用下函数即可。

缺点：

  1. 项目中大量的反射会严重影响代码执行效率

  2. 由于使用了反射，所以成员变量的使用被追踪就很麻烦

  3. 转换失败只有在运行中报错才会发现

  4. 对于嵌套对象字段的情况无能为力

  5. 只能对基础类型进行复制

  6. 对字段名不一致的属性无法赋值

  7. 开源组件选择

那如果想要更强大的功能，有哪些开源组件可以选择呢？

下面小辉收集并盘点下相关开源组件的特点。

1. Apache BeanUtils

  1. 底层原理运用反射。

  2. 嵌套对象字段，将会与源对象使用同一对象，即使用浅拷贝。

  3. 字段名不一致的属性无法被复制。

  4. 类型不一致的字段，将会进行默认类型转化。

2. Spring BeanUtils：

  1. 底层原理同样运用反射，但相比Apache BeanUtils减少了反射校验，同时增加了缓存，所以提升了转换速度。

  2. 嵌套对象字段，将会与源对象使用同一对象，即使用浅拷贝。

  3. 字段名不一致，属性无法复制。

  4. 类型不一致的字段，将会进行默认类型转化。

3. Cglib BeanCopier

  1. 字节码技术动态生成一个代理类，代理类实现get和set方法。生成代理类过程存在一定开销，但是一旦生成，我们可以缓存起来重复使用。相比前两个更好用。

  2. 嵌套对象字段，将会与源对象使用同一对象，即使用浅拷贝。

  3. 字段名不一致，属性无法复制。

  4. 类型不一致的字段，将会进行默认类型转化。

4. Dozer

  1. 运用反射。

  2. 嵌套对象字段，不会与源对象使用同一对象，即深拷贝。

  3. 默认支持类型不一致(基本类型/包装类型)转换。

  4. 通过配置字段名的映射关系，不一样字段的属性也被复制。

5. orika

  1. 底层其使用了javassist生成字段属性的映射的字节码，然后直接动态加载执行字节码文件，相比于使用反射的工具类，速度上会快很多。

  2. 支持深拷贝。

  3. 默认支持类型不一致(基本类型/包装类型)转换。

  4. 通过配置字段名的映射关系，不一样字段的属性也被复制。

上面介绍的这些工具类，不管使用反射，还是使用字节码技术，这些都需要在代码运行期间动态执行，所以相对于手写硬编码这种方式，上面这些工具类执行速度都会慢很多。

而MapStruct与上面五个组件原理都不同。

  1. MapStruct

1. 为什么选择MapStruct

接下来就要介绍MapStruct 这个工具类，这个工具类之所以运行速度与硬编码差不多，这是因为MapStruct在编译期间就生成属性复制的代码，运行期间就无需使用反射或者字节码技术，从而确保了高性能。

【JS】Java对象属性复制组件-Mapstruct项目改造指南

另外，由于编译期间就生成了代码，所以如果有任何问题，编译期间就可以提前暴露，这对于开发人员来讲就可以提前解决问题，而不用等到代码应用上线了，运行之后才发现错误。

所以，为了克服项目中当前函数的被提到的五个缺点，笔者引入了MapStruct。

2. 如何引入MapStruct

只需要引入MapStruct的依赖，同时由于MapStruct需要在编译器期间生成代码，所以我们需要maven-compiler-plugin插件中配置。

如果项目中没有用到lombok，下面的lombok相关配置可以删除；如果用到lombok，由于MapStruct和Lombok都会在编译期间生成代码，为解决冲突使用如下配置即可。

// pom.xml
       <dependency>
           <groupId>org.MapStruct</groupId>
           <artifactId>MapStruct</artifactId>
           <version>1.4.1.Final</version>
       </dependency>

// pom.xml
// 为了防止lombok和MapStruct的冲突，在pom.xml加入如下配置
<build>
   <plugins>
       <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-compiler-plugin</artifactId>
           <version>${plugin.compiler.version}</version>
           <configuration>
               <source>1.8</source>            
               <target>1.8</target>
               <annotationProcessorPaths>
                   <path>
                       <groupId>org.MapStruct</groupId>
                       <artifactId>MapStruct-processor</artifactId>
                       <version>${MapStruct.version}</version>
                   </path>
                   <path>
                       <groupId>org.projectlombok</groupId>
                       <artifactId>lombok</artifactId>
                       <version>${lombok.version}</version>
                   </path>
                   <!-- other annotation processors -->
               </annotationProcessorPaths>
           </configuration>
       </plugin>
   </plugins>
</build>

3. MapStruct的常见使用方法

使用MapStruct很简单，只需要创建一个mapper文件，然后在需要使用转换的地方，注入调用即可。

下面列举了两个文件，涵盖项目中绝大多数的mapper文件写法。

DO转成DTO的mapper：

/**
* componentModel = "spring"：表明该类是一个 spring 组件,之后调用处只需要使用@Autowired，即可引入该类实例
* NullValuePropertyMappingStrategy.IGNORE：如果遇到旧对象属性为null，则跳过该属性赋值给新对象
*/
@Mapper(componentModel = "spring", nullValuePropertyMappingStrategy = NullValuePropertyMappingStrategy.IGNORE)
public interface UserTransMapper {
   /**
    * 这个对象可用于非Spring环境下获取当前对象实例。如果在Spring环境下，该行代码可删除
    */
   UserTransMapper INSTANCE = Mappers.getMapper(UserTransMapper.class);
   
   /**
    * 将Userinfo对象中非null的属性转化为UserDto的对象
    * @param userInfo 从数据库读取的用户信息
    * @return
    */
   UserDto userInfo2userDto(UserInfo userInfo);
   /**
    * 将Userinfo对象中非null的属性更新到UserDto的对象
    * @param userInfo 从数据库读取的用户信息
    * @param userDto 用户信息的dto
    * 如果改void为UserDto，则函数会返回更新后的UserDto对象
    */
   void updateUserInfo2userDto(UserInfo userInfo, @MappingTarget UserDto userDto);
   /**
    * 将UserDto对象中非null的属性转化为LoginEventDto的对象
    * @param userDto 用户信息的dto
    * @return LoginEventDto继承UserDto
    */
   LoginEventDto userDto2loginEventDto(UserDto userDto);
}

DTO转成VO的mapper：

@Mapper(componentModel = "spring", nullValuePropertyMappingStrategy = NullValuePropertyMappingStrategy.IGNORE)
public interface UserTransMapper {
   /**
    * UserDto对象中非null的属性转化为UserInfoVo的对象
    * @param userDto 用户信息的dto
    * @return UserInfoVo继承与UserBaseInfoVo，都是用了@Data，没有异常报错。
    */
   UserInfoVo userDto2userVo(UserDto userDto);
   /**
    * 直接写嵌套List等集合类，同样可以生效
    * @param userDtoList
    * @return
    */
   List<UserInfoVo> userDto2userVo(List<UserDto> userDtoList);
   /**
    * 如果UserDto存在成员变量是类UserSubDto，而UserInfoVo存在成员变量是类UserSubVo，想在上面转化的同时，让这两个成员变量进行赋值，只需要定义下面的函数即可。
    *
    * @param userSubDto 用户信息的dto中的成员变量，类型为UserSubDto
    * @return
    */
   UserSubVo userSubDto2userSubVo(UserSubDto userSubDto);
   /**
    * UserDto对象和FollowInfoDto对象中非null的属性转化为UserInfoVo的对象
    * @param userDto 用户信息的dto
    * @param followInfoDto 关注粉丝的dto
    * @param hn 房子数量
    * @return
    */
   @Mappings({
           @Mapping(source = "userDto.regionId",target = "regionId"),
           @Mapping(source = "followInfoDto.price", target = "price", numberFormat = "0.00"),
           @Mapping(source = "hn",target = "houseNumber")
   })
   /**
    * @Mapping也就是手动映射字段的操作，使用简单，读者可自行研究
    */
   UserInfoVo userDto2userVo(UserDto userDto, FollowInfoDto followInfoDto, Integer hn);
   /**
    * 假设从映射Person到PersonDto需要一些MapStruct无法生成的特殊逻辑，可以定义一个default函数
    */
   default PersonDto personToPersonDto(Person person) {
       // 手动写映射逻辑
   }
}

  1. 项目改造与踩坑提示

这次改造中相关依赖的版本：

  1. lombok版本1.16.22，改造时升级为1.18.12

  2. 项目原有依赖fastjson版本1.2.62

  3. 引入MapStruct版本为1.4.1.Final

说明：

  1. 之所以要升级lombok版本，是因为上面UserDto对象转化为LoginEventDto对象时，原有项目只在UserDto上添加@Builder，但是继承类LoginEventDto无法继承@Builder，导致MapStruct实例化的时候实例一个UserDto对象。
    解决方法：在继承层次结构的所有类(即LoginEventDto和UserDto)都需要使用@SuperBuilder可以，（类UserDto的@Builder要去掉）但这个@SuperBuilder只在更高的lombok版本才有，所以才升级了lombok版本。

  2. 项目中使用了fastjson，因此业务代码中出现很多处需要反射调用无参构造函数。但在上面一步升级lombok的过程中，lombok对于@Builder的实现出现了一些修改：在1.16.22的生成代码中，是存在private级别的无参构造函数；而在1.18.12的生成代码中，并没有私有无参构造函数，从而导致了业务代码大量出现缺少默认构造函数的报错。
    解决方法：@Builder注解跟构造函数之间的冲突很常见。最佳实践是：在所有使用@Builder或者@SupserBuilder的类，增加@NoArgsConstructor和@AllArgsConstructor。

虽然本文极力推荐MapStruct，但如果是老项目的话，尤其是大项目的话，还是考虑下改造后的测试成本。本人在第一次引入的时候，过于自信，在父pom引入MapStruct并提升了lombok版本，直接导致开发环境的微服务集体报错。后来改为在单个微服务实验，并且放在开发环境长期观察（主要这个改动影响测试覆盖面太大，也不想让QA为了技术优化来加班），之后才敢放到生产。

当然如果是新项目，非常推荐尝试下MapStruct。

  1. Q&A

  1. 在项目引入MapStruct时，有人会提出现在反射的性能消耗已经很低了，Spring、Mybatis等各种框架中大量使用反射，为什么还要使用MapStruct这种编译期生成代码的组件？
    主要有如下考虑：
    1.反射本身的性能损耗还是很大的，但由于开源库对反射进行了缓存等优化处理，才减少反射对性能损耗的影响。然而，相比调用MapStruct生成的方法，优化后的性能还是差很多。
    2.开源库使用反射是为了通用性考虑，但在具体的业务场景，对象之间的转换是很确定的。
    3.MapStruct组件本身使用很简单（看完这篇博客之后，可以解决大部分应用场景）。同时， MapStruct组件还能处理一些反射无法处理或者更加灵活解决一些应用问题。

总结：

本文给大家带来Java对象属性复制组件-Mapstruct项目改造指南希望大家能够喜欢，期待下期有更好的文章给大家

以上是 【JS】Java对象属性复制组件-Mapstruct项目改造指南 的全部内容， 来源链接： utcz.com/a/95593.html

回到顶部