SonarQube安装文档

大的项目管理是困难的，所以需要借助一些工具去规范代码，扫描出代码潜在的缺陷。这方便SonarQube非常优秀，我们先介绍一下SonarQube检查功能：
1，不遵守代码标准（checkstyle）
2，潜在缺陷（空指针）
3，糟糕的复杂度（难以理解）
4，重复（通用的方法需要归纳封装）
5，糟糕的注释
7，糟糕的设计（耦合度检查）
需要用到的软件有：SonarQube,Sonar-scanner。SonarQube为代码检查的server,并提供可视化界面；Sonar-scanner为client。用于收集检查数据并且发送到server中。也就是传统的C/S关系:

C/S关系

首先在服务器上下载：

  链接：wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-7.2.zip 
  由于最新链接需要java11+，所以使用较新版本。7.2版本需要jdk1.8,jdk安装省略

创建sonar用户：

  sudo useradd sonar -m -s /bin/bash
  sudo passwd sonar

添加该用户权限:

vi /etc/sudoers
root  ALL=(ALL:ALL) ALL  
sonar  ALL=(ALL:ALL) ALL

启动sonar:

判断linux是32位还是64位：uname -a
cd /home/sonar/sonarqube-7.2/bin/linux-x86-64
普通启动：./sonar.sh console
后台启动：./sonar.sh start   
通过指令：netstat -tnlp     检查9000端口是否启动成功

进入ip+端口9000。使用admin/admin登录，成功之后显示警告：
Embedded database should be used for evaluation purpose only

警告图

配置数据库：

[sonar@node1 /]$ cd /home/sonar/sonarqube-7.2/conf
[sonar@node1 conf]$ vi sonar.properties
在“#----- MySQL >=5.6 && <8.0 ”下面添加：
sonar.jdbc.url=jdbc:mysql://ip:port/sonarqube?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&maxAllowedPacket=256000000(maxAllowedPacket为后续描述的那个bug所加)
sonar.jdbc.username=XXX
sonar.jdbc.password=XXX
重启之后警告消失，并且在sonarqube数据库会创建一些基础表

在线下载sonar-scan:

wget https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-2.8.zip
版本2.8.zip

配置scan：

在/etc/profile里添加：
#sonar-scanner profile   
export  
 SONAR_SCANNER_HOME=/home/sonar/sonar-scanner 
export  
 PATH=${SONAR_SCANNER_HOME}/bin:${PATH}
source /etc/profile

执行：sonar-scanner -v  
返回：
INFO: Scanner configuration file: /home/sonar/sonar-scanner/conf/sonar-scanner.properties
INFO: Project root configuration file: /home/sonar/lightkits-center-service/sonar-project.properties
INFO: SonarQube Scanner 2.8
INFO: Java 1.8.0_65 Oracle Corporation (64-bit)
INFO: Linux 3.10.0-327.18.2.el7.x86_64 amd64

在sonar-scanner的conf/sonar-scanner.properties关联对应的SonnarQube,为了实现上传操作:

sonar.host.url=http://ip:9000
sonar.login=admin
sonar.password=admin

至此scanner配置完成

在工程项目的一级目录添加文件sonar-project.properties，内容如下：

# must be unique in a given SonarQube instance
sonar.projectKey=lightkits-center-service
# this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1.
sonar.projectName=lightkits-center-service
sonar.projectVersion=master

# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
# This property is optional if sonar.modules is set. 
sonar.sources=./
sonar.language=java

# Encoding of the source code. Default is default system encoding
sonar.sourceEncoding=UTF-8
# Additional parameters  
sonar.my.property=value
sonar.java.binaries=**/classes

执行：
sonar-scanner -X
成功之后即可在SonarQube页面上浏览检查不过关的代码。

常见错误：
1,Packet for query is too large (9716496 > 4194304). You can change this value on the server by setting the max_allowed_packet' variable
解决办法：通过设置mysql的my.cnf,添加参数：max_allowed_packet=500M
重启mysql，运行指令：show VARIABLES like '%max_allowed_packet%
如果该值为500M，则修改成功。
最后在sonar的conf下连接jdbc的链接后加上maxAllowedPacket=500000000
问题圆满解决！！！

效果图：

效果图

扩展：

集成Jenkins:
       在jenkins服务器上安装客户端Sonar-Scanner并配置好环境变量。
       当jenkins自动部署项目完成之后触发逻辑：进入项目文件夹 ——> 执行指令：sonar-scanner

集成gitlab:
       通过git-runner执行脚本gitlab-ci.yml。当任意同事代码提交时直接触发gitlab-ci.yml。
       gitlab-ci.yml触发sonarQube代码检查脚本比如：进入项目文件夹 ——> 执行指令：sonar-scanner