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
相关文章
|
开发工具 Android开发 iOS开发
如何在Android Studio中配置Flutter环境?
如何在Android Studio中配置Flutter环境?
2884 160
|
8月前
|
缓存 Unix Android开发
Android安卓项目调试之Gradle 与 Gradle Wrapper的概念以及常用gradle命令深度详解-优雅草卓伊凡
Android安卓项目调试之Gradle 与 Gradle Wrapper的概念以及常用gradle命令深度详解-优雅草卓伊凡
916 8
|
8月前
|
存储 API Android开发
【02】完整的安卓二次商业实战-配置gradle-构建打包原生安卓项目-调试本地运行模拟器-优雅草伊凡
【02】完整的安卓二次商业实战-配置gradle-构建打包原生安卓项目-调试本地运行模拟器-优雅草伊凡
779 4
【02】完整的安卓二次商业实战-配置gradle-构建打包原生安卓项目-调试本地运行模拟器-优雅草伊凡
|
8月前
|
Java 开发工具 Maven
【01】完整的安卓二次商业实战-详细的初级步骤同步项目和gradle配置以及开发思路-优雅草伊凡
【01】完整的安卓二次商业实战-详细的初级步骤同步项目和gradle配置以及开发思路-优雅草伊凡
1038 6
|
9月前
|
Shell 网络安全 开发工具
项目快速导入git
本文介绍了如何在本地初始化 Git 仓库并将代码提交到远程仓库(如 GitHub 或 Gitee)的基本流程。内容包括安装 Git、创建仓库、添加文件、提交更改以及推送代码到远程仓库的详细步骤,适合初学者快速掌握 Git 的基本使用方法。
2114 1
|
12月前
|
Android开发 Windows
Android studio 报错Connect to 127.0.0.1:8888 [/127.0.0.1] failed: Connection refused: connect(已解决)
这是一篇关于解决Android Studio报错“Connect to 127.0.0.1:8888 failed: Connection refused”的文章。问题通常因系统代理设置被Android Studio自动保存导致。解决方法是找到系统中Android Studio使用的gradle.properties文件(位于Windows的C:\Users\你的电脑用户名\.gradle或Mac的/Users/.{你的用户目录}/.gradle),删除或注释掉多余的代理配置后保存并重新Sync项目。希望此经验能帮助快速解决同类问题!
2327 36
|
12月前
|
Java Android开发
Android studio中build.gradle文件简单介绍
本文解析了Android项目中build.gradle文件的作用,包括jcenter仓库配置、模块类型定义、包名设置及依赖管理,涵盖本地、库和远程依赖的区别。
1007 19
|
开发工具 git 开发者
git 创建branch分支【转】
转自:http://www.cnblogs.com/jackluo/p/3499731.html   开发者user1 负责用getopt 进行命令解析的功能,因为这个功能用到getopt 函数,于是将这个分支命名为user1/getopt.
816 0
|
开发工具 git 开发者
git 创建branch分支
开发者user1 负责用getopt 进行命令解析的功能,因为这个功能用到getopt 函数,于是将这个分支命名为user1/getopt.(1)确保是在开发者user1的工作区中cd /home/jackluo/workspace/user1/workspace/hello-world(2)开发者user1 基于当前HEAD创建分支user1/getopt.
1436 0

推荐镜像

更多