mapstruct 如何跳过 checkstyle 的代码规范检测?

mapstruct 文档:
MapStruct 1.6.0 Reference Guide

背景

基于 spring-boot-starter-web 的普通web项目,使用了lombok插件、mapstruct插件辅助开发。
现要求代码开发规范要过 maven-checkstyle-plugin 插件的检测。
maven-checkstyle-plugin 的代码风格配置文件中要求 if 关键和后面的括号不能有空格,如:

if(po == null){
  return null;
}...

而正常的代码规范是有空格的,比如:


image.png

经过maven打包构建发现,checkstyle 插件指定在 package 阶段进行检测,如下:


image.png

执行 mvn clean package,报错如下:


image.png

mapstruct的原理

MapSturct 是一个生成类型安全, 高性能且无依赖的 JavaBean 映射代码的注解处理器(annotation processor)

简单的说下,想了解具体的自行百度。

在 compile 过程中:

  1. javac对源代码进行分析,生成了一棵抽象语法树(AST)
  2. 过程中调用了实现 “jsr 269 API”的 mapstruct,mapstruct在 target目录下生成了 generated-sources目录,为bean转换的java实现类,如图:


    image.png

    这里说一下编译时解析,有两种方式:

  • APT(Annotation Processing Tool) 已过时
  • API(Pluggable Annotation Processing API)
    mapstruct就是用了第二种方式 注解解析器
  1. 编译 .java -> .class

为什么lombok不受影响

lombok和mapstruct都是在编译时做手脚,但lombok和 cglib动态代理一样,用的那个字节码直接写入的技术,不会生成 java源文件,也就不受 checkstyle插件的影响。

原因

checkstyle 插件扫到了 target 目录下 mapstruct 用 freemarker 基于 ftl 模版生成的 impl 实现类,如图:


image.png

解决思路

  1. 弃用 mapstruct,或等mapstruct生成好之后把impl方法复制过来改改格式。。。
    当然可以,不过太累了,也不是个常规的办法。

  2. checkstyle插件目的是约束开发代码的规范,直接指定其检测的目录不行吗?
    当然可以,不过我这里插件配置是甲方规定的,到时候这块是在自动化构建ci/cd过程中人家配置的,人家指定的规则可不配合你改,人家就想都检测。
    一般人也不会去检测,就算自己想检测规范大不了配置个范围,比如:
    配置代码检测的范围:

<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-checkstyle-plugin</artifactId>
                <version>3.1.2</version>
                <configuration>
                    <configLocation>style/checkstyle.xml</configLocation>
                    <failsOnError>false</failsOnError>
                    <!-- 配置代码检测的范围 -->
<!--                    <sourceDirectories>-->
<!--                        <sourceDirectory>${project.build.sourceDirectory}</sourceDirectory>-->
<!--                        <sourceDirectory>${project.build.testSourceDirectory}</sourceDirectory>-->
<!--                    </sourceDirectories>-->
                </configuration>
                <executions>
                    <execution>
                        <id>checkstyle-check</id>
                        <phase>package</phase>
<!--                        <phase>compile</phase>-->
                        <goals>
                            <goal>check</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
  1. 覆盖 mapstruct 的模版,指定使用自己的 ftl 模版
    行不通,因为他是“编译时解析”无法正常覆盖!而且,查看了mapstruct的官方文档和源代码,没有暴露任何修改ftl的spi。

  2. 既然覆盖不了,fork一份源码自己改不行吗?
    当然可以,不过暂时没去这么做。

  3. 仔细看maven构建的生命过程,mapstruct是发生在compile这步,而 checkstyle是发生在package这步之前,如图:


    image.png

    那我们在 target 目录下 generated-sources 文件夹等 compile 结束后 class文件都生成好之后,把这个临时的java文件夹给删了不就好了?可以,配置如下:

<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-antrun-plugin</artifactId>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>run</goal>
                        </goals>
                        <configuration>
                            <target>
                                <delete dir="${project.build.directory}/generated-sources" />
                            </target>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

【建议放在checkstyle插件前,这样即便是checkstyle指定检测环节为compile也不影响。checkstyle如果指定检测环节在compile之前那就更不影响了因为那时候mapstruct还没上岗工作】

上面加的删除generated-sources步骤,在构建中,如图:


image.png

mapstruct能否配置删了自己渲染的 java文件夹?
不能,因为他只负责生产java源文件即 generated-sources目录下的文件,后面的“编译到class”这一步他已经“歇班”了。
测试:


image.png

最后

如果你能改checkstyle的扫描范围当然是最合理的了。
如果不考虑那点儿性能,用BeanUtils反射也挺好。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容