1. SonarQube 是什么

SonarQube 它是用来检测我们的代码质量的工具（类似于ESLint）

2. 服务端安装

文档

官方提供了两种安装方式

  1. 下载压缩包（较复杂）
  2. 通过 Docker 安装（简单）

2.1. 方式一

  1. 下载压缩包
    下载社区版即可
    SonarQube 安装 - 图1
  2. 用非 root 用户将其解压
  3. 检查执行环境
    • 确认 Java 版本（最低要求Java11版本），如果没有安装进行安装即可（安装教程参考 Linux - 常用工具安装）
  4. 启动 sonarqube
  1. # 注意目录以你的实际位置为准
  2. $ cd sonarqube-8.1.0.31237/bin/linux-x86-64/
  3. # 第一次启动建议用 console，它可以将启动日志打印出来，方便检查错误
  4. $ ./sonar.sh console

遇到了一个错误：java.lang.IllegalStateException: Future got interrupted 暂时不知道怎么解决

2.2. 方式二

通过 Docker 安装，关于 Docker 的安装方式可以参考：Linux-常用工具安装

  1. 安装 sonarQube

    1. $ docker run -d --name sonarqube -p 9000:9000 sonarqube

  2. 启动成功后访问 9000 端口
    SonarQube 安装 - 图2

  3. 登录（默认账号密码都为 admin）
  4. 创建项目
    • 点击右上角加号

SonarQube 安装 - 图3

  • 输入名称
  • 输入token
  • 点击继续

SonarQube 安装 - 图4

  • 设置语言，选择其他
  • 选择操作系统，选择Linux（客户端）
  • 点击下载
    SonarQube 安装 - 图5
  • 按照需要下载对应版本就可以
  • 在你的项目根目录创建 sonar-scanner.properties 配置文件，并按照官方文档进行配置
  • 将 sonar-scanner 配置在全局变量中
  • 在项目目录下运行 $ sonar-scanner 生成报告
  • 执行完成后在返回服务端页面，点击项目就能看到报告了

3. 客户端安装及配置说明

客户端用于生成代码的检测报告

文档