Android Studio中checkstyle的gradle

本文主要介绍checkstyle在AndroidStuido中的gradle配置

1.build.gradle配置

1.在Project目录下（App同级）建立文件夹 config,并新建quality.gardle文件和quality文件夹

image.png

2.在quality文件夹下新建checkstyle文件夹。里面新建 checkstyle.xml和suppressions.xml文件

image.png

3.checkstyle.xml和suppressions.xml中内容可以参考阿里巴巴或者华为的checkstyle文件。这里主要讲解下quality.gradle和项目中gardle的配置。
quality.gradle文件如下：

apply plugin: 'checkstyle'
check.dependsOn 'checkstyle'
checkstyle {
    toolVersion = '8.0'
}
task checkstyle(type: Checkstyle) {
    configFile = file("$configDir/checkstyle/checkstyle.xml")
    configProperties.checkstyleSuppressionsPath = file("$configDir/checkstyle/suppressions.xml").absolutePath
    source 'src'
    Iterator<String> iterator = project.getParent().getChildProjects().keySet().iterator()
    while (iterator.hasNext()) {
        source "${project.rootDir}/${iterator.next()}/src/main/java"
    }  //这里的主要操作是：将项目的app和子module中的java目录下的代码全部添加到findbugs需要查找源文件中。

    include '**/*.java'
    exclude '**/gen/**'
    exclude '**/db/**'
    exclude '**/bean/**'
    exclude '**/test/**'
    exclude '**/androidTest/**'
    exclude '**/R.java'
    exclude '**/BuildConfig.java'
    classpath = files()
}

然后在 app目录下的build.gradle中添加

apply from: '../config/quality.gradle'

之后点击右侧的gradle-->Tasks-->other-->checkstyle即可。

image.png

在run命令上会展示出运行信息

image.png
image.png

备注：

1.若是checkstyle的jar包下载不下来。可以在项目的build.gradle的allprojects下的repositories中配置阿里云的maven仓库

maven { url "https://maven.aliyun.com/repository/jcenter/" }
maven { url "https://maven.aliyun.com/repository/gradle-plugin/" }
maven { url "https://maven.aliyun.com/repository/google/" }

2.若在运行出错，可以在Terminal输入命令行:gradlew checkstyle --stacktrace。查看详细打印信息。