使用Gradle做Java程式碼質量檢查

姜家志發表於2019-03-17
GradleJava

Maven --> Gradle

首先安裝gradle: Mac安裝

brew install gradle 
複製程式碼

Ubuntu安裝

apt install gradle
複製程式碼

Maven專案切換Gradle專案,再Maven根目錄下執行:

gradle init --type pom
複製程式碼

執行成功之後執行命令gradle build，成功之後刪除pom.xml即可。

使用jacoco分析單元測試

jacoco是一個分析單元測試覆蓋率的工具，使用它執行單元測試後，可以給出程式碼中那些部分被單元測試到，哪些部分沒有被單元測試覆蓋，並且還會給出整個專案的單元測試覆蓋情況。 在build.gradle中新增jacoco外掛

apply plugin: 'jacoco'
複製程式碼

執行命令進行單元測試分析

gradle jacocoTestReport
複製程式碼

或者可以再Gradle的工具選單中Tasks -> other -> jacocoTsestReport可以直接啟動單元測試的分析。

jacocoTestReport
在專案中build目錄下可以看到jacoco目錄，以及reports/test/html目錄，後者主要是jacoco生成的報告。
jacoco報告

使用SonarQube做程式碼質量檢查

SonarQube是一個開源的程式碼質量管理系統，支援超過25種程式語言，提供重複程式碼、編碼標準、單元測試、單元測試覆蓋率，程式碼複雜度，潛在Bug、註釋和軟體設計的報告等。 在gradle中使用SonarQube首先要新增依賴，在編譯指令碼中新增：

buildscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2/" }
    }
    dependencies {
        classpath("org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:2.6-rc1")
        classpath("org.springframework.boot:spring-boot-gradle-plugin:2.0.5.RELEASE")
    }
}
複製程式碼

新增外掛:

apply plugin: "org.sonarqube"
複製程式碼

配置SonarQube:

sonarqube {
    properties {
        property "sonar.sourceEncoding", "UTF-8"
        property "sonar.host.url", "https://sonarcloud.io"
        property "sonar.jdbc.url", "jdbc:mysql://my.server.com/sonar"
        property "sonar.jdbc.driverClassName", "com.mysql.jdbc.Driver"
        property "sonar.login", "test"
        property "sonar.password", "test"

    }
}
複製程式碼

或者只使用token上傳分析結果即可：

property "sonar.login", "token"

複製程式碼

SonarQube本身並沒有提供單元測試覆蓋率的工具，需要在使用jacoco的分析結果，在SonarQube中新增jacoco相關的配置


sonarqube {
    properties {

        property "sonar.jacoco.reportPath", "$rootDir/build/jacoco/test.exec"
        property "sonar.jacoco.itReportPath", "$rootDir/build/jacoco/acceptanceTest.exec"
        property "sonar.jacoco.excludes", "*/st/*"

        property "sonar.sourceEncoding", "UTF-8"
        property "sonar.host.url", "https://sonarcloud.io"
        property "sonar.jdbc.url", "jdbc:mysql://my.server.com/sonar"
        property "sonar.jdbc.driverClassName", "com.mysql.jdbc.Driver"
        property "sonar.login", "test"
        property "sonar.password", "test"

    }
}
複製程式碼

執行命令gradle sonarqube即可對程式碼進行分析，並上傳分析結果，因為SonarQube的分析依賴jacoco的單元測試分析，所以需要先執行命令gradle jacocoTestReport。最終需要執行的組合命令是:

gradle jacocoTestReport
gradle sonarqube
複製程式碼

相關文章