SonarQube代码评审工具简介

SonarQube是一个代码评审工具，可以完成对多种类型代码的扫描，并生成报告。本文是一个简单的扫描Java代码的使用说明。

 

该工具主要分为两个部分：

服务端：用来保存和展示扫描结果。

客户端：或者说Scanner，用来直接对代码进行扫描，并把相关数据发送给服务端。

 

客户端有多种存在形式，可以以单独的软件存在，可以以Jenkins中的插件存在，还可以直接在maven中集成。

 

使用说明

一、服务端

服务端使用比较简单，这里以windows环境为例

0、下载sonarqube，这里下的是7.7版的，解压后：

 

1、进入上图的conf目录，编辑sonar.properties，配置sonarqube的数据库，这里用的是mysql，如下图：

注意这里对mysql版本的要求。

另外sonar默认端口是9000，如果要改端口可以对配置文件中的以下内容进行修改：

　　#sonar.web.port=9000

 

之后浏览器里访问本地的9000端口，账号密码都是admin，可以看到sonar的界面。

 

2、启动sonarqube

 bin目录下找到windows相关文件夹，双击StartSonar.bat即可

 

 

二、客户端

客户端这里我们使用的是maven插件。

1、在pom中增加插件相关依赖：

    <profiles>
        <profile>
            <id>sonar</id>
            <properties>
                <sonar.host.url>
                    http://localhost:9000
                </sonar.host.url>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
    </profiles>

    <build>
        <plugins>
            <!--代码审查插件-->
            <plugin>
                <groupId>org.sonarsource.scanner.maven</groupId>
                <artifactId>sonar-maven-plugin</artifactId>
                <version>3.3.0.603</version>
            </plugin>
        </plugins>
    </build>

profile中配置的是sonar服务端的地址，插件其实就是sonar的scanner

 

2、在pom所在目录下执行命令：

mvn clean verify -P sonar sonar:sonar

 

等命令执行完毕后，可以去localhost:9000去查看结果。

 

（完毕）