sonarqube代码检查使用教程(sonarqube教程二)

sonarqube如何安装请访问上一篇文章

当我们安装好 sonarqube后 就可以进行代码检查了

配置文件

在我们需要检查的项目目录下 新建 sonar-project.properties 配置文件
内容如下

sonar.projectKey=wzgy
sonar.projectName=wzgy
sonar.projectVersion=5.0
# Path to the parent source code directory.
# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
# Since SonarQube 4.2, this property is optional if sonar.modules is set.
# If not set, SonarQube starts looking for source code from the directory containing
# the sonar-project.properties file.
# 项目目录
sonar.sources=F:\\EOS\\wzgy\\com.tenglong.qualitycheck\\src

# Encoding of the source code
sonar.sourceEncoding=UTF-8

# Additional parameters
sonar.my.property=value

# 项目目录
sonar.java.binaries=F:\\EOS\\wzgy\\com.tenglong.qualitycheck\\src

sonar.language=java
sonar.exclusions=**/*.js

配置说明

sonar.projectKey=gpcore       #sonar平台中相对应项目的key
sonar.projectName=gpcore      #sonar平台中相对应项目的名字
sonar.sources=.               #sonar检测的源文件目录,‘.’表示当前根目录下的所有文件目录;包含主要源文件的目录的逗号分隔路径
sonar.exclusions=**/*_test.go,**/vendor/**      #检测中排除的源文件(排除的源文件不参与检测,一般排除单元测试文件、配置文件等)
sonar.tests=.                 #sonar检测的测试文件目录,‘.’表示当前根目录下的所有文件目录;包含测试源文件的目录的逗号分隔路径。从构建系统中读取Maven,Gradle,MSBuild项目。否则默认为空。
sonar.test.inclusions=**/**_test.go             #检测中的测试源文件(指定单元测试文件)
sonar.test.exclusions=**/vendor/**              #检测中排除的测试源文件(排除的源文件不参与检测)

如下:

java获取sonarqube扫描数据 sonarqube代码检查_源文件

创建测试项目

在浏览器进入sonarqube 主页 如下 创建项目

java获取sonarqube扫描数据 sonarqube代码检查_源文件_02

java获取sonarqube扫描数据 sonarqube代码检查_java获取sonarqube扫描数据_03

选择语言

java获取sonarqube扫描数据 sonarqube代码检查_源文件_04


因为我这里是不是maven项目

所以我选择的是其他, 操作系统是window

然后点击完成

java获取sonarqube扫描数据 sonarqube代码检查_java获取sonarqube扫描数据_05


然后我们需要下载window的扫描器,点击上图的下载按钮 下载解压即可,

然后bin目录加入path变量中

,双击sonar-scanner-debug.bat 启动即可

java获取sonarqube扫描数据 sonarqube代码检查_源文件_06

创建令牌

点击最上面的创建令牌创建一个令牌

java获取sonarqube扫描数据 sonarqube代码检查_文件目录_07


然后我们可以看到如下的信息表明令牌创建成功

java获取sonarqube扫描数据 sonarqube代码检查_源文件_08


我们按照图中所说 把命令在项目目录下执行即可

java获取sonarqube扫描数据 sonarqube代码检查_源文件_09


cmd进入 我们需要测试的项目目录

然后输入命令

如下 表示检测完成

注意:如果提示 sonar-scanner 不是命令 需要把sonar-scanner的bin目录加入到path中

java获取sonarqube扫描数据 sonarqube代码检查_java获取sonarqube扫描数据_10


然后在浏览器上 访问我们的 sonarqube 观察我们的项目,可以看出来检测结果

java获取sonarqube扫描数据 sonarqube代码检查_文件目录_11


点击项目进入如下页面

java获取sonarqube扫描数据 sonarqube代码检查_java获取sonarqube扫描数据_12


然后点击bugs 如下

java获取sonarqube扫描数据 sonarqube代码检查_配置文件_13


然后继续点击就可以看到我们距离的哪个类那行代码出现什么错误了

java获取sonarqube扫描数据 sonarqube代码检查_文件目录_14

然后修改即可

注意: 如果项目过大 容易出现内存溢出
这时候把我们的需要检测的模块单独复制出来检测即可,