Sonar环境搭建及自定义规则
Sonar本地环境搭建只需5个步骤
1、下载sonar，地址https://www.sonarqube.org/downloads/
2、解压， 在文件路径C:\sonarqube-7.7\bin\windows-x86-64找到StartSonar.bat，运行批处理文件
3、登陆本地Sonar地址http://localhost:9000 ，用户名/密码为admin/admin，创建项目
4、在需要导入的工程里添加sonarqube插件，下面以构建技术为gradle为例
gradle版本2.7.1：
plugins {
id "org.sonarqube" version "2.7.1"}
gradle版本2.7.1以下：
buildscript {
repositories {
maven {
url "https://plugins.gradle.org/m2/" }
}
dependencies {
classpath "org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:2.7.1" }
}
apply plugin: "org.sonarqube"
5、在git bash里进入honghu-bff项目目录，执行下面的命令：
./gradlew sonarqube \
-Dsonar.projectKey=test \
-Dsonar.host.url=http://localhost:9000 \
-Dsonar.login=fd947522bf32deec964af97373015cda92dd15b7
如果出现build successful的标识，就表明构建成功了~
接下来我们再刷新下Sonar本地页面，能够看到我们工程代码质量的详细情况，包括测试覆盖率，bug个数，重复率等
Sonar关于校验代码bug及code smells等都是通过Rules下面系统自带的代码规则校验的，如下图，我们可以看到Java的自带规则如下，那么，我们如果想自己编写规则运用到项目里面，应该怎么处理呢？
下面，我们可以根据官方文档来操作一遍https://docs.sonarqube.org/display/PLUG/Writing+Custom+Java+Rules+101。可能光看文档不是很理解，我将把整个操作说的通俗易懂一点。
主要分为几个步骤：
创建一个SonarQube插件
增加相关依赖
创建自定义rules
生成插件的jar包
将该jar包放在SONARQUBE_HOME/extensions/plugins目录下
重启SonarQube
1、创建一个SonarQube插件
先把模板down下来，git地址：
https://github.com/SonarSource/sonar-custom-rules-examples/tree/master/java-custom-rules
然后导入IDE中，注意是maven工程
2、增加相关依赖
POM 文件中可以修改<groupId>, <artifactId>, <version>, <name> ,<description>等内容来定义自己的版本号和插件名称。如果用到java.plugin的话，<java.plugin.version>需要保证和实际sonarqube运行的sonar-java-plugin-xxx.jar插件版本号XXX一致，或者小于该版本号。
3、创建自定义rules
这里运用测试驱动开发（TDD）方法，首先编写一个用例，然后实现解决方案，我们需要写3个文件。
（1）需要被测试的文件
（2）测试类，运行单元测试时该类会调用规则来检测测试文件代码是否合规
（3）测试规则
在目录/src/test/files下创建需要被测试的文件MyFirstCustomCheck.java：
以下是需要被测试的代码，我们可以看到，有两行加上了// Noncompliant注释，我们需要编写一个规则来找到这两行不符合规范的代码，才算规则编写正确。
class MyClass {
MyClass(MyClass mc) { }
int foo1() { return 0; }
void foo2(int value) { }
int foo3(int value) { return 0; } // Noncompliant
Object foo4(int value) { return null; }
MyClass foo5(MyClass value) {return null; } // Noncompliant
int foo6(int value, String name) { return 0; }
int foo7(int ... values) { return 0;}
}
我们这里可以添加JDT AstView插件看下被测试的代码解析成语法树后是怎样的
在目录/src/test/java下创建测试类 MyFirstCustomCheckTest.java:
调用JavaCheckVerifier.verify(A,B)方法 A是需要扫描的文件，B是自定义规则,流程如下：
sonar先进行了一系列的scanFile操作，然后再把代码解析成抽象树进行扫描，最终返回结果输出报告。
visitorsBridge：用于保存通过规则对被测代码扫描后的结果
astScanner：返回解析的抽象语法树结果Tree ast对象
package org.sonar.samples.java.checks;
import org.junit.Test;
public class MyFirstCustomCheckTest {
@Test
public void test() {
JavaCheckVerifier.verify("src/test/files/MyFirstCustomCheck.java", new MyFirstCustomCheck());
}
}
在目录/src/main/java下创建测试规则
这里重写了IssuableSubscriptionVisitor的nodesToVisit方法。
nodesToVisit方法是说明该规则做检查的类型集合，比如METHOD_INVOCATION（方法调用）、CATCH（catch块）、MEMBER_SELECT（属性选择）等。
package org.sonar.samples.java.checks;
import com.google.common.collect.ImmutableList;
import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
import org.sonar.plugins.java.api.tree.Tree.Kind;
import java.util.List;
@Rule(key = "MyFirstCustomRule")
public class MyFirstCustomCheck extends IssuableSubscriptionVisitor {
@Override
public List<Kind> nodesToVisit() {
return ImmutableList.of();
}
}
执行MyFirstCustomCheckTest.java文件，得到结果如下：
至少有1个预期的问题，因为我们还没有传要检查的集合，所以返回的是ImmutableList.of()空字符串，会报这个问题
下面修改MyFirstCustomCheck类：
visitNode是自定义规则中的核心部分，你所要实现的代码检查逻辑就是在这个方法中完成的。在visitNode方法中，我们先获得所有方法解析出来的语法树，然后判断方法的参数的个数是否为1
public class MyFirstCustomCheck extends IssuableSubscriptionVisitor {
@Override
public List<Kind> nodesToVisit() {
return ImmutableList.of(Kind.METHOD);//遍历所有方法
}
@Override
public void visitNode(Tree tree) {
MethodTree method = (MethodTree) tree;
if (method.parameters().size() == 1) {
reportIssue(method.simpleName(), "Never do that!");
}
}
}
再次运行，又报错了，为什么呢
我们再来看下这个被测试代码，我们期待的是检测到第6行、第8行为不规范代码，实际除了第6、8行，第5、7、11行也检测出来了。因为我们检测的逻辑是方法的参数个数为1（method.parameters().size() == 1），观察第6行和第8行，不仅参数个数为1，并且第一个参数的类型与返参类型一致，所以需要重新修改逻辑。
修改成以下代码，再来执行一下：
public class MyFirstCustomCheck extends IssuableSubscriptionVisitor {
@Override
public List<Kind> nodesToVisit() {
return ImmutableList.of(Kind.METHOD);
}
@Override
public void visitNode(Tree tree) {
MethodTree method = (MethodTree) tree;
if (method.parameters().size() == 1) {
Symbol.MethodSymbol symbol = method.symbol();
Type firstParameterType = symbol.parameterTypes().get(0);
Type returnType = symbol.returnType().type();
if (returnType.is(firstParameterType.fullyQualifiedName())) {
reportIssue(method.simpleName(), "Never do that!");
}
}
}
}
规则测试通过~
好了，接下来我们可以把这条规则打包上传了。
4、在自定义插件中注册规则
首先我们需要为我们的规则提供所有元数据
把这个Rule注解写道MyFirstCustomCheck.java文件上，注明key值及名称，还有描述和优先级、标签等
@Rule(
key = "MyFirstCustomCheck",
name = "Return type and parameter of a method should not be the same",
description = "For a method having a single parameter, the types of its return value and its parameter should never be the same.",
priority = Priority.CRITICAL,
tags = {"bug"})
然后激活规则
打开类RulesList (org.sonar.samples.java.RulesList)，这个类有两个方法getJavaChecks()和getjavatestcheck()方法，在getJavaChecks()中注册的规则只对源文件播放，在getjavatestcheck()中注册的规则只对测试文件播放，以下我们是将规则都运用了，直接添加MyFirstCustomCheck.class即可
打包插件
接下来在git bash中将路径跳到java-custom-rule根目录下，然后输入mvn clean install命令，等待构建成功
将打包好的jar包放在sonar extension\plugins下面
重启SonarQube实例，进入Rule页面，查看MyCompany Custom Repository，就可以看到我们定义的规则了~
