使用Gradle作Java代碼質量檢查

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能夠直接啓動單元測試的分析。

在項目中build目錄下能夠看到jacoco目錄，以及reports/test/html目錄，後者主要是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