sonar如何添加自定义JAVA规则

参考：

一、https://docs.sonarqube.org/display/DEV/Adding+Coding+Rules

二、https://docs.sonarqube.org/display/DEV/Adding+Coding+Rules+using+Java

三、https://docs.sonarqube.org/display/PLUG/Writing+Custom+Java+Rules+101

有两种方式能够扩展代码规则：可是Java只支持方式1

一、Writing coding rules using Java via a SonarQube plugin

二、Adding XPath rules directly through the SonarQube web interface

 

Writing coding rules in Java is a six-step process:

• Create a SonarQube plugin.
• Put a dependency on the API of the language plugin for which you are writing coding rules.
• Create as many custom rules as required
• Generate the SonarQube plugin (jar file)
• Place this jar file in the SONARQUBE_HOME/extensions/plugins directory
• Restart SonarQube server

下面详述这个过程：

一、把项目拉到本地

git clone git@github.com:shengulong/sonar-custom-rules-examples.git

二、里面有cobol/java/javascript/php/rpg的自定义规则，咱们只关注java的

三、使用intellij idea打开项目java-custom-rules（github上，我已经调试经过）。这是一个maven项目的模板。

四、修改下pom文件:sonar的版本以及对应的java插件版本，这样sonar6.0以上版本均可以用这个插件

 1 <properties>
 2         <!--<sonar.version>6.3</sonar.version>-->
 3         <sonar.version>6.0</sonar.version>
 4         <!-- this 6.3 is only required to be compliant with SonarLint and it is required
 5             even if you just want to be compliant with SonarQube 5.6 -->
 6         <!--<java.plugin.version>4.7.1.9272</java.plugin.version>-->
 7         <java.plugin.version>4.5.0.8398</java.plugin.version>
 8         <sslr.version>1.21</sslr.version>
 9         <gson.version>2.6.2</gson.version>
10 </properties>

五、修改下文件，由于最初下载的报编译错误

sonar-custom-rules-examples/ java-custom-rules/ src/ main/ java/ org/ sonar/ samples/ java/ MyJavaRulesDefinition.java

 

a、注释掉//import org.sonar.plugins.java.Java;

b、修改函数，主要修改为下文的java字段，由于咱们编辑的java规则插件

 1 @Override
 2   public void define(Context context) {
 3     NewRepository repository = context
 4       .createRepository(REPOSITORY_KEY, "java")
 5       .setName("MyCompany Custom Repository");
 6 
 7     List<Class> checks = RulesList.getChecks();
 8     new RulesDefinitionAnnotationLoader().load(repository, Iterables.toArray(checks, Class.class));
 9 
10     for (Class ruleClass : checks) {
11       newRule(ruleClass, repository);
12     }
13     repository.done();
14   }

六、其余修改参照github代码提交记录，而后按照https://docs.sonarqube.org/display/PLUG/Writing+Custom+Java+Rules+101的步骤操做便可，来张最终效果图：