SonarQube安装和应用指南

1  所需工具

（1）openjdk-11.0.2_windows-x64_bin.zip

（2）postgresql-13.3-2-windows-x64.exe

（3）sonarqube-8.9.0.43852.zip（LTS版本）

（4）sonar-scanner-cli-4.6.2.2472-windows.zip

（5）sonar-cxx-plugin-2.0.1.2678.jar（C++插件）

（6）sonar-l10n-zh-plugin-8.9.jar（语言包插件）

（7）cppcheck-2.5-x64.exe

2  安装过程

2.1  安装和配置OpenJDK

（1）解压openjdk-11.0.2_windows-x64_bin.zip到安装目录，建议C盘根目录。

（2）配置系统环境变量。

添加JAVA_HOME，“C:\jdk-11.0.2”；

添加CLASS_PATH，“.;%JAVA_HOME%\lib\dt.jar;%JAVA_HOME%\lib\tools.jar”；

Path中添加“%JAVA_HOME%\bin”,“%JAVA_HOME%\jre\bin”

1. 在PowerShell中使用java --version测试配置结果。

2.2  安装和配置PostgreSQL

（1）点击安装包进行安装。

（2）配置系统环境变量

添加PG_HOME，“C:\Program Files\PostgreSQL\13”

Path中添加“%PG_HOME%\bin”

添加PGDATA，“d:\PG_DATA”

（3）PostgreSQL初始化

运行initdb.exe，执行完成后，会在d:\PG_DATA生成文件。

1. 启动PostgreSQL

运行postgre.exe -D “D:\PG_DATA”，或者运行pg_ctl start -D “D:\PG_DATA”,启动PostgreSQL。

1. 使用客户端pgAdmin创建SonarQube数据库

打开pgAdmin，设置初始密码。

创建新用户user，非管理员，设置密码。

添加新数据库sonarqube。

1. 测试数据库连接

使用SQL Shell(pgsql）进行连接测试。

数据库配置步骤参考Windows 10 安装配置连接PostgreSQL教程_技术宅星云-CSDN博客-CSDN博客

2.3  安装SonarQube

（1）解压sonarqube-8.9.0.43852.zip和sonar-scanner-cli-4.6.2.2472-windows.zip到D盘。

（2）Path环境变量中添加“D:\sonarqube-8.9.0.43852\bin\windows-x86-64”、“D:\sonarqube-8.9.0.43852\lib”、“D:\sonar-scanner-4.6.2.2472-windows\bin”。

（3）修改sonar.properties文件：

sonar.jdbc.username=user

sonar.jdbc.password=********

sonar.jdbc.url=jdbc:postgresql://localhost/sonarqube?currentSchema=public

（4）将插件sonar-cxx-plugin-2.0.1.2678.jar和sonar-l10n-zh-plugin-8.9.jar放在\extensions\plugins下。

（5）启动PostgreSQL（见上节），在Powershell中输入StartSonar.bat启动SonarQube服务。

（6）在浏览器中输入localhost:9000测试SonarQube是否能够访问。

2.4  配置SonarQube

（1）配置CXX文件扫描类型

点击“配置”->“通用配置”->“CXX”，在File suffixes中添加文件后缀，常用后缀如cpp,cxx,c,h,hpp等。

（2）创建C++质量配置

点击“质量配置”，可以看到多种语言的配置，用于规则检查。

点击“创建”，设置名称，如“CXX_USER”，选择语言为CXX。

在质量配置界面，点击CXX_USER后的齿轮，点击“激活”。在规则激活界面中，点击“批量修改”，激活所有规则。

2.5  安装CPPCheck

使用安装包安装CPPCheck，并添加Path环境变量，“C:\Program Files\Cppcheck”。

3  SonarQube使用

1. 在PowerShell窗口输入命令，启动PostgreSQL；
2. 新建PowerShell窗口输入命令，启动SonarQube；如果是重新启动SonarQube，需要先在任务管理器中关闭所有的JDK进程。
3. 在浏览器中输入localhost:9000，登录。
4. 在“项目”中，点击“新增项目”->“手工”。
5. 添加项目标识。
6. 创建令牌，并记住令牌。
7. 在分析你的项目中，构建技术选择“其他”，操作系统选“Windows”，会自动生成扫描命令。
8. 在Powershell中切换到代码目录下，执行生成的命令，即可对代码进行静态检查。检查结果会在浏览器界面刷新并显示。