MapStruct升级遇到的问题及解决方案

大家知道，MapStruct是一个用于生成类型安全，高性能和无依赖的bean映射代码的注释处理器。虽然它提高了一个一个字段进行set赋值的开发效率，但是版本升级也可能有不兼容的问题。

问题：

1..升级mapstruct到1.3.0版本之后，当target类使用lombok的@Builder注解，并且source类和target类的首字母不同的字段没有被正确转换（1.2.0版本可以正常转换）。

2.升级mapstruct到1.3.0版本之后，当target类使用lombok的@Builder注解，并且需要映射到父类的属性，则编译时会报  Unknown property

分析：

MapStruct 和lombok 的相遇，如果版本不一致，就会带来一定的问题。

MapStruct是一个用于生成类型安全，高性能和无依赖的bean映射代码的注释处理器；

而LombokLombok是一款Java开发插件，使得Java开发者可以通过其定义的一些注解来消除业务工程中冗长和繁琐的代码，比如get set等，尤其对于简单的Java模型对象（POJO）。

两者都是通过注解处理器在编译期生成对应的代码。

举例如下：

下图为基于Lombok注解的POJO类：

这个是基于MapStruct注解定义的mapper接口

经过lombok的注解处理器，编译后的class如下：

经过mapstruct的注解处理器，对UserDTOMapper自动生成了接口实现类：

结论：

可见，mapstruct 的注解处理器必须晚于 lombok的注解处理器执行，才能保证bean 属性能被正确映射。而出现上述问题的原因就在于lombok 和 mapstruct的执行顺序被打乱了。

解决方案：

 在编译插件中控制注解处理器的顺序。

pom 如下：

       <plugin> 
          <groupId>org.apache.maven.plugins</groupId>  
          <artifactId>maven-compiler-plugin</artifactId>  
          <version>${maven-compiler-plugin.version}</version>  
          <configuration> 
            <source>${java.version}</source>  
            <target>${java.version}</target>
<!--            <release>${java.version}</release>-->
            <annotationProcessorPaths> 
              <path> 
                <groupId>org.projectlombok</groupId>  
                <artifactId>lombok</artifactId>  
                <version>${lombok-plugin.version}</version> 
              </path>  
              <path> 
                <groupId>org.mapstruct</groupId>  
                <artifactId>mapstruct-processor</artifactId>  
                <version>${mapstruct-plugin.version}</version> 
              </path>  
              <path> 
                <groupId>org.projectlombok</groupId>  
                <artifactId>lombok-mapstruct-binding</artifactId>  
                <version>${lombok-mapstruct-binding-plugin.version}</version> 
              </path> 
            </annotationProcessorPaths> 
          </configuration> 
        </plugin>

其中 lombok-mapstruct-binding 的包正是为了协调lombok和mapstruct的处理过程的。

这里仍然有个细节大家可以关注下：

（1）在annotationProcessorPaths 中去掉lombok-mapstruct-binding  这个包，其实也可以正确执行的。只要lombok的path 声明在 mapstruct之前。

（2）上述的annotationProcessorPaths配置，如果颠倒了lombok和mapstruct的顺序，其实也是可以正确执行的，只要同时引入了lombok-mapstruct-binding 

总结

1.在POM中没有annotationProcessorPaths时，Maven使用的classPath作为注解处理器执行的顺序，而classPath的顺序正是dependencies中汇入的顺序。

2.当MapStruct依赖在Lombok依赖前面时，在执行注解处理器期间， 由于Lombok还未生成get、set程式码，因此在MapStruct看来，这些类并没有公开的成员变数，也就无从生成用于转换的方法。

3.在使用annotationProcessorPaths后，其强制规定了注解处理器的顺序，dependencies中的顺序就被忽略了，Maven一定会先执行Lombok再执行MapStruct。

到此这篇关于MapStruct升级遇到的问题及解决方案的文章就介绍到这了,更多相关MapStruct升级内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

最新评论