Android项目git+gradle实现commit时checkstyle检查

一直感觉项目里的代码风格很乱,想在commit时做个检查,前几周捣鼓了几天终于弄好了,这里记录分享下:

环境

由于是通过git的本地hook结合gradle task来实现的,所以git和Android studio肯定就是必须的了。

原理

Android的Gradle Api原生就有checkStyle类型的task,我们需要应用checkstyle plugin,并且实现一个这样的task就可以执行检查代码风格,并且生成检查报告。代码如下:

 allprojects {
    ...
    ...
    apply plugin: 'checkstyle'

    checkstyle {
        configFile rootProject.file('checkstyle.xml')
        toolVersion '6.19'
        ignoreFailures false
        showViolations true
    }

    task('checkstyle', type: Checkstyle) {
        source 'src/main/java'
        include '**/*.java'
        exclude '**/R.java'
        exclude '**/BuildConfig.java'
        classpath = files()
    }
}

通过hook git commit就可以来执行这个脚本,然后根据检查结果决定是否可以commit

实现

我们首先要做的有以下几件事:

  1. 编写一份checkstyle的xml文件
  2. checkstyletask的includeexclude将需要的和不需要的java类添加进来。
  3. 编写git hook文件调用checkstyle的task

checkstyle文件网上可以找到,定义规则也很方便。这里就不再赘述。
include的文件就比较麻烦了,如果你不需要只检查要提交的文件,那也方便,直接如上所示include '**/*.java',添加所有的java文件就可以了。而如果需要只检查修改的文件就要稍微麻烦点,需要以下几步操作:

因为用git status -s命令得到修改过的文件字符串。格式如下:

$ git status -s
 M gradle.properties
 M gradle/wrapper/gradle-wrapper.properties
 M tinker-android/tinker-android-lib/src/main/java/com/tencent/tinker/lib/patch/BsDiffPatchInternal.java
 M tinker-sample-android/gradle.properties

所以我们可以在gradle中调用上述命令得到需要的字符串,代码如下:

def getChangeFiles() {
    try {
        String changeInfo = 'git status -s'.execute(null, project.rootDir).text.trim()
        return changeInfo == null ? "" : changeInfo
    } catch (Exception e) {
        return ""
    }
}

然后再解析这个字符串,就可以得到修改过的java文件类名集合。实现函数如下:

def filterCommitter(String gitstatusinfo) {
    ArrayList<String> filterList = new ArrayList<String>();
    String[] lines = gitstatusinfo.split("\\n")
    for (String line : lines) {
        if (line.contains(".java")) {
            String[] spliters = line.trim().split(" ");
            for (String str : spliters) {
                if (str.contains(".java")) {
                    filterList.add(str)
                }
            }
        }
    }
    return filterList;
}

现在只要把上述的java文件include进去,就可以实现用gradle task只对修改过的java文件做checkstyle了,但是要做到git commit时自动检查,就要添加git hook了。

具体做法:
在项目.git/hooks 目录 下添加pre-commit文件,这是一个shell文件,在里面可以调用gradle task,并以task的输出结果判断是否可以commit。代码如下:

#!/bin/sh
#
# An example hook script to verify what is about to be committed.
# Called by "git commit" with no arguments.  The hook should
# exit with non-zero status after issuing an appropriate message if
# it wants to stop the commit.
#
# To enable this hook, rename this file to "pre-commit".

if git rev-parse --verify HEAD >/dev/null 2>&1
then
  against=HEAD
else
  # Initial commit: diff against an empty tree object
  against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
fi

SCRIPT_DIR=$(dirname "$0")
SCRIPT_ABS_PATH=`cd "$SCRIPT_DIR"; pwd`
$SCRIPT_ABS_PATH/../../gradlew  -PcheckCommit="true" checkstyle 
if [ $? -eq 0   ]; then
    echo "checkstyle OK"
else
    exit [[ $ERROR_INFO =~ "checkstyle" ]] && exit 1  
fi

我在这段代码里 执行了checkstyle task,并且传入了checkCommit=true的property值。,如果checkstyle执行成功就commit,checkstyle执行报错(有代码不符合风格)就会提交失败。
具体的gradle 脚本如下:

task checkstyle(type: Checkstyle) {
    source 'app/src/main/java'
    source 'lib_base/src/main/java'
    source 'lib_http/src/main/java'
    source 'lib_imageloader/src/main/java'
    source 'lib_storage/src/main/java'
    source 'lib_util/src/main/java'

    exclude '**/gen/**'
    exclude '**/R.java'
    exclude '**/BuildConfig.java'

    if (project.hasProperty('checkCommit') && project.property("checkCommit")) {
        def ft = filterCommitter(getChangeFiles());
        def includeList = new ArrayList<String>()
        for (int i = 0; i < ft.size(); i++) {
            String spliter = ft.getAt(i)
            String[] spliterlist = spliter.split("/")
            String fileName = spliterlist[spliterlist.length - 1]
            log("Checkstyle:file=" + fileName)
            includeList.add("**/" + fileName)
        }
        if (includeList.size() == 0) {
            exclude '**/*.java'
        } else {
            include includeList
        }
    } else {
        include '**/*.java'
    }
    configFile rootProject.file('/config/checkstyle.xml')
    classpath = files()
}

推荐阅读更多精彩内容