Android Studio利用Build.gradle导入Git commit ID、Git Branch、User等版本信息

简介: 本文介绍了在Android Studio项目中通过修改`build.gradle`脚本来自动获取并添加Git的commit ID、branch名称和用户信息到BuildConfig类中,从而实现在编译时将这些版本信息加入到APK中的方法。

1. 前言

Android Studio的APP开发即便使用VERSION_CODE来记录版本信息,依旧觉得麻烦,希望找到一种在编译时,自动将版本信息无误的加入到APK中的方法,毫无疑问,这需要修改编译脚本来辅助实现,而在AS中,自然是通过gradle脚本来实现。本文及详细介绍实现的方法和步骤,以及最终的演示效果。

2. 实现方法

2.1 添加BuildConfig成员变量

文件名: tvass\gradle.properties
添加Buildconfig成员变量

GIT_COMMIT_ID=0
GIT_BRANCH_NAME=master
GIT_USER=empty

2.2 实现gradle接口函数

tvass\app\build.gradle
添加方法,用于给Buildconfig变量赋值

apply plugin: 'com.android.application'

//获取short版本的 git commit id
def getGitRevision() {
   
    return "git rev-parse --short HEAD".execute().text.trim()
}

//获取分支名称
def getGitBranch(){
   
    def branchName
    def branch =  "git branch --contains HEAD".execute().text.trim()
    def index = branch.indexOf('*')
    if(index == -1){
   
        branchName = "master"
    }else{
   
        branchName = branch.substring(index+2)
    }
    println "branchName  "+branchName
    return branchName
}

//获取编译人员 user.name
def getGitUser(){
   
    return "git config --global --get user.name".execute().text.trim()
}

2.3 关键部分

2.3.1 接口及接口转换

tvass\app\build.gradle
android的BuildTypes内,添加

buildTypes {
   
        release {
   

            //在Build.gradle执行期间,给新增的Buildconfig的成员变量赋值
            GIT_COMMIT_ID = getGitRevision()
            GIT_BRANCH_NAME = getGitBranch()
            GIT_USER = getGitUser()

            //定义给JAVA使用的接口名称、参数类型
            buildConfigField "String", "gitCommitId", "\"${GIT_COMMIT_ID}\""
            buildConfigField "String", "gitBranchName", "\"${GIT_BRANCH_NAME}\""
            buildConfigField "String", "getGitUser", "\"${GIT_USER}\""

            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.release
        }

        debug {
   

            //同楼上 release 说明
            GIT_COMMIT_ID = getGitRevision()
            GIT_BRANCH_NAME = getGitBranch()
            GIT_USER = getGitUser()

            buildConfigField "String", "gitCommitId", "\"${GIT_COMMIT_ID}\""
            buildConfigField "String", "gitBranchName", "\"${GIT_BRANCH_NAME}\""
            buildConfigField "String", "getGitUser", "\"${GIT_USER}\""

            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.debug
        }
    }
2.3.2 实现Java接口

在自己的工具类中,添加Java函数,获取Git版本信息
文件:tvass\app\src\main\java\com\xxx\tvass\tool\Tools.java

import com.xxx.tvass.BuildConfig;
public class Tools {
   

     //调用 2.3.1 导出到java的接口
    public static String getGitVersion(){
   
        return  String.format(Locale.CHINA, "APP版本信息:VERSION_CODE=%d, VERSION_NAME=%s, " +
                        " Git CommitID=CL#%s,Branch:%s, Producted By:%s",
                BuildConfig.VERSION_CODE, BuildConfig.VERSION_NAME,
                BuildConfig.gitCommitId, BuildConfig.gitBranchName, BuildConfig.getGitUser);
    }
}

3. 调用演示

3.1 调用代码

public class BootBroadcastReceiver extends BroadcastReceiver {
   
    private static final String TAG = BootBroadcastReceiver.class.getSimpleName();

    @Override
    public void onReceive(Context context, Intent intent) {
   //18006

        RLog.i(TAG,"tvass: "+ Tools.getGitVersion());

       if (Intent.ACTION_LOCKED_BOOT_COMPLETED.equals(intent.getAction())) {
   

3.2 运行情况

3.2.1 分支情况:git brach -a
Windows PowerShell
版权所有(C) Microsoft Corporation。保留所有权利。

安装最新的 PowerShell,了解新功能和改进!https://aka.ms/PSWindows

PS C:\Users\66176\Documents\works\mt9652\all_app\tvass> git branch -a
  master_combiecode
* master
  remotes/origin/HEAD -> origin/master
  remotes/origin/master
  remotes/origin/master_xxx
PS C:\Users\66176\Documents\works\mt9652\all_app\tvass>
3.2.2 提交记录:git lg
PS C:\Users\66176\Documents\works\mt9652\all_app\tvass> git lg
* 3516551 - (HEAD -> master, origin/master, origin/HEAD) 合并master与master_combiecode分支差异,添加APP版本打印 (16 hours ago) <zhoushang>
…… 省略 ……
* 501341c - init 20220713  (3 months ago) <zhoushang>
PS C:\Users\66176\Documents\works\mt9652\all_app\tvass>
3.2.3 成功的打印

11-18 09:40:38.373  5216  5216 I szhou   : \n
BootBroadcastReceiver-----tvass: \n
APP版本信息:VERSION_CODE=1, VERSION_NAME=1.0,  Git CommitID=CL#3516551,Branch:master, Producted By:zhoushang
相关文章
|
18天前
|
开发工具 git
Git 中的 fork、branch 和 clone
【8月更文挑战第27天】
76 5
|
17天前
|
Android开发
Android Studio: 解决Gradle sync failed 错误
本文介绍了解决Android Studio中出现的Gradle同步失败错误的步骤,包括从`gradle-wrapper.properties`文件中获取Gradle的下载链接,手动下载Gradle压缩包,并替换默认下载路径中的临时文件,然后重新触发Android Studio的"Try Again"来完成同步。
224 0
Android Studio: 解决Gradle sync failed 错误
|
17天前
|
Java Android开发 芯片
使用Android Studio导入Android源码:基于全志H713 AOSP,方便解决编译、编码问题
本文介绍了如何将基于全志H713芯片的AOSP Android源码导入Android Studio以解决编译和编码问题,通过操作步骤的详细说明,展示了在Android Studio中利用代码提示和补全功能快速定位并修复编译错误的方法。
30 0
使用Android Studio导入Android源码:基于全志H713 AOSP,方便解决编译、编码问题
|
1月前
|
Java 开发工具 Maven
Flutter和Android中覆盖gradle中的repositories仓库地址
Flutter和Android中覆盖gradle中的repositories仓库地址
86 4
|
1月前
|
开发工具 git
Git——commit的提交规范
Git——commit的提交规范
67 4
|
16天前
|
测试技术 持续交付 开发工具
[译] 为何每次 Git Commit 要尽可能小?
[译] 为何每次 Git Commit 要尽可能小?
|
26天前
|
IDE API 开发工具
与Android Gradle Plugin对应的Gradle版本和Android Studio版本
与Android Gradle Plugin对应的Gradle版本和Android Studio版本
148 0
|
1月前
|
Android开发
解决Android、Flutter编译时Gradle报错:javax.net.ssl.SSLException: Connection reset
解决Android、Flutter编译时Gradle报错:javax.net.ssl.SSLException: Connection reset
132 0
|
3天前
|
IDE 开发工具 Android开发
安卓与iOS开发对比:平台选择对项目成功的影响
【9月更文挑战第10天】在移动应用开发的世界中,选择正确的平台是至关重要的。本文将深入探讨安卓和iOS这两大主要移动操作系统的开发环境,通过比较它们的市场份额、开发工具、编程语言和用户群体等方面,为开发者提供一个清晰的指南。我们将分析这两个平台的优势和劣势,并讨论如何根据项目需求和目标受众来做出最佳选择。无论你是初学者还是有经验的开发者,这篇文章都将帮助你更好地理解每个平台的特性,并指导你做出明智的决策。
|
1天前
|
API Android开发 iOS开发
安卓与iOS开发中的线程管理对比
【9月更文挑战第12天】在移动应用的世界中,安卓和iOS平台各自拥有庞大的用户群体。开发者们在这两个平台上构建应用时,线程管理是他们必须面对的关键挑战之一。本文将深入探讨两大平台在线程管理方面的异同,通过直观的代码示例,揭示它们各自的设计理念和实现方式,帮助读者更好地理解如何在安卓与iOS开发中高效地处理多线程任务。