Mac安装SonarQube教程

小鱼儿 2022-11-30 12:45 944阅读 0赞

#### 一、SonarQube简介 ####

SonarQube是管理代码质量的开放平台，可以快速的定位代码中潜在的或明显的错误。  
SonarQube具备的功能：

1.  不遵守代码标准（checkstyle）
2.  潜在缺陷（空指针）
3.  糟糕的复杂度（难以理解）
4.  重复（通用的方法需要归纳封装）
5.  糟糕的注释
6.  糟糕的设计（耦合度检查）

SonarQube属于代码检查的server端，并提供可视化界面；Sonar-Scanner属于client端。用于收集检查数据并且发送到server中。也就是传统的C/S关系  
![在这里插入图片描述][format_png_pic_center]

#### 二、版本和下载地址 ####

SonarQube: **7.6**  
下载sonarqube的地址: [https://binaries.sonarsource.com/Distribution/sonarqube/][https_binaries.sonarsource.com_Distribution_sonarqube]

Sonar-Scanner: **sonar-scanner-3.3.0.1492-macosx**  
下载sonar-scanner的地址：[https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/][https_binaries.sonarsource.com_Distribution_sonar-scanner-cli]

JDK: **1.8**

#### 三、安装及使用步骤 ####

1、下载SonarQube和Sonar-Scanner的安装包，并解压到某一路径下  
2、配置环境变量

vi ~/.bash_profile
    
    export SONAR_HOME=/Users/xiaoxiaoping/work_software/sonarqube-7.6
    export PATH=$PATH:$SONAR_HOME/bin
    export SONAR_SCANNER_HOME=/Users/xiaoxiaoping/work_software/sonar-scanner-3.3.0.1492-macosx
    export PATH=$PATH:$SONAR_SCANNER_HOME/bin
    
    source ~/.bash_profile

⏰：完成环境变量配置后，请自行验证一下是否成功  
3、启动SonarQube  
（1）进入到SonarQube解压文件的bin/macosx-universal-64目录下（**因为我是mac系统，所以使用macosx-universal-64下的启动脚本，Linux和Windows可使用对应目录下的启动脚本**)

cd /Users/xiaoxiaoping/work_software/sonarqube-7.6/bin/macosx-universal-64

（2）启动/停止/重启服务

./sonar.sh start
    ./sonar.sh stop
    ./sonar.sh restart

4、打开默认网址：http://localhost:9000 默认登录账号密码：admin／admin  
5、默认Sonar的前端页面是英文的，可汉化（**自行百度**）  
6、在需要使用Sonar的项目根目录下，创建一个新文件：sonar-project.properties  
![在这里插入图片描述][20200824155046147.png_pic_center]  
**sonar-project.properties**

# must be unique in a given SonarQube instance
    sonar.projectKey=my:project
    # this is the name displayed in the SonarQube UI
    sonar.projectName=jacocotest
    sonar.projectVersion=1.0
    # Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
    # Since SonarQube 4.2, this property is optional if sonar.modules is set.
    # If not set, SonarQube starts looking for source code from the directory containing
    # the sonar-project.properties file.
    sonar.sources=src
    # Encoding of the source code. Default is default system encoding
    #sonar.sourceEncoding=UTF-8
    #path to your project build output path
    sonar.java.binaries=target/classes

7、按照步骤三中(2)重启SonarQube，**打开一个终端**，进入到项目根目录，执行`sonar-scanner`，进行代码审查，等待审查结果  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDUxNDYwMA_size_16_color_FFFFFF_t_70_pic_center]  
8、登录 http://localhost:9000 查看结果

[format_png_pic_center]: /images/20221123/20cd0462b979450a9eee876fcaa695c5.png
[https_binaries.sonarsource.com_Distribution_sonarqube]: https://binaries.sonarsource.com/Distribution/sonarqube/
[https_binaries.sonarsource.com_Distribution_sonar-scanner-cli]: https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/
[20200824155046147.png_pic_center]: /images/20221123/ba234ebf22cc40159eecf62c0738c5c6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDUxNDYwMA_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/3848cfaa1d9e4d3aaf92d4ac208bbd3f.png