一直感覺項目里的代碼風格很亂盾舌，想在commit時做個檢查，前幾周搗鼓了幾天終于弄好了，這里記錄分享下：
環(huán)境
由于是通過git的本地hook結(jié)合gradle task來實現(xiàn)的，所以git和Android studio肯定就是必須的了幔烛。
原理
Android的Gradle Api原生就有checkStyle類型的task，我們需要應(yīng)用checkstyle plugin囊蓝，并且實現(xiàn)一個這樣的task就可以執(zhí)行檢查代碼風格饿悬，并且生成檢查報告。代碼如下：
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就可以來執(zhí)行這個腳本慎颗，然后根據(jù)檢查結(jié)果決定是否可以commit
實現(xiàn)
我們首先要做的有以下幾件事：
- 編寫一份checkstyle的xml文件
- 用
checkstyletask的include乡恕，exclude將需要的和不需要的java類添加進來。 - 編寫git hook文件調(diào)用checkstyle的task
checkstyle文件網(wǎng)上可以找到俯萎，定義規(guī)則也很方便傲宜。這里就不再贅述。
而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中調(diào)用上述命令得到需要的字符串锚国，代碼如下：
def getChangeFiles() {
try {
String changeInfo = 'git status -s'.execute(null, project.rootDir).text.trim()
return changeInfo == null ? "" : changeInfo
} catch (Exception e) {
return ""
}
}
然后再解析這個字符串，就可以得到修改過的java文件類名集合玄坦。實現(xiàn)函數(shù)如下：
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;
}
現(xiàn)在只要把上述的java文件include進去血筑，就可以實現(xiàn)用gradle task只對修改過的java文件做checkstyle了，但是要做到git commit時自動檢查煎楣，就要添加git hook了豺总。
具體做法：
在項目.git/hooks 目錄 下添加pre-commit文件，這是一個shell文件择懂，在里面可以調(diào)用gradle task喻喳，并以task的輸出結(jié)果判斷是否可以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
我在這段代碼里 執(zhí)行了checkstyle task困曙，并且傳入了checkCommit=true的property值表伦。，如果checkstyle執(zhí)行成功就commit赂弓，checkstyle執(zhí)行報錯（有代碼不符合風格）就會提交失敗绑榴。
具體的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()
}
