代码质量检查工具SonarQube-Toy模板网

这篇具有很好参考价值的文章主要介绍了代码质量检查工具SonarQube。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

Devops流水线之SonarQube

1. 软件功能介绍及用途

SonarQube是一个用于代码质量管理的开源平台，用于管理源代码的质量，通过SonarQube我们可以检测出项目中重复代码，潜在bug，代码规范，安全性漏洞等问题，并通过SonarQube web UI展示出来

Sonar集成过程：

开发人员在本地的IDE中使用sonarLint运行分析本地代码
开发人员将代码提交到代码管理平台（GIT）
Devops工具构建，调用sonarScanner对项目代码进行扫描分析
分析报告发送到SonarQube Server中进行加工
SonarQube Server加工并且保存分析报告到SonarQube Database中，通过UI显示分析报告

2. 软件环境搭建与使用

代码质量检查工具SonarQube,java,devops
SonarQube为Devops平台所提供的一个测试类型的任务，已经由devops的人员搭建完毕，项目组可以直接进行配置使用。

2.1 使用方法

登录devops研发协同系统

点击左侧菜单树中的集成----构建；
选择想要检测的项目，此处以小企业的工作流项目为例；
点击编辑，进入任务编辑界面；
点击构建任务；
点击任务列表右侧“+号”，将SonarQube添加到任务列表中；
任务添加成功后默认排序在最下面，手动将SonarQube调整至Maven执行这一步的后面；
填写配置信息（后面具体介绍）；
点击保存，结束。

2.2 SonarQube相关属性说明

属性	是否必填	说明
标签		选择已配置好的标签
配置文件路径	是	sonar-project.properties,该文件默认路径为代码库全路径URL的根下，如果路径不同则需要配置正确路径
扫描项目路径		扫描项目的绝对路径，如果为空，则为工作空间根目录
参数		sonar运行参数
Sonar配置文件生成		sonar参数配置，优先级高于sonar配置文件
服务器	是	选择已有的SonarQube服务器
规则集	是	选择需要用到的规则，sonar会按照选择的规则执行扫描，如不选择，则使用默认的规则集：Java开发规范
质量表达式		如果为空，则不检查；否则进行指标检查，如果不达标，则任务执行失败，一般根据组织级质量目标确定
资源选择		选择要推送到的服务器资源
目标目录		选择要推送到的服务器资源下的路径

2.3 Sonar配置文件内容说明

#SonarQube平台中相对应项目的key，与Sonar.projectName保持一致（具体值可写工程名）
sonar.projectKey=test
#SonarQube平台中相对应项目的名字，与Sonar.projectKey保持一致（具体值可写工程名）
sonar.projectName=test
#SonarQube扫描的工程所在目录，是相对于sonar.properties的路径
sonar.projectBaseDir=trunk
#SonarQube工程显示版本号
sonar.projectVersion=1.0.0-SNAPSHOT
#扫描工程模块名称(多模块英文逗号分隔离)
sonar.modules=test,demo
#指定字符集
sonar.sourceEncoding=UTF-8
#Sonar检测的源文件目录
sonar.sources=src/main/java
#编译路径
sonar.java.binaries=target
#指定扫描语言类型
sonar.language=java
#Sonar检测的测试文件目录
sonar.tests=src/test
#检测中排除的源文件（排除的源文件不参与检测，一般排除单元测试文件、配置文件等）匹配0个或多个文件夹、匹配0个或多个字符该属性根据实际情况排除文件定义可用可不用）
sonar.exclusions=/test/*
#用来从覆盖率报告中排除的匹配方式
sonar.coverage.exclusions=/test/
#指定jacoco的exec二进制文件存放路径（已弃用），目前采用xml文件
#sonar.jacoco.reportPaths=target/jacoco.exec（已弃用）
#指定jacoco的xml文件存放路径
sonar.coverage.jacoco.xmlReportPaths=target/jacoco/jacoco.xml
#显示git提交人相关信息,如果是svn项目的，就改成svn
sonar.scm.provider=git
#显示git提交人相关信息
sonar.scm.disabled=false