使用 sonarqube 进行代码质量检查

Docker 环境准备

参考官方文档先对 Docker Server 进行参数调整

Because SonarQube uses an embedded Elasticsearch, make sure that your Docker host configuration complies with the Elasticsearch production mode requirements and File Descriptors configuration.

# root 身份运行
sysctl -w vm.max_map_count=524288
sysctl -w fs.file-max=131072
ulimit -n 131072
ulimit -u 8192

# 拉取镜像
docker pull sonarqube

# 启动容器
docker run -d --name sonarqube -e SONAR_ES_BOOTSTRAP_CHECKS_DISABLE=true -p 9000:9000 sonarqube:latest
1
2
3
4
5
6
7
8
9
10
11

基本配置

浏览器访问 Docker 服务器地址:9000, 默认账号密码 admin 登录后先修改密码后进入 Project 创建向导, 使用手动创建.

Analysis Method 使用 Locally

记下创建的 token, 后面会用到

Run analysis on your project 选择对应的语言和 OS, 访问 https://docs.sonarsource.com/sonarqube/10.2/analyzing-source-code/scanners/sonarscanner/ 下载 SonarScanner, 解压后将路径添加到系统的环境变量 PATH 中. 使用下面命令检查版本确认可以直接运行:

sonaer-scanner --version

INFO: Scanner configuration file: G:\Tools\sonar-scanner-5.0.1.3006-windows\bin\..\conf\sonar-scanner.properties
INFO: Project root configuration file: NONE
INFO: SonarScanner 5.0.1.3006
INFO: Java 17.0.7 Eclipse Adoptium (64-bit)
INFO: Windows 11 10.0 amd64
1
2
3
4
5
6
7

在项目根目录下执行 Run analysis on your project 提供的命令


等待扫描完成后 sonarqube 会自动跳转到报告界面

点击对应的分类可以查看具体到代码内容的详细说明