萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> Android 開發

Android 獲取 App 版本資訊:版本號、版本名稱、BuildConfig 與 PackageManager 完整用法

在關於頁面顯示版本、埋點上報、強制更新檢查、崩潰日誌附帶版本等場景,都需要程式化獲取 App 版本資訊。本文整理 BuildConfig (編譯期常數) 與 PackageManager (執行期查詢) 兩種方式的差異、適用場景與完整工具類。

方式一:BuildConfig (編譯期常數,極快、無 IO)

Gradle 自動生成,位於 app/build/generated/source/buildConfig/...,僅限主 Module (application),Library Module 需額外配置。

// 建構時自動注入,無需權限、無 IO、極快
String versionName = BuildConfig.VERSION_NAME;     // 如 "1.2.3"
int versionCode = BuildConfig.VERSION_CODE;        // 如 123
String applicationId = BuildConfig.APPLICATION_ID; // 如 "com.example.app"
boolean debug = BuildConfig.DEBUG;                 // 是否 debug 版本
String flavor = BuildConfig.FLAVOR;                // 產品風味 (如 "googlePlay", "huawei")

方式二:PackageManager (執行期查詢,適用於任意包名、跨進程)

public class VersionUtils {

    /** 獲取版本名稱 (如 "1.2.3") */
    public static String getVersionName(Context context) {
        return getPackageInfo(context).versionName;
    }

    /** 獲取版本號 (如 123) */
    public static int getVersionCode(Context context) {
        return getPackageInfo(context).versionCode;
    }

    /** 獲取長版本號 (Android 12+ / API 31+, Long 型別) */
    public static long getLongVersionCode(Context context) {
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
            return getPackageInfo(context).getLongVersionCode();
        }
        return getPackageInfo(context).versionCode;
    }

    /** 獲取完整 PackageInfo (含安裝時間、簽名、權限等) */
    public static PackageInfo getPackageInfo(Context context) {
        try {
            return context.getPackageManager()
                    .getPackageInfo(context.getPackageName(), 0);
        } catch (PackageManager.NameNotFoundException e) {
            throw new RuntimeException("PackageInfo 不存在", e);
        }
    }

    /** 獲取任意包名的版本資訊 (需查詢權限) */
    public static String getVersionName(Context context, String packageName) {
        try {
            PackageInfo info = context.getPackageManager().getPackageInfo(packageName, 0);
            return info.versionName;
        } catch (PackageManager.NameNotFoundException e) {
            return "unknown";
        }
    }
}

兩者差異與選型指南

維度BuildConfigPackageManager
速度極快 (靜態常數)較慢 (IPC + 磁碟 IO)
適用範圍僅當前應用 (主 Module)任意已安裝應用 (需權限)
資料新鮮度編譯時固定執行時即時 (反映實際安裝版本)
常用場景App 內部顯示、埋點、日誌檢測其他 App 版本、跨進程、動態更新檢查
Library Module 可用性需在 build.gradle 設定 buildConfigField通用

進階:Library Module 也要用 BuildConfig

// library/build.gradle
android {
    defaultConfig {
        // 手動定義供 Library 內部使用
        buildConfigField "String", "LIB_VERSION_NAME", "\"1.0.0\""
        buildConfigField "int", "LIB_VERSION_CODE", "100"
    }
}

// Library 程式碼中使用
String libVer = BuildConfig.LIB_VERSION_NAME; // 注意:這是 Library 自己的 BuildConfig 類

最佳實踐封裝:優先 BuildConfig,兜底 PackageManager

public class AppVersionProvider {
    private static String sVersionName;
    private static int sVersionCode;

    public static synchronized String getVersionName(Context context) {
        if (sVersionName != null) return sVersionName;
        try {
            // 嘗試 BuildConfig (最快)
            sVersionName = BuildConfig.VERSION_NAME;
            sVersionCode = BuildConfig.VERSION_CODE;
        } catch (Exception e) {
            // Library Module 或反射失敗,回退 PackageManager
            PackageInfo info = VersionUtils.getPackageInfo(context);
            sVersionName = info.versionName;
            sVersionCode = info.versionCode;
        }
        return sVersionName;
    }

    public static int getVersionCode(Context context) {
        getVersionName(context); // 確保初始化
        return sVersionCode;
    }
}

常見應用場景

  • 關於頁面: tvVersion.setText("v" + AppVersionProvider.getVersionName(this))
  • 網路請求 Header: headers.put("X-App-Version", AppVersionProvider.getVersionName(context))
  • 崩潰上報: 自動附帶 versionCode、versionName、BuildConfig.DEBUG、BuildConfig.FLAVOR。
  • 強制更新檢查: 伺服器回傳 minVersionCode,客戶端比對 getVersionCode() < minVersionCode 彈出強更對話框。
copyright © 萬盛學電腦網 all rights reserved