概述

android工程中有一個非常重要的檔案-gradle.properties，它主要用於儲存一些全域性性配置，例如 jvm 的配置等，除此之外，業務層面的配置也可以抽取出來放在此處，方便各個module呼叫。

預設的 gradle.properties 長這樣：

# Project-wide Gradle settings.
# IDE (e.g. Android Studio) users:
# Gradle settings configured through the IDE *will override*
# any settings specified in this file.
 

# For more details on how to configure your build environment visit
# http://www.gradle.org/docs/current/userguide/build_environment.html

# Specifies the JVM arguments used for the daemon process.
# The setting is particularly useful for tweaking memory settings.
org.gradle.jvmargs=-Xmx1536m

# When configured, Gradle will run in incubating parallel mode.
 

# This option should only be used with decoupled projects. More details, visit
# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
# org.gradle.parallel=true

如上格式的內容是典型的 ini 格式的檔案，配置項通過回車符來分割。

使用場景

為支援自動化編譯android工程，我們需要把配置集中起來，方便動態替換，有如下要求需要滿足：
1. 應用Id 可以配置 （對應 build.gradle => applicationId）
2. 應用版本 VersionName 和 VersionCode 可以配置 （對應 build.gradle => versionCode | versionName）
3. 應用名稱 Name 可以配置 （對應 AndroidManifest.xml => android:label，這裡有坑，請往下看）
4. 百度定位Key 可以配置 （對應 AndroidManifest.xml => meta-data）
5. 啟動頁面 可以配置 ( 對應 MainActivity.java => 變數）

將如上需要配置的地方抽取出來到統一的地方，那就是gradle.properties檔案。

寫入配置

在gradle.properties檔案中，配置如下：

AppID=com.gz.debugtool
AppVersionName=1.0
AppVersionCode=1
StartPage=index.html
BaiduKey=u91cPvSUevIzvOhBdBGU7iv5mSb6mHDs

build.gradle檔案中讀配置

想要在build.gradle 中讀取配置，直接 project.keyName 即可，例如 應用Id 和應用版本的配置如下：

defaultConfig {
     applicationId project.AppID //讀取應用Id
     minSdkVersion 19
     targetSdkVersion 25
     versionCode project.AppVersionCode as int  //讀取版本號 轉換成數字
     versionName project.AppVersionName //讀取版本名稱
}

AndroidManifest.xml中讀配置

在Manifest讀取配置，其實是 Gradle 替換文字的過程，也就是在 Build 階段會動態替換 該檔案中的佔位符。例如 BaiduKey 的配置替換：
在 build.gradle => buildTypes 中先定義需要替換的Key，使用manifestPlaceholders欄位：

buildTypes {
        release {
            manifestPlaceholders = [BAIDU_APPKEY_VALUE: BaiduKey]
            //...
        }
        debug {
            manifestPlaceholders = [BAIDU_APPKEY_VALUE: BaiduKey]
            //...
        }
    }

然後，在AndroidManifest.xml中這樣使用：

<meta-data
     android:name="com.baidu.lbsapi.API_KEY"
     android:value="${BAIDU_APPKEY_VALUE}" >
 </meta-data>

對於manifestPlaceholders的配置，實際是可以有多個的(通過逗號隔開)，可以這樣寫：

 manifestPlaceholders = [
     BAIDU_APPKEY_VALUE: BaiduKey,
     Key1: Value1,
     Key2: Value2
 ]

來看看底層原始碼，發現 manifestPlaceHolders 接收 Map 型別的引數，上述配置多個，使用[可能會讓開發者詫異，這只是gradle的語法問題（我們可能習慣來使用 { }）。

public void setManifestPlaceholders(Map<String,Object> manifestPlaceholders){
    this.mManifestPlaceholders.clear();
    this.mManifestPlaceholders.putAll(manifestPlaceholders);
    //...
}

MainActivity.java中讀取配置

在java程式碼中讀取配置，其實是動態編譯的過程，它會先在 BuildConfig.java中生成對應的靜態變數， 而後在java程式碼中才能引用。
在 build.gradle => buildTypes 中先定義需要生成靜態變數的的Key ，使用 buildConfigField定義欄位型別type、欄位name以及具體的value（指向gradle.properties的key)

buildTypes {
    release {
        buildConfigField "String", "StartPage", "\"${StartPage}\""
        //...
    }
    debug {
        buildConfigField "String", "StartPage", "\"${StartPage}\""
        //...
    }
}

經過Gradle Sync 後，可以在BuildConfig.java中看到自動生成的程式碼：

public final class BuildConfig {
  public static final boolean DEBUG = Boolean.parseBoolean("true");
  public static final String APPLICATION_ID = "com.gz.debugtool";
  public static final String BUILD_TYPE = "debug";
  public static final String FLAVOR = "";
  public static final int VERSION_CODE = 1;
  public static final String VERSION_NAME = "1.0";
  // Fields from build type: debug
  public static final String StartPage = "index.html";  //這裡是自動生成的靜態變數
}

在MainActivity.java中使用如下：

String startPage = BuildConfig.StartPage;

來看看底層原始碼，該方法接收三個引數， type、name、value

 public void buildConfigField(@NonNull String type,@NonNull String name,@NonNull String value) {
        ClassField alreadyPresent = getBuildConfigFields().get(name);
        if (alreadyPresent != null) {
            logger.info(
                    "BuildType(${getName()}): buildConfigField '$name' value is being replaced: ${alreadyPresent.value} -> $value");
        }
        addBuildConfigField(AndroidBuilder.createClassField(type, name, value));
 }

中文亂碼問題

gradle.properties 中配置中文，例如AppName=測試應用， 無論哪種方式讀取出來均是亂碼，這是使用過程中遇到的巨大的坑。因此不建議在該檔案中使用中文字元。