使用sonarqube进行代码review

在一个项目组或者整个公司的开发当中，由于开发人员的开发能力不同，写出的代码或多或少或有很大的差异。并且会不经意间留下很多bug。 如果每周都花时间去看所有人员的编码质量将会是一件非常吃力的事儿，项目经理基本会给累死。所以我们得借助工具。现在市面上代码质量监测工具有很多，今天就来看一下其中比较出名的SonarQube在检查Java项目代码中的使用。

由于sonarqube企业版收费，且高版本的对mysql的兼容不好，今天就以sonarqube6.7.7社区版为例来进行一次代码质量检查。

首先下载安装包，官方下载页面：https://www.sonarqube.org/downloads/

找到下载入口，直接点击下载 ，如下：

然后将下载好的zip包解压到一个文件夹，进入conf目录，进行相关属性的配置：

这里主要配置数据库。为了方便我们使用mysql数据来存放代码扫描的结果，在sonar.properties文件中做如下配置：

# User credentials.
# Permissions to create tables, indices and triggers must be granted to JDBC user.
# The schema must be created first.
#sonar.jdbc.username=
#sonar.jdbc.password=
sonar.jdbc.username=root
sonar.jdbc.password=123456
#----- Embedded Database (default)
# H2 embedded database server listening port, defaults to 9092
#sonar.embeddedDatabase.port=9092

#----- MySQL 5.6 or greater
# Only InnoDB storage engine is supported (not myISAM).
# Only the bundled driver is supported. It can not be changed.
#sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false

说明：
1 要在你配置的数据库中新建名为sonar（名字可以自定义）的数据库
2 你的机器要有Java环境，我这里是Java1.8.0_231。如果你想自己指定Java，可以在wrapper.conf文件中配置，这里就不做说明了

然后执行命令：C:\softwares\sonarqube-6.7.7\bin\windows-x86-64\StartSonar.bat启动sonar

出现如下画面表示成功启动：

启动成功后它会给你在sonar数据库中自动创建所有它需要用到的表，如下：

然后访问默认的管理界面：http://localhost:9000/
默认的账户和密码为 ： admin / admin

登录成功之后会有弹出框：

然后输入自己的标识，点击生产一个专属的身份认证token：

然后选择自己的项目类型，我这边选择Java + maven

完成以上步骤后，它给你生成好了检查代码的脚本，选择copy，存下来 。

mvn sonar:sonar -Dsonar.host.url=http://localhost:9000 -Dsonar.login=d4c8e91fadc7c69d60a308db421cbb31cfa2d68c

然后到你的项目根目录中，打开git Bash命令框。执行刚生产的命令 ；等待命令执行完成后，再去http://localhost:9000页面，刷新一下，会发现会出一下刚才扫描的项目结果。如下：

然后查看扫描出的bug和一些不规范的编码：

然后就可以开始修复bug和优化编码规范了。

其实sonarqube可以安装很多有用的插件，比如SQL检查，以及阿里的P3C规范检查等等，还可以自定义检查的规则。

在线安装插件：

好啦，师傅领进门，修行在个人，sonarqube检查代码的基本流程就到这啦。对于bug的处理与追踪，即落地到项目组或者整个公司还是有一定的难度，深入的使用和一些高级用法有兴趣的话去他们官方文档里面去翻吧。