SonarQube中添加p3c-pmd整合阿里java开发规范

/ 测试Java / 没有评论 / 3583浏览

sonar代码质量安装

以上版本组合的原因：

  1. sonar-pmd的编译需要mvn3.6+
  2. 使用阿里p3c的规则进行代码分析时，用到了类com.google.gson.Gson，但对应的jar包gson在sonar-pmd3.2.1中并没有依赖到，所以报错找不到类而分析失败。 sonar-pmd3.1+版本中都没有，但3.0.1中有
  3. 截至目前最新版本p3c-pmd(1.3.6)依赖的pmd版本为5.5.2，但最新版sonar-pmd(3.2.1)依赖的pmd版本为6.10.0，版本冲突，在使用阿里p3c规则进行代码分析时，因为pmd-java版本为6.10.0，导致缺少类net.sourceforge.pmd.lang.java.rule.comments.AbstractCommentRule而分析失败
  4. sonar-pmd3.0.1依赖的是pmd5.4.2，包含类net.sourceforge.pmd.lang.java.rule.comments.AbstractCommentRule，可通过调整p3c-pmd使两者依赖的版本保持一致。
  5. sonar-pmd3.2.0以下版本不支持sonar7.6以上版本，sonar3.0.1支持了sonar7.4
  6. 虽然gitbub上已有集成了p3c的sonar-pmd，但版本是2.6，不支持7.x版本的sonar，且代码规则只有48条，目前阿里p3c-pmd中java规则53条。

ps:

进入正题

参考文章：https://www.jianshu.com/p/b849175dd38b

一、sonar-pmd中添加p3c规则
1、pom文件中添加p3c-pmd的引用
<dependency>
    <groupId>com.alibaba.p3c</groupId>
    <artifactId>p3c-pmd</artifactId>
    <version>1.3.6</version>
</dependency>
2、添加p3c规则文件

路径sonar-pmd-plugin\src\main\resources\org\sonar\l10n\pmd\rules下存放规则的描述文件html，新建文件夹pmd-p3c，本次制作基于sonar-p3c-pmd，从其中拷贝并修改，对比eclipse，修改描述文件内容为中文，并补充description，由于sonar-p3c-pmd只有48条，手动新建html文件，增加其余5条规则。 内容示例：

<p>单个方法的总行数不超过80行。</p>
<p>Description:</p>
<p>   说明：包括方法签名、结束右大括号、方法内代码、注释、空行、回车及任何不可见字符的总行数不超过80行。</p>
<p>Examples:</p>
<pre>
</pre>

然后在路径sonar-pmd-plugin\src\main\resources\org\sonar\plugins\pmd下新建rules-p3c.xml，本次制作该文件也是从sonar-p3c-pmd中拷贝，并补充缺少的规则：

<rule key="MethodTooLongRule">
    <priority>MAJOR</priority>
    <configKey><![CDATA[rulesets/java/ali-other.xml/MethodTooLongRule]]></configKey>
</rule>

其中key值以及configKey中对应规则名，priority则对比eclipse中该规则的priority进行配置，至于xml文件则对比p3c-pmd的p3c-master\p3c-pmd\src\main\resources\rulesets\java文件夹下所有xml，以确认当前规则属于哪个。emmm这种方法实在笨拙，或者说本次制作过程都很笨拙。

3、修改pmd中配置，添加p3c规则配置

涉及到的文件有两个：

sonar-pmd-plugin\src\main\resources\com\sonar\sqale\pmd-model.xml
sonar-pmd-plugin\src\main\resources\org\sonar\l10n\pmd.properties

从sonar-pmd的gitbub pull下来代码后，里面默认是pmd自身的规则配置，由于本次目的是使用阿里的java开发规范进行代码规则检查，所以可注释掉，当然不注释也行。

注意: 注释时pmd.properties文件中所有以rule.pmd.*.param.*=开头的不能注释掉，否则sonar启动加载pmd插件时会报错。

首先向pmd.properties中添加阿里规则，以ClassNamingShouldBeCamelRule为例，

rule.pmd.ClassNamingShouldBeCamelRule.name=[p3c]Class names should be nouns in UpperCamelCase except domain models: DO, BO, DTO, VO, etc.

其中[p3c]是为了在sonarqube中激活代码规则时方便而做的标识，其后是规则概述。可能由于sonarqube对properties文件的读取方式问题，文件内容不能使用中文，否则乱码。

概述信息可参考p3c-pmd中的p3c-master\p3c-pmd\src\main\resources\messages_en.xml文件，也可对比eclipse和idea进行配置。本次制作过程是基于sonar-p3c-pmd并对比eclipse和idea进行配置，过程中也发现了sonar-p3c-pmd中pmd.properties文件部分错误。然后向pmd-model.xml中添加阿里规则，首先区分定义阿里规则，在文件末尾</sqale>标签前添加如下代码：

<chc>
    <key>P3C-PMD</key>
    <name>p3c-pmd</name>
    <chc>
        <key>P3C_PMD</key>
        <name>p3c_pmd</name>
        <!--在此处添加rule的chc-->
    </chc>
</chc>

然后再上面那部分代码的注释处添加规则，依旧以ClassNamingShouldBeCamelRule规则为例，其它规则在它之后追加，内容基本一致，只需要改动rule-key标签中的值即可。

<chc>
    <rule-repo>pmd</rule-repo>
    <rule-key>ClassNamingShouldBeCamelRule</rule-key>
    <prop>
        <key>remediationFunction</key>
        <txt>CONSTANT_ISSUE</txt>
    </prop>
    <prop>
        <!--此处为该技术债务所需要的时间，单位使用min，此处设为2min-->
        <key>offset</key>
        <val>2</val>
        <txt>min</txt>
    </prop>
</chc>
4、添加p3c规则的引入

涉及到的文件：

sonar-pmd-plugin\src\main\java\org\sonar\plugins\pmd\rule\PmdRulesDefinition.java

img

5、打包

使用mvn package -Dmaven.test.skip=true打包即可，如果规则的描述文件html中包含中文内容，那么注意文件编码需要是utf-8。

二、sonarqube中启用p3c规则
1、将插件jar包添加到sonar

路径sonarqube-7.7/extensions/plugins，jar包放里面，重启sonarqube即可。

2、sonarqube中配置p3c规则

在Quality Profiles【质量配置】页面点击Create【创建】创建质量配置，Name【名称】自己填，Language【语言】选Java，点击Create【创建】后跳转到该质量配置的详情界面，然后点击Activate more【更多激活规则】，在Search for rules...【搜索规则...】中搜索p3c，然后点击Bulk Change【批量修改】，确认Apply【应用】到刚新建的质量配置即可。

img

然后回到Quality Profiles【质量配置】页面，将该质量配置Set as Default【设为默认】即可。完事儿,分析看下。

img

本文由 创作，采用 知识共享署名4.0 国际许可协议进行许可。本站文章除注明转载/出处外，均为本站原创或翻译，转载前请务必署名。最后编辑时间为: 2020/05/17 02:20

→ ← ↓ ↑