检查工具搭建

前言

该篇博文介绍一下CheckStyle和PMD如何集成到工程中，以让工程打包时强制检查一遍代码，避免空谈代码检查却无人执行的尴尬境地。

搭建build-tools工程

可以在lang包中或者各个模块中定义一个build-tools工程，该工程中没有代码，仅是引入代码检查的配置文件

pom文件中引入plugin

针对于各个模块parent的pom.xml文件，引入如下plugin

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
<build>
  <plugins>
    <plugin>
      <artifactId>maven-checkstyle-plugin</artifactId>
      <version>3.0.0</version>
      <dependencies>
        <!--由于默认引入的版本，有些新的检查要求不支持，所以引入最新的checkstyle版本-->
        <dependency>
          <groupId>com.puppycrawl.tools</groupId>
          <artifactId>checkstyle</artifactId>
          <version>8.9</version>
        </dependency>
        <!--引入build-tools，版本号要自定义-->
        <dependency>
          <groupId>com.littlefisher</groupId>
          <artifactId>build-tools</artifactId>
          <version>${build-tools.version}</version>
        </dependency>
      </dependencies>
      <!--设置maven生命周期中何时执行代码检查-->
      <executions>
        <execution>
          <phase>process-sources</phase>
          <goals>
            <goal>check</goal>
          </goals>
        </execution>
      </executions>
      <configuration>
        <!--设置checkstyle的检查规范-->
        <configLocation>checkstyle/checkstyle.xml</configLocation>
        <!--设置checkstyle的例外情况-->
        <suppressionsLocation>checkstyle/suppressions.xml</suppressionsLocation>
        <!--是否打印出结果-->
        <consoleOutput>true</consoleOutput>
        <!--校验是否是否立即失败-->
        <failOnViolation>true</failOnViolation>
      </configuration>
    </plugin>
    <plugin>
      <artifactId>maven-pmd-plugin</artifactId>
      <!--最新版为3.9.0，但是由于AliCheck暂时不支持最新版本，所以降为3.8。同时由于降级，所以有一些检查规范，3.8中暂时不支持-->
      <version>3.8</version>
      <dependencies>
        <!--引入build-tools，版本号要自定义-->
        <dependency>
          <groupId>com.littlefisher</groupId>
          <artifactId>build-tools</artifactId>
          <version>${build-tools.version}</version>
        </dependency>
        <!--引入P3C的检查，当前最新版本为1.3.5-->
        <dependency>
          <groupId>com.alibaba.p3c</groupId>
          <artifactId>p3c-pmd</artifactId>
          <version>${p3c-pmd.version}</version>
        </dependency>
      </dependencies>
      <configuration>
        <!--编码格式-->
        <sourceEncoding>${project.build.sourceEncoding}</sourceEncoding>
        <!--是否生成报告-->
        <linkXRef>false</linkXRef>
        <!--jdk版本-->
        <targetJdk>${java.version}</targetJdk>
        <failOnViolation>true</failOnViolation>
        <printFailingErrors>true</printFailingErrors>
        <!--pmd校验规则-->
        <rulesets>
          <ruleset>pmd/pmd-ruleset.xml</ruleset>
          <!--下面的都是阿里P3C的检查要求-->
          <ruleset>rulesets/java/ali-comment.xml</ruleset>
          <ruleset>rulesets/java/ali-concurrent.xml</ruleset>
          <ruleset>rulesets/java/ali-constant.xml</ruleset>
          <ruleset>rulesets/java/ali-exception.xml</ruleset>
          <ruleset>rulesets/java/ali-flowcontrol.xml</ruleset>
          <ruleset>rulesets/java/ali-naming.xml</ruleset>
          <ruleset>rulesets/java/ali-oop.xml</ruleset>
          <ruleset>rulesets/java/ali-orm.xml</ruleset>
          <ruleset>rulesets/java/ali-other.xml</ruleset>
          <ruleset>rulesets/java/ali-set.xml</ruleset>
        </rulesets>
        <!-- 开启分析缓存 -->
        <analysisCache>true</analysisCache>
        <!-- 分析缓存文件地址 -->
        <analysisCacheLocation>${project.build.directory}/pmd/pmd.cache</analysisCacheLocation>
        <!--例外文件-->
        <excludes>
          <exclude>**/dal/model/*.java</exclude>
          <exclude>**/dal/example/*.java</exclude>
        </excludes>
      </configuration>
      <executions>
        <execution>
          <goals>
            <goal>check</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

 

idea引入CheckStyle插件

首先在idea的plugin中下载CheckStyle-IDEA插件

如图所示，在Configuration File框中点击加号添加校验规则即可，具体的校验规则在build-tools中进行了配置

idea引入PMD插件

首先在idea的plugin中下载PMDPlugin插件

如图所示，在RuleSets下点击加号添加PMD的检查规则即可，具体的校验规则在build-tools中进行了配置，可直接使用


posted @ 2019-07-31 15:49  qxwang  阅读(62)  评论(0)    收藏  举报