sonarqube审查工具说明与安装

CodeReview能带来什么？
CodeReview能解决那些问题？
1、让个人变的优秀 ：程序猿成长的阶梯，促进工程师日常代码交流和快速稳步成长。

2、让团队变的强大：让新人密集型团队、创新型团队凝聚一股敦实的技术力量，有益于团队知识分享与合作，增加团队战斗力。

3、让公司IT技术稳健：为未来公司长远战略目标打下夯实的技术基石。

CodeReview能解决那些问题？
1、生产服务不稳定，火灾频繁。

2、代码债务重，后续入职人员将错就错，项目不受控。

3、bug依赖测试团队发现，质量和效率低下。

4、团队成员年轻，水平参差不齐。项目急任务重没有时间。

1、sonarqube是什么？

SonarQube 官网：https://www.sonarqube.org/

Sonar (SonarQube)是一个开源平台，用于管理源代码的质量。 Sonar 不只是一个质量数据报告工具，更是代码质量管理平台。 支持java, JavaScrip, Scala 等等二十几种编程语言的代码质量管理与检测。 SonarQube®是一种自动代码审查工具，用于检测代码中的错误，漏洞和代码异味。它可以与您现有的工作流程集成，以便在项目分支和拉取请求之间进行连续的代码检查。

image

2.持续集成

image.png

1、在IDE中使用sonarlint插件运行本地分析

2、开发者将代码提交到scm工具中

3、持续集成工具自动触发检查代码执行SonarQube Scanner 运行sonarqube分析

4、分析报告传递给sonarqube server进行加工处理

5、进行处理分析、将数据保存到数据库中、将效果通过ui展示出来

6、开发者通过sonarqube ui查看自己的bug和技术债等

7、项目经理、运维经理、测试经理、开发人员通过代码报表进行查看管理

2、windows如何安装

步骤一：准备工作

1、jdk1.8、maven-3.6.0

2、sonarqube下载地址：

https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-7.6.zip

3、Sonar Scanner扫描下载

https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-3.3.0.1492-windows.zip

4、mysql数据库（5.7）

步骤二：sonarqube安装和配置篇

1、下载好sonarqube后，解压打开bin目录，启动相应OS目录下的StartSonar。如本文演示使用的是win的64位系统，则打开E:\sonar\sonarqube-7.6\bin\windows-x86-64\StartSonar.bat

image

2.启动浏览器，访问http://localhost:9000，如出现下图则表示安装成功。

image

3、修改sonar.properties文件，添加mysql连接信息配置。E:\sonar\sonarqube-7.6\conf\sonar.properties【url是数据库连接地址，username是数据库用户名，jdbc.password是数据库密码，login是sonarqube的登录名，sonar.password是sonarqube的密码】

//数据库地址

sonar.jdbc.url=jdbc:mysql://10.10.8.31:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance

sonar.jdbc.username=sonar

sonar.jdbc.password=sonar

sonar.sorceEncoding=UTF-8

//sonar登录用户

sonar.login=admin

sonar.password=admin

4、重启sonarqube服务，再次访问http://localhost:9000，会稍微有点慢，因为要初始化数据库信息。windows重启方法：在资源管理器中关闭所有的java.exe进程，然后重新运行StartSonar.bat文件；访问地址进行登录，初始的账号密码是：admin/admin，数据库有初始化的表信息。

image

image

5、插件安装chinese Pack，安装中文语言包

image

6、安装好插件重启sonar，登录后如下

image

步骤三：sonar-scanner安装和配置篇

1、解压sonar-scanner，配置环境变量

A：新建环境变量：SONAR_SCANNER_HOME、值：E:\sonar\sonar-scanner-3.3.0.1492

B：打开path，添加%SONAR_SCANNER_HOME%\bin;

C：cmd进入，输入sonar-scanner -v 出现如下为设置成功

2、修改settings.xml文件，E:\CFS\outTool\apache-maven-3.6.0\conf\settings.xml

    org.sonarsource.scanner.maven

        sonar

        

            true

        

        

          jdbc:mysql://10.10.8.31:3306/sonar

            com.mysql.jdbc.Driver

            sonar

            sonar

            http://10.10.7.67:9000/

        

    

3、项目maven Reimport后，必须编译项目后才能分析target目录下class文件。执行clean install sonar:sonar，进行代码扫描分析

A：idea中配置快捷键

image

B：项目控制台出现如下为分析执行完毕

image

4、刷新 http://localhost:9000 ，点击项目模块出现如下分析结果

image

前端代码检查

项目根目录新增配置文件：sonar-project.properties

配置详细：

must be unique in a given SonarQube instance

sonar.projectKey=Artemis-front

this is the name displayed in the SonarQube UI

sonar.projectName=Artemis-front

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=.

在根目录运行命令：sonar-scanner