Sonarqube安裝指南

一、Sonarqube 安裝教程

Sonarqube是一個開源的代碼質量檢測工具，能夠對Java、C#、C/C++、JavaScript等多種編程語言進行靜態代碼分析，檢驗代碼的質量，以及對代碼質量進行監控和管理。實現Sonarqube的主要步驟如下所示：

步驟1：安裝Java環境

$ apt-get install openjdk-11-jdk

這裡安裝的是openjdk-11-jdk，請根據實際情況選擇合適的版本

步驟2：下載Sonarqube

1、請先從官網下載Sonarqube安裝包，下載地址為：https://www.sonarqube.org/downloads/。

2、然後將下載的zip包解壓：

$ unzip sonarqube-8.9.2.46101.zip

步驟3：安裝Sonarqube

1、將解壓後的文件夾移動到 /opt 目錄下：

$ sudo mv sonarqube-8.9.2.46101 /opt/sonarqube 

2、修改下面的文件，配置Sonarqube資料庫和一些相關參數：

$ vim /opt/sonarqube/conf/sonar.properties

3、將下列代碼中的信息進行修改，如資料庫連接信息、伺服器IP地址等信息：

sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
sonar.web.host=0.0.0.0
sonar.junit.reportPaths=./build/test-results/test

4、啟動 Sonarqube 程序：

$ /opt/sonarqube/bin/linux-x86-64/sonar.sh start

如果不加 start 參數，Sonarqube 只會輸出狀態信息，並不會啟動。

二、Sonarqube 軟體使用教程

Sonarqube有兩種分析方式：命令行分析和Maven構建分析。

一、命令行分析

使用命令行分析代碼時，你需要執行以下步驟：

1、使用 Sonarqube Scanner 生成報告

$ sonar-scanner

2、上傳 Sonarqube 生成的報告

$ curl -X POST -u admin:admin http://localhost:9000/api/ce/submit?projectKey=myproject:version

二、Maven構建分析

使用Maven構建分析時，你需要執行以下步驟：

1、在 pom.xml 文件中添加 Sonarqube 插件

<build>
    <plugins>
        <plugin>
            <groupId>org.sonarsource.scanner.maven</groupId>
            <artifactId>sonar-maven-plugin</artifactId>
            <version>3.8.0.2131</version>
        </plugin>
    </plugins>
</build>

2、運行 Maven 構建命令來構建代碼，並生成 Sonarqube 報告

$ mvn sonar:sonar

三、Sonarqube 安裝部署

一、搭建反向代理伺服器

為了保證SonarQube服務的正常運行，需要一個反向代理伺服器。實現步驟如下：

1、安裝 Nginx 伺服器：

$ apt-get install nginx

2、配置 Nginx 伺服器，添加下面的代碼，其中 server_name 替換為你的域名或ip地址：

server {
    listen 80;
    server_name example.com; # 替換為你的域名或ip地址
    access_log /var/log/nginx/access.log;
    error_log /var/log/nginx/error.log;

    location / {
        proxy_pass http://localhost:9000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

3、重啟 Nginx 伺服器：

$ systemctl restart nginx 

二、部署Sonarqube服務到Tomcat

Sonarqube還可以通過Tomcat部署。

1、在Sonarqube解壓目錄/opt/sonarqube/bin下執行下列命令，將sonar.war文件複製到Tomcat服務下的webapps目錄下：

$ cp /opt/sonarqube/bin/sonar.war /opt/tomcat/webapps/

2、建立一個連接MySQL資料庫，並將連接信息寫到sonar.properties中。

3、啟動Tomcat服務。

$ /opt/tomcat/bin/startup.sh 

四、Sonarqube 安全問題

一、設置管理員賬戶

Sonarqube默認管理員賬戶admin/admin，為了安全起見，建議修改默認管理員賬戶，或設置其他管理員賬戶。實現步驟如下：

1、在Sonarqube界面中的 Administration -> Security -> User 中創建新的管理員賬戶，並刪除默認管理員賬戶。

二、禁用默認策略

Sonarqube的默認策略可能過於嚴格或適用於少數情況，禁用默認策略可降低實驗室中出現誤報的機會，從而減少對您的項目管理的干擾。

1、在Sonarqube界面中的 Administration->General->Security 中取消勾選「Default Permission Template」，並默認添加您自己的許可權模板。

五、Sonarqube 安裝教程免費

Sonarqube自身是一個開源項目，可以免費使用。