## android 利用 git 信息区分 apk 版本
keywords: android,git,打包
知识点:
1.android 打包的时候附加上 git version code
2.productFlavors
android 打包的时候,生成的 apk 名字都是 app-debug.apk、app-release.apk,即使设置了 productFlavors,也只是类似于 app-channel_googleplay-debug.apk 这种的。通过名字,我们只能区分出是否是 debug 以及对应的渠道号。但是,对应的代码版本信息是体现不出来的。这在个人开发的时候弊端不是很明显,但是在团队协作的时候,就会麻烦不断。首先,如果你的 android 代码部署在了 jenkins 等代码集成服务器上来自动打包,那么你永远只能得到一个叫 app-release.apk 的最新的包。如果你想看看十天之前的某个包,那么你就只能把代码 check 到那个时间点然后手动打包。再比如,测试找到了一个 bug,但是你觉得不应该出现这个 bug 或者这个 bug 在你这里不能复现,这个时候你最先问的肯定是,“你装的是最新的包么?”然而,因为 apk 的名字不能体现出代码的版本号,所以这个事情就麻烦了。最终的结果肯定是你放下手头的工作,老老实实给测试同学打一个刚出炉的新包进行复现。根据“重复的事情都要交给计算机来做”原则,我们有必要在打包的过程中添加一个合适的版本信息。
那么我们用什么信息来当我们的版本信息呢?首先,我们需要明确,我们想得到的这个版本信息都包括什么特性:
+自增。比如:1,2,3…… 这样的好处就是,可以通过名字比较谁比较新。
+代表一个唯一的代码版本。(这是显然的。)
根据你使用的代码管理工具不同,我们选择的版本信息也不一样。如果是 svn, 那么用 svn 的版本号是不错的选择;如果你用的是 git,那么问题就有点麻烦了。git 没有类似于 svn 版本号的东西。git 倒是可以用 hashcode 来唯一表示一个代码版本。但是,如果从 apk 的名字上只能得到 hashcode,我们基本得不出什么人能理解的有效信息,也就不能达到我们提高工作效率的目的。那么怎么办呢?办法总是有的。对于 git,他本身的理念就保证了他根本没有类似于 svn 版本号一样的东西。那么我们只能去尽量模拟,在 git 中找到一个每次提交代码之后就自增的东西。答案就是`git rev-list HEAD --count`。其实就是实现了一个简单的对提交的 commit 进行计数的功能。所以,我们的 apk 的名字估计会变成`app-release-163.apk`。好了,到此我们模拟出了一个自增的版本号。这里留给读者朋友们一个小小的思考题:在 git 中,这样的命名方式是否能唯一确定一份代码副本呢?
我都这么问了,答案自然是不能的。因为,我们是通过数数的方式来确定的。那么很有可能两个分支数目是相同的。那么从 apk 的名字上来看,就不能可能定位到一个唯一的提交上去。怎么办?我现在想到了三种办法:
1.附加一个 branch 信息
2.附加一个 hashcode 作为辅助信息。commit count 作为一个初步的比较方式,相当于一个快捷方式;hashcode 作为一个准确但是不常用的的比较手段。在 commit count 不能区分的时候,借助 hashcode 信息。
3.把最后一个 commit 提交时候的时间(比如:2017_03_10_19_34_10)作为附加信息。这样其实跟 hashcode 差不多。但是,看起来比 hashcode 顺眼一些。
我这里选用的是第三种。
附上 builde.gradle 核心脚本,供大家复制。
```
apply plugin: 'com.android.application'
apply plugin: 'android-apt'
android {
compileSdkVersion 25
buildToolsVersion '25.0.2'
defaultConfig {
// ...balabala...
}
signingConfigs {
debug {
}
release {
}
}
buildTypes {
debug {
}
release {
}
}
productFlavors {
channel_default {}
channel_googleplay {}
}
productFlavors.all {
flavor -> flavor.manifestPlaceholders = [UMENG_CHANNEL_ID: name]
}
sourceSets {
main {
java.srcDirs = ['src/main/java', 'src/main/java-gen']
}
}
lintOptions {
abortOnError false
}
}
dependencies {
// ...balabala...
}
assemble {}.doLast{
tasks.copyAndRenameDebugApk.execute()
}
/**
* use this in Run/Debug Configurations
*/
task copyAndRenameDebugApk(type: Copy){
android.productFlavors.all {
flavor ->
println(flavor.name)
from 'build/outputs/apk/app-' + flavor.name + '-debug.apk'
from 'build/outputs/apk/app-' + flavor.name + '-release.apk'
into 'build/outputs/apk'
rename("app-" + flavor.name + "-debug.apk", "app-" + flavor.name + "-debug-" + getGitVersionCode() + "-"+ getGitCommitDescription() + ".apk")
rename("app-" + flavor.name + "-release.apk", "app-" + flavor.name + "-release-" + getGitVersionCode() + "-"+ getGitCommitDescription() + ".apk")
}
}
/**
* return the number of the count of the commit
* @return
*/
def getGitVersionCode() {
def cmd = 'git rev-list HEAD --count'
int gitVersion = cmd.execute().text.trim().toInteger()
println("the git version is : " + gitVersion)
return gitVersion
}
/**
* get the short description of the latest commit
* @return
*/
def getGitCommitDescription() {
// def cmd = "git rev-parse --short HEAD"
def cmd = "git log -1 --pretty=format:%cd --date=iso"
def proc = cmd.execute()
String cmdResult = proc.text.trim()
String[] resultArray = cmdResult.replaceAll(":", "-").split()
String apkName = (resultArray[0] + "-" + resultArray[1]).replaceAll("-", "_")
return apkName
}
```
解释一下脚本中的内容。
1.利用 productFlavors 用来设置友盟渠道号。
```
productFlavors {
channel_default {}
channel_googleplay {}
}
```
2.利用 doLast 设置调用的时机
```
assemble {}.doLast{
tasks.copyAndRenameDebugApk.execute()
}
```
3.对于每一个 flavor 产出的 apk,添加上 git 版本相关的信息。具体实现的时候,利用了 gradle 中的 copy task。其中,from 和 to 都是本目录内,不需做修改,只需虚晃一枪。真正需要关心的是 rename。在这里,我们小心翼翼地拼接出了我们期望得到的 apk 的名字。比如:`app-channel_default-release-698-2017_03_10_19_34_10.apk`。
```
/**
* use this in Run/Debug Configurations
*/
task copyAndRenameDebugApk(type: Copy){
android.productFlavors.all {
flavor ->
println(flavor.name)
from 'build/outputs/apk/app-' + flavor.name + '-debug.apk'
from 'build/outputs/apk/app-' + flavor.name + '-release.apk'
into 'build/outputs/apk'
rename("app-" + flavor.name + "-debug.apk", "app-" + flavor.name + "-debug-" + getGitVersionCode() + "-"+ getGitCommitDescription() + ".apk")
rename("app-" + flavor.name + "-release.apk", "app-" + flavor.name + "-release-" + getGitVersionCode() + "-"+ getGitCommitDescription() + ".apk")
}
}
```