作為代碼質(zhì)量檢查的流行工具，比如Sonarqube能夠檢查代碼的“七宗罪”，跟代碼結合起來能夠更好地提高代碼的質(zhì)量，這篇文章將會介紹如何結合gradle和sonarqube對代碼質(zhì)量與測試覆蓋率進行分析。

Sonarqube

Sonarqube可以使用docker版本快速搭建，可以參看一下Easypack整理的鏡像，具體使用可以參看如下鏈接，這里不再贅述：

• https://hub.docker.com/r/liumiaocn/sonarqube/

環(huán)境假定

本文使用到的sonarqube為本機32003可以訪問到的服務。

gradle的sonarqube插件

gradle中的sonarqube的插件是org.sonarqube，用來在gradle中調(diào)用sonarqube進行代碼質(zhì)量分析。詳細介紹請參看：

• https://plugins.gradle.org/plugin/org.sonarqube
• 當前插件最新版本：2.6.2（更新于2018/2/13）

使用方式

指定plugin

在build.gradle中添加如下插件版本信息

plugins {
 id "org.sonarqube" version "2.6.2"
}

添加apply plugin信息

apply plugin: "org.sonarqube"

sonarqube設定信息

最簡單的需求的情況下，非多工程項目做以上配置即可，接下來就是傳遞給gradle所需要的sonarqube的詳細信息，而這些可以通過property的方式傳入，詳細的使用方式在前面的基礎中都已介紹，此處不再贅述，主要設定的內(nèi)容為：

• URL：systemProp.sonar.host.url=http://localhost:32003
• 用戶名：systemProp.sonar.login=admin
• 密碼：systemProp.sonar.password=admin

設定方式可以使用如下方式：

sonarqube {
  properties {
    property "sonar.host.url", "http://localhost:32003"
    property "sonar.login", "admin"
    property "sonar.password", "admin"
  }
}

build.gradle詳細信息

liumiaocn:springboot liumiao$ cat build.gradle 
buildscript {
 ext {
 springBootVersion = '2.1.1.RELEASE'
 }
 repositories {
 mavenCentral()
 }
 dependencies {
 classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
 }
}
plugins {
 id "org.sonarqube" version "2.6.2"
}
sonarqube {
  properties {
    property "sonar.host.url", "http://localhost:32003"
    property "sonar.login", "admin"
    property "sonar.password", "admin"
  }
}
apply plugin: 'java'
apply plugin: 'jacoco'
apply plugin: 'org.sonarqube'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'
group = 'com.liumiaocn'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8
repositories {
 mavenCentral()
}
dependencies {
 implementation('org.springframework.boot:spring-boot-starter-web')
    testImplementation('org.springframework.boot:spring-boot-starter-test')
}
jacocoTestReport {
  reports {
    xml.enabled false
    html.enabled true
  }
}
check.dependsOn jacocoTestReport
liumiaocn:springboot liumiao$

掃描方式

可以使用gradle sonarqube即可進行掃描

執(zhí)行日志

liumiaocn:springboot liumiao$ gradle sonarqube
> Task :sonarqube
SCM provider autodetection failed. No SCM provider claims to support this project. Please use sonar.scm.provider to define SCM of your project.
Class not found: javax.annotation.Nonnull
Class not found: javax.annotation.meta.When
Class not found: javax.annotation.meta.TypeQualifierNickname
Class not found: org.junit.jupiter.api.extension.ExtendWith
BUILD SUCCESSFUL in 6s
5 actionable tasks: 1 executed, 4 up-to-date
liumiaocn:springboot liumiao$

結果確認

掃描結果確認

可以看到質(zhì)量掃描結果和覆蓋率的信息都進行了顯示

脆弱性信息詳細

查出了一個缺陷，實際是一個誤報，詳細可參看maven使用方式的詳細介紹。

• http://m.fzitv.net/article/153522.htm

代碼覆蓋率

代碼覆蓋率的詳細信息也可以在sonarqube上進行直接確認

小結

使用SonarQube可以很好的檢查出代碼的問題，但是在實際的項目中需要進行裁剪和定制，掃出來的不一定有問題，沒有掃出來也不一定萬事大吉，但是一定程度的代碼規(guī)范和質(zhì)量提高還是很有用處，實際在使用的時候應該根據(jù)具體情況進行實施。

參考文章

• https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner+for+Gradle
• https://plugins.gradle.org/plugin/org.sonarqube

總結

以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學習或者工作具有一定的參考學習價值，謝謝大家對腳本之家的支持。如果你想了解更多相關內(nèi)容請查看下面相關鏈接

最新評論