sonarqube配置和使用

随着公司业务发展,项目逐渐庞大,代码也越来越多,而不同的开发人员在编码习惯以及技术能力上也会有较大的差异,为了进行高质量的项目代码管理,并及时的对代码进行分析并给出合理的解决方案已经成为必需。

SonarQube 是一个开源的代码质量管理系统,它可以通过使用插件与 eclipse 集成,从而实现了对代码的质量的全面自动化分析和管理。SonarQube 并不是简单地将各种质量检测工具的结果(例如 FindBugs,PMD 等)直接展现给客户,而是通过不同的插件算法来对这些结果进行再加工,最终以量化的方式来衡量代码质量,从而方便地对不同规模和种类的工程进行相应的代码质量管理。

部署步骤如下:

1、 下载sonarqube-7.1,地址为:https://www.sonarqube.org/downloads/

2、 解压sonarqube-7.1.zip,根据操作系统的版本启动sonarqube,这里的环境为启动的脚本为:sonarqube-7.1\bin\windows-x86-32\StartSonar.bat;

注意:jdk的版本需要jdk8,需要设置环境变量JAVA_HOME,并将JAVA_HOME/bin目录加入到系统环境的PATH

3、 启动后采用http://127.0.0.1:9000/访问系统,默认的用户和密码为admin/admin.

4、 建一个project,如下

[图片上传失败...(image-8bc2a6-1526545610440)]

5、 对于采用Maven的工程比较简单,进行如下设置,修改文件, 文件路径为$MAVEN_HOME/conf或者~/.m2修改得内容如下:

<settings>

<pluginGroups>

<pluginGroup>org.sonarsource.scanner.maven</pluginGroup>

</pluginGroups>

<profiles>

<profile>

<id>sonar</id>

<activation>

<activeByDefault>true</activeByDefault>

</activation>

<properties>

``

<sonar.host.url>[http://ocalhost:9000](http://ocalhost:9000)</sonar.host.url>

</properties>

</profile>

</profiles>

</settings>

6、 在需要分析的项目下面执行:mvn clean verify sonar:sonar;需要注意的创建的project必须和我们需要分析的项目工程名字保持一致,否则分析的数据无法导入到sonarqube中;

如下在分析的过程中提示内容溢出,请设置:

set MAVEN_OPTS=-Xmx512m linux下面执行export MAVEN_OPTS="-Xmx512m"

如果需要排除部分目录可以进行设置:

maven的pom.xml文件里面加入sonar.exclusions指明哪些自动生成代码的文件夹不需要分析。

具体的匹配规则可以参考sonar的官方文档,非常简单 (docs.sonarqube.org )。注意使用maven项目时匹配的文件夹基础是project base dir。

Wildcard Matches

? 匹配单个字符 ** 匹配0个或多个文件夹 * 匹配0个或多个字符

在pom.xml文件中添加以下事列代码即可,

<properties>
<sonar.exclusions>
src/main/java/com/.../domain/model//,
src/main/java/com/.../exchange/
/
</sonar.exclusions>
</properties>

7、 分析结束后即可在http://127.0.0.1:9000/projects中查看到分析结果,如下:

[图片上传中...(image.png-412ca1-1526545463323-0)]

进一步查看详细的信息:

[图片上传失败...(image-ab5cb2-1526545385966)]

具体到代码的错误信息:

[图片上传失败...(image-155cc7-1526545385966)]

代码统计信息:

[图片上传失败...(image-9cf362-1526545385966)]

8、 其它的类型工程请参照https://docs.sonarqube.org/display/SCAN进行设置;

[图片上传失败...(image-63005-1526545385966)]

9、 如果是一个普通的工程就需要下载sonar-scanner,这里下载的地址为:https://sonarsource.bintray.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-3.1.0.1141.zip

10、 解压文件,并将sonar-scanner-3.1.0.1141\bin目录加入的系统的PATH中

11、 在需要分析的工程目录下面创建一个sonar-project.properties文件,内容如下:

must be unique in a given SonarQube instance

sonar.projectKey=pcsys

this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1.

sonar.projectName=pcsys

sonar.projectVersion=1.0

Path is relative to the sonar-project.properties file. Replace "" by "/" on Windows.

This property is optional if sonar.modules is set.

sonar.sources=.

Encoding of the source code. Default is default system encoding

sonar.sourceEncoding=UTF-8

Language

sonar.language=java

sonar.java.binaries=build/classes

sonar.java.binaries=.

排除掉的目录

sonar.exclusions=./WebRoot/plug-in

执行sonar-scanner,如果提示内存溢出,执行

set SONAR_SCANNER_OPTS=-Xmx512m linux系统执行export SONAR_SCANNER_OPTS="-Xmx512m"

12、 最新的java分析插件版本为:sonar-java-plugin-5.3.0.13828.jar,分析工程的时候有问题,会提示Please provide compiled classes of your project with sonar.java.binaries property

解决方法为下载老版本的jar文件,这里下载的文件为:https://sonarsource.bintray.com/Distribution/sonar-java-plugin/sonar-java-plugin-4.10.0.10260.jar

下载完成后,重命名sonarqube-7.1\extensions\plugins目录下的sonar-java-plugin-5.3.0.13828.jar,并将刚下载的文件复制到此目录下面

[图片上传失败...(image-256f18-1526545385966)]

13、 执行完成后结果如下:

总揽

[图片上传失败...(image-3ff97c-1526545385966)]

详细的代码分析:

[图片上传失败...(image-826284-1526545385966)]

多次设定不同版本的执行结果对比分析:

[图片上传失败...(image-d1ae09-1526545385966)]

14、

推荐阅读更多精彩内容

  • 雨霖铃.晨昏秋雨 晨昏秋雨, 鸟栖山静, 半绕轻雾。 车驰速惹风涌, 呼呼虐面, 身寒无语。 转角频传响讯, 急停...
    寺咀山主人阅读 242评论 2 7
  • 傍晚时分,张司令和王金花一行浩浩荡荡来到杨府。此时杨府华灯初上,人声鼎沸,好不热闹。红玫瑰特意乔扮一番,可谓光采照...
    六月孺子牛阅读 213评论 3 6
  • 年底将至,小伙伴们准备好回答七大姑八大姨的各种问题了吗? 年底发了多少年终奖啊? 房子买了吗? 什么,还没有对象?...
    快跑小飞侠阅读 355评论 6 2