一、什么是SonarQube
SonarQube是一个用于代码质量管理的开源平台,它可以帮助开发团队检测和解决代码中的缺陷、漏洞和代码异味。
二、如何安装SonarQube
步骤 1: 安装和配置Java
确保系统上安装了Java,SonarQube需要Java 11或以上版本。你可以从Oracle或OpenJDK下载并安装。
(注:最新10.3版本需要java17,java11已弃用,同时要保证环境变量中配置好了其路径)
检查Java版本:
bash
java -version
步骤 2: 下载和解压SonarQube
- 到 [SonarQube下载页面](Download | SonarQube | Sonar (sonarsource.com)),下载最新版本的SonarQube。
- 将下载的压缩包解压到你想要安装的目录,例如
C:\sonarqube
.
步骤 3: 配置SonarQube
编辑SonarQube的配置文件:
在SonarQube的安装目录下,找到 conf
文件夹,编辑 sonar.properties
文件。
找到并修改以下行,确保数据库连接设置正确:
properties
sonar.jdbc.url=jdbc:postgresql://localhost/<数据库名称>
sonar.jdbc.username=<数据库用户名>
sonar.jdbc.password=<数据库密码>
步骤 4: 安装和配置数据库(可选)
如果你选择使用PostgreSQL作为SonarQube的数据库,你可以从[PostgreSQL官网](PostgreSQL: Downloads)下载并安装。创建数据库和用户的步骤与Linux相似。 (注:推荐版本请参考SonarQube官网要求:Prerequisites and overview (sonarsource.com))
在pgAdmin中:
- 新建角色sonar:
权限设置为可登录即可,然后保存 2. 新建sonar数据库:
- 同时在sonar.properties配置:
步骤 5: 启动SonarQube服务
打开命令行窗口,进入SonarQube的安装目录,执行以下命令启动SonarQube服务:
bash
C:\yours\bin\windows-x86-64\StartSonar.bat
也可以直接到对应目录下运行StartSonar.bat批处理文件:
等待SonarQube启动完成,然后通过浏览器访问 http://localhost:9000
。默认登录凭据是admin/admin。
步骤 6: 配置SonarScanner
- 到 [SonarScanner下载页面](SonarScanner CLI (sonarsource.com)) 下载最新版本的SonarScanner,可根据自己的需要下载Maven、Ant等类型版本。
- 将下载的压缩包解压到你想要安装的目录,例如
C:\sonar-scanner
.
编辑SonarScanner的配置文件:
在SonarScanner的安装目录下,找到 conf
文件夹,编辑 sonar-scanner.properties
文件。
配置SonarQube服务器的地址:
properties
sonar.host.url=http://localhost:9000
3. 配置其环境变量:
检验配置是否正确:
bash
sonar-scanner -v
步骤 7: 执行代码分析 在你的项目根目录新建文件:
启动SonarQube之后,在我的账户中生成令牌:
配置文件内容:
在项目根目录下执行以下命令进行代码分析:
bash
C:\your-project sonar-scanner
(或者直接在项目根目录下打开cmd) 之后访问本地9000端口即可查看扫描的项目: