jdk的版本需要和Sonar版本一致（32bit或者都是64bit）

[原]代码审查工具Sonar（一）-- 简介与安装

代码审查是持续集成理论里重要的一部分。审查软件和测试软件之间存在着微妙的差别。测试是动态的，它执行软件，目的是测试软件的功能。审查则基于一 组预先定义的规则分析代码。审查也不同于编译。编译是从语法的角度来检查代码，审查则是从语法以外的角度着手，例如，编码风格，编码规范，重码率，复杂 度，代码注释率等等。众所周知，编译正确的代码不一定就没有问题，那么除了测试人员从运行整个软件的角度来排查功能点，从源代码分析的角度找到潜在的问题 点也是一项重要的补充工作。Sonar（也叫SonarQube）就是一款优秀的代码审查工具。其官网地址：

下图展示的是Sonar的架构。

最上面一层代表输入，也就是我们要检查的源代码。这些源代码可以是Java代码, Cobol代码，C#代码等。目前Sonar支持对20多种语言的源代码的检查。

中间一层有两部分，右边绿色方框标记的"Eclipse"是指Sonar针对Eclipse的插件，方便用户在Eclipse里直接进行与Sonar相关的操作。这部分不在本文的讨论范围之内。

中间层的左边是Analysers，指的是进行代码分析的程序，统称为plugin。这些程序既包括Sonar自己提供的分析程序，也包括第三方的 分析程序，例如，针对C++代码，有Sonar的程序检查代码行数，重码率，注释率，也有做静态检查的第三方工具cppcheck，做运行时内存检测的 Valgrind，做风格检查的Vera++，以及做安全性检查的RATS等。所有这些工具将检查结果生成xml格式的report，由sonar程序读 取到数据库中，也就是第三层左边的database。

在第三层，Sonar的web应用程序读取database里的代码检查结果，并以丰富的图像界面形式呈现在用户面前。Sonar有相当数量的plugin是与界面效果相关的。

通过Sonar进行一次代码审查的过程就是从第一层开始，沿着箭头一直行进到Server呈现部分结束的工作流程。

下面介绍Sonar server的安装：

1. 安装database

Sonar自带一个简易的database，如果是想真正将Sonar投入项目使用，而不是实验性的在本地操作一下，最好安装专门的数据库。我们选择的是免费的mysql版本。

在安装目录/bin/windowsxxxxx下运行：mysqld --install 将mysql安装为windows service，在service列表里start mysql service。

运行：mysql -u root，进入mysql client

运行下面的命令行创建database sonar并创建用户sonar，密码sonar

create user 'sonar'@'localhost' identified by 'sonar';

create database sonar;

grant all privileges on *.* to 'sonar'@'localhost';

2. 安装Sonar server

需要先安装JDK6或7

然后下载并解压Sonar包即可。 选择download最新的SonarQube。

3. 修改配置文件

<install_directory>/conf/sonar.properties，重点打开注释（删除行首的#符号）并修改下面几个部分：

a. web settings->sonar.web.host/port/context

b. sonar.jdbc.url，因为我安装的是mysql，所以将原本打开的h2行注释掉，将mysql的部分打开。

<install_directory>/conf/wrapper.conf, 因为安装的是JDK，将wrapper.java.additional.4=-server行首的注释符号 # 删掉

4. 运行<install_directory>/bin下的InstallNTService.bat可以将sonar安装为windows service，如果开启service有任何问题，应该在命令行窗口中手工运行StartSonar.bat来查看问题点，并参考<install_directory>/logs里的日志文件。

5. 安装analyser，这个要根据语言来选择。详情可参见

例如：C#代码推荐sonar runner，而C++代码推荐maven。因为笔者要分析的是C#代码，因此下面介绍sonar runner的安装方法。

a. 登录sonar，缺省的管理员账号是admin/admin，选择Update Center->Available Plugins->C#和.NET

b.安装C#代码的第三方分析器，安装列表详见

c. 安装sonar runner。

d. 创建环境变量SONAR_RUNNER_HOME用来指向sonar runner的安装目录。把<install_directory>/bin加到环境变量path中去。

e. 修改sonar runner安装目录下的配置文件<install_directory>/conf/sonar-runner.properties，删除对应database行首的#，在本例中是mysql行。打开sonar.host.url行的注释。

f. 如果能在cmd窗口中正确运行sonar-runner -h则表示sonar-runner安装配置成功。

中文插件

SonarQube为静态代码检查工具，帮助检查代码缺陷，改善代码质量，提高开发速度，通过系列使用经验分享给小伙伴们！

我们已经介绍过如何安装了，现在我们来介绍如何分析，分析和安装一样简单

【三】安装中文插件

工具/原料

中文语言插件

方法/步骤

1.进入插件下载页面

2.找到Localization---chinese 点击

中文插件下载页面

注意，选择插件一定要对应好版本

如4.3的sonar，就选用4.1+的插件版本

点击Download 开始下载

下载后，放入sonar目录如下

sonarqube-4.3\extensions\plugins

重启Sonar，打开页面

END

注意事项

插件复制进去后一定要重启，才能看到效果哦

linux版本安装

SonarQube代码质量管理平台安装与使用

Sonar简介

　　Sonar是一个用于代码质量管理的开源平台，用于管理源代码的质量，可以从七个维度检测代码质量

　　通过插件形式，可以支持包括java,C#,C/C++,PL/SQL,Cobol,JavaScrip,Groovy等等二十几种编程语言的代码质量管理与检测sonarQube能带来什么？

　　Developers' Seven Deadly Sins

　　1.糟糕的复杂度分布

　　文件、类、方法等，如果复杂度过高将难以改变，这会使得开发人员难以理解它们，且如果没有自动化的单元测试，对于程序中的任何组件的改变都将可能导致需要全面的回归测试

　　2.重复

　　显然程序中包含大量复制粘贴的代码是质量低下的sonar可以展示源码中重复严重的地方

　　3.缺乏单元测试

　　sonar可以很方便地统计并展示单元测试覆盖率

　　4.没有代码标准

　　sonar可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具规范代码编写

　　5.没有足够的或者过多的注释

　　没有注释将使代码可读性变差，特别是当不可避免地出现人员变动时，程序的可读性将大幅下降

　　而过多的注释又会使得开发人员将精力过多地花费在阅读注释上，亦违背初衷

　6.潜在的bug

　　sonar可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具检测出潜在的bug

　　7.糟糕的设计（原文Spaghetti Design，意大利面式设计）

　　通过sonar可以找出循环，展示包与包、类与类之间的相互依赖关系

　　可以检测自定义的架构规则

　　通过sonar可以管理第三方的jar包

　　可以利用LCOM4检测单个任务规则的应用情况

　　检测耦合

　　关于Spaghetti Design：

　　通过sonar可以有效检测以上在程序开发过程中的七大问题

　　SonarQube安装

　　预置条件

　　1.已安装JAVA环境

　　2.已安装有MySQL数据库

　　软件下载地址：

　　下载SonarQube与SonarQube Runner

　　中文补丁包下载：

　　1.数据库配置

　　进入数据库命令

#mysql -u root -p

mysql> CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;

mysql> CREATE USER 'sonar' IDENTIFIED BY 'sonar';

mysql> GRANT ALL ON sonar.* TO 'sonar'@'%' IDENTIFIED BY 'sonar';

mysql> GRANT ALL ON sonar.* TO 'sonar'@'localhost' IDENTIFIED BY 'sonar';

mysql> FLUSH PRIVILEGES;

　　2.安装sonar与sonar-runner

　　将下载的sonarqube-7.0.zip包解压至Linux某路径如/app/export/servers/sonar/

　　将下载的sonar-runner-2.4zip包解压某路径/app/export/servers/sonar/

注意：此版本需要mysql5.6以上版本支持

　　添加SONAR_HOME、SONAR_RUNNER_HOME环境变量，并将SONAR_RUNNER_HOME加入PATH

　　修改sonar配置文件

　　编辑<install_directory>/conf/sonar.properties文件，配置数据库设置，默认已经提供了各类数据库的支持

　　这里使用mysql，因此取消mysql模块的注释

字体: 小 中 大 | 上一篇 下一篇 | 打印 | 我要投稿

#vi sonar.properties

sonar.jdbc.username: sonar

sonar.jdbc.password: sonar

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

# Optional properties

sonar.jdbc.driverClassName: com.mysql.jdbc.Driver

　　修改sonar-runner的配置文件

　　切换至sonar-runner的安装目录下，修改sonar-runner.properties

　　根据实际使用数据库情况取消相应注释

#Configure here general information about the environment, such as SonarQube DB details for example

#No information about specific project should appear here

#----- Default SonarQube server

sonar.host.url=

#----- PostgreSQL

#sonar.jdbc.url=jdbc:postgresql://localhost/sonar

#----- MySQL

sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8

#----- Oracle

#sonar.jdbc.url=jdbc:oracle:thin:@localhost/XE

#----- Microsoft SQLServer

#sonar.jdbc.url=jdbc:jtds:sqlserver://localhost/sonar;SelectMethod=Cursor

#----- Global database settings

sonar.jdbc.username=sonar

sonar.jdbc.password=sonar

#----- Default source code encoding

sonar.sourceEncoding=UTF-8

#----- Security (when 'sonar.forceAuthentication' is set to 'true')

sonar.login=admin

sonar.password=admin

　　3.添加数据库驱动

　　除了Oracle数据库外，其它数据库驱动都默认已经提供了，且这些已添加的驱动是sonar唯一支持的，因此不需要修改

　　如果是Oracle数据库，需要复制JDBC驱动至<install_directory>/extensions/jdbc-driver/oracle目录

　　4.启动服务

　　目录切换至sonar的<install_directory>/bin/linux-x86-64/目录，启动服务

　　#./sonar.sh start 启动服务

　　#./sonar.sh stop 停止服务

　　#./sonar.sh restart 重启服务

注意：

1、先执行sudo chown -R mysql.mysql /app/export/servers/mysql/

2、用非root用户(admin)启动

　　至此，sonar就安装好了

　　访问http:\\localhost:9000即可

　　5.sonar中文补丁包安装

　　中文包安装

　　安装中文补丁包可以通过访问http:\\localhost:9000，打开sonar后，进入更新中心安装Chinese Pack

　　或者下载中文补丁包后，放到SONARQUBE_HOME/extensions/plugins目录，然后重启SonarQube服务　sonar作为Linux服务并开机自启动

　　新建文件/etc/init.d/sonar，输入如下内容：

#!/bin/sh

#

# rc file for SonarQube

#

# chkconfig: 345 96 10

# description: SonarQube system ()

#

### BEGIN INIT INFO

# Provides: sonar

# Required-Start: $network

# Required-Stop: $network

# Default-Start: 3 4 5

# Default-Stop: 0 1 2 6

# Short-Description: SonarQube system ()

# Description: SonarQube system ()

### END INIT INFO

/usr/bin/sonar $*

　　SonarQube开机自启动（Ubuntu, 32位）：

　　sudo ln -s $SONAR_HOME/bin/linux-x86-32/sonar.sh /usr/bin/sonar

　　sudo chmod 755 /etc/init.d/sonar

　　sudo update-rc.d sonar defaults

　　SonarQube开机自启动（RedHat, CentOS, 64位）：

　　sudo ln -s $SONAR_HOME/bin/linux-x86-64/sonar.sh /usr/bin/sonar

　　sudo chmod 755 /etc/init.d/sonar

　　sudo chkconfig --add sonar

　　使用SonarQube Runner分析源码

　　预置条件

　　已安装SonarQube Runner且环境变量已配置，即sonar-runner命令可在任意目录下执行

　　1.在项目源码的根目录下创建sonar-project.properties配置文件

　　以android项目为例：

sonar.projectKey=android-sonarqube-runner

sonar.projectName=Simple Android project analyzed with the SonarQube Runner

sonar.projectVersion=1.0

sonar.sources=src

sonar.binaries=bin/classes

sonar.language=java

sonar.sourceEncoding=UTF-8

sonar.profile=Android Lint

　　注：要使用Android Lint

　　规则分析需要先访问http:\\localhost:9000更新中心添加Android Lint插件，使其可以分析Android Lint规则

　　2.执行分析

　　切换到项目源码根目录，执行命令

　　# sonar-runner

　　分析成功后访问http:\\localhost:9000即可查看分析结果

　　不同参数的意思：

　　不同项目的源码分析示例下载：