sonar-scanner

sonar-scanner #

scanners 作用 #

即扫描器。通过 maven、gradle、命令行 等方式,扫描本地项目,上传扫描结果到服务端。

服务端相关内容,请查看这篇文章: ../deploy/sonarqube.md

命令行scanner的安装与使用 #

安装方式一:官网下载zip #

下载地址,请查看官网: https://docs.sonarsource.com/ 位置:Analyzing source code > Scanners > SonarScanner

解压到自定义目录,然后添加bin目录路径到PATH环境变量中。

安装方式二:scoop安装 #

ps1
# scoop安装的命令是 sonar-scanner.cmd,官网的是 sonar-scanner.bat,后缀名不一样。
scoop install sonar-scanner

使用方式 #

服务端创建项目后,可直接复制命令到本地执行(默认只包含 sonar.projectKey、sonar.sources、sonar.login 这3个属性,最好再手动加上 sonar.projectName、sonar.projectVersion 这两个属性)。

以下是命令基本格式:

ps1
sonar-scanner.cmd -D"sonar.projectKey=......" -D"sonar.sources=." -D"sonar.host.url=https://......" -D"sonar.login=......" -D"sonar.projectName=......" -D"sonar.projectVersion=main"

1)sonar.projectKey属性用来指定服务器上创建的项目标识。 2)sonar.sources属性用来指定当前项目路径。 3)sonar.projectName属性用来指定当前项目名称,默认是maven项目名称(不是maven的话则默认取项目标识),这里取个项目中文名就行。 4)sonar.projectVersion属性用来指定当前项目版本,默认是not provided,这里随便取个值就行,比如main

这些属性是各个scanner通用的。 更多属性,请查看官网: https://docs.sonarsource.com/ 位置:Analyzing source code > Analysis parameters

2025年1月15日