sonarqube中怎么添加阿里java开发规范

这篇文章给大家介绍sonarqube中怎么添加阿里java开发规范，内容非常详细，感兴趣的小伙伴们可以参考借鉴，希望对大家能有所帮助。

1. 拉取sonar-pmd源码，切换到3.2.1。修改pom文件添加p3c-pmd依赖：

   <dependency>
       <groupId>com.alibaba.p3c</groupId>
       <artifactId>p3c-pmd</artifactId>
       <version>2.0.0</version>
   </dependency>

   
   

    

2.  开始配置阿里Java规范，此处演示配置规则：单个方法的总行数不超过80行，规则名为MethodTooLongRule，此规则名来源于p3c项目p3c\p3c-pmd\src\main\resources\rulesets\java\ali-other.xml文件中配置的规则名。

3.  首先在sonar-pmd项目sonar-pmd-plugin\src\main\resources\org\sonar\l10n\pmd\rules目录下新建pmd-p3c目录用于存放规则说明html，然后新建MethodTooLongRule.html, 添加内容如下：

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

   
   

    

4. 修改sonar-pmd项目sonar-pmd-plugin\src\main\resources\org\sonar\l10n\pmd.properties配置文件，添加MethodTooLongRule规则名如下：

   rule.pmd.MethodTooLongRule.name=[p3c]The total number of lines for a method should not be more than 80.

   
   

    

5. 在sonar-pmd项目sonar-pmd-plugin\src\main\resources\org\sonar\plugins\pmd目录下新建rules-p3c.xml规则文件并添加MethodTooLongRule规则配置如下：

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

   
   

    

6. 修改sonar-pmd项目sonar-pmd-plugin\src\main\resources\com\sonar\sqale\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>
           <rule-repo>pmd</rule-repo>
           <rule-key>MethodTooLongRule</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>
       </chc>
   </chc>

   
   

    

7. 添加p3c规则的引入，修改PmdRulesDefinition.java文件，在define方法内添加p3c规则库

       @Override
       public void define(Context context) {
           NewRepository repository = context
                   .createRepository(PmdConstants.REPOSITORY_KEY, PmdConstants.LANGUAGE_KEY)
                   .setName(PmdConstants.REPOSITORY_NAME);
   
           extractRulesData(repository, "/org/sonar/plugins/pmd/rules.xml", "/org/sonar/l10n/pmd/rules/pmd");
           // 新增
           extractRulesData(repository, "/org/sonar/plugins/pmd/rules-p3c.xml", "/org/sonar/l10n/pmd/rules/pmd-p3c");
           repository.done();
       }

   
   

    

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

9. 把sonar-pmd-plugin\target目录下的sonar-pmd-plugin-3.2.1.jar放到 sonarqube服务/extensions/plugins目录下重启服务。

10. 登陆sonarqube在质量配置页面点击【创建】按钮新建p3c质量，语言选Java，点击【创建】后跳转到该质量配置的详情界面，然后点击【更多激活规则】，在搜索规则中搜索p3c，然后点击【批量修改】，点击【应用】到刚新建的质量配置， 然后回到【质量配置】页面，将该质量配置Set as Default【设为默认】，然后就可以分析项目质量了。

    问题：

     1. 分析失败提示缺失类com/google/gson/Gson，在sonar-pmd项目pom文件添加如下依赖：

<dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.8.5</version>
</dependency>

    其他：

    1. 规则说明html内容来源于p3c\p3c-pmd\src\main\resources下的message.xml文件内配置的msg和desc内容，添加示例代码使用<pre>标签，如果代码内用泛型或代码为xml配置请使用<xmp>标签，示例如下：

<h3>Negative example :</h3><pre>  <xmp>   List<String> list = new ArrayList<String>();
   list.add("22");
   //warn
   List<String> test = (ArrayList<String>) list.subList(0, 1);   </xmp></pre>

   2.规则名来源于p3c\p3c-pmd\src\main\resources下的message_en.xml的配置的规则的msg内容，但存在部分msg过长导致sonar重启失败，请酌情删减。

   3. rules-p3c.xml添加规则类型type暂时用了CODE_SMELL和BUG

   4. rules-p3c.xml添加规则内的configKey配置要与p3c\p3c-pmd\src\main\resources\rulesets\java目录下的规则配置文件文件名和规则名一一对应。

关于sonarqube中怎么添加阿里java开发规范就分享到这里了，希望以上内容可以对大家有一定的帮助，可以学到更多知识。如果觉得文章不错，可以把它分享出去让更多的人看到。