使用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分析单元测试

是一个分析单元测试覆盖率的工具，使用它运行单元测试后，可以给出代码中那些部分被单元测试到，哪些部分没有被单元测试覆盖，并且还会给出整个项目的单元测试覆盖情况。

在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

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持服务器之家。

原文链接：https://segmentfault.com/a/1190000018533109