SonarQube代碼評審工具簡介

SonarQube是一個代碼評審工具，能夠完成對多種類型代碼的掃描，並生成報告。本文是一個簡單的掃描Java代碼的使用說明。

 

該工具主要分爲兩個部分：

服務端：用來保存和展現掃描結果。

客戶端：或者說Scanner，用來直接對代碼進行掃描，並把相關數據發送給服務端。

 

客戶端有多種存在形式，能夠以單獨的軟件存在，能夠以Jenkins中的插件存在，還能夠直接在maven中集成。

 

使用說明

1、服務端

服務端使用比較簡單，這裏以windows環境爲例

0、下載sonarqube，這裏下的是7.7版的，解壓後：

 

一、進入上圖的conf目錄，編輯sonar.properties，配置sonarqube的數據庫，這裏用的是mysql，以下圖：

注意這裏對mysql版本的要求。

另外sonar默認端口是9000，若是要改端口能夠對配置文件中的如下內容進行修改：

　　#sonar.web.port=9000

 

以後瀏覽器裏訪問本地的9000端口，帳號密碼都是admin，能夠看到sonar的界面。

 

二、啓動sonarqube

 bin目錄下找到windows相關文件夾，雙擊StartSonar.bat便可

 

 

2、客戶端

客戶端這裏咱們使用的是maven插件。

一、在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

 

二、在pom所在目錄下執行命令：

mvn clean verify -P sonar sonar:sonar

 

等命令執行完畢後，能夠去localhost:9000去查看結果。

 

（完畢）