淺談Gradle 常用配置總結(jié)

更新時(shí)間：2018年09月11日 09:12:21 作者：葉應(yīng)是葉

這篇文章主要介紹了淺談Gradle 常用配置總結(jié)，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

這里分享下我在日常開發(fā)中對(duì) Gradle 的常用配置規(guī)則

一、版本號(hào)配置

當(dāng)項(xiàng)目逐漸演進(jìn)的過程中，主工程依賴的 Module 可能會(huì)越來越多，此時(shí)就需要統(tǒng)一配置各個(gè) Module 的編譯參數(shù)了

在工程的根目錄下新建一個(gè) gradle 文件，命名為 config.gradle ，在此文件中統(tǒng)一聲明工程的編譯屬性和依賴庫(kù)的版本號(hào)

ext {
  compileSdkVersion = 28
  minSdkVersion = 15
  targetSdkVersion = 28
  versionCode = 1
  versionName = '1.0'

  dependencies = [
      appcompatV7   : 'com.android.support:appcompat-v7:28.0.0-rc02',
      constraintLayout: 'com.android.support.constraint:constraint-layout:1.1.3',
      junit      : 'junit:junit:4.12',
      testRunner   : 'com.android.support.test:runner:1.0.2',
      espressoCore  : 'com.android.support.test.espresso:espresso-core:3.0.2'
  ]

}

默認(rèn)情況下， App Module 的 build.gradle 文件的默認(rèn)配置如下所示

apply plugin: 'com.android.application'

android {
  compileSdkVersion 28
  defaultConfig {
    applicationId "leavesc.hello.gradlesamples"
    minSdkVersion 15
    targetSdkVersion 28
    versionCode 1
    versionName "1.0"
    testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
  }
  buildTypes {
    release {
      minifyEnabled false
      proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
    }
  }
}

dependencies {
  implementation fileTree(dir: 'libs', include: ['*.jar'])
  implementation 'com.android.support:appcompat-v7:28.0.0-rc02'
  implementation 'com.android.support.constraint:constraint-layout:1.1.3'
  testImplementation 'junit:junit:4.12'
  androidTestImplementation 'com.android.support.test:runner:1.0.2'
  androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
}

這里將其改為引用 config.gradle 文件的形式

首先，需要在根目錄下的 build.gradle 文件中應(yīng)用 config.gradle 文件，這樣在 Module 配置文件中才引用得到當(dāng)中的屬性值

此時(shí)就可以修改應(yīng)用版本號(hào)以及依賴庫(kù)的聲明方式了

apply plugin: 'com.android.application'

def globalConfiguration = rootProject.ext
def presentationDependencies = globalConfiguration.dependencies

android {
  compileSdkVersion globalConfiguration["compileSdkVersion"]
  defaultConfig {
    applicationId "leavesc.hello.gradlesamples"
    minSdkVersion globalConfiguration["minSdkVersion"]
    targetSdkVersion globalConfiguration["targetSdkVersion"]
    versionCode globalConfiguration["versionCode"]
    versionName globalConfiguration["versionName"]
    testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
  }

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

dependencies {
  implementation fileTree(include: ['*.jar'], dir: 'libs')
  implementation presentationDependencies.appcompatV7
  implementation presentationDependencies.constraintLayout
  testImplementation presentationDependencies.junit
  androidTestImplementation presentationDependencies.testRunner
  androidTestImplementation presentationDependencies.espressoCore
}

這樣，即使以后工程中包含多個(gè) Module ，只要配置的屬性都是來自于 config.gradle 文件，就可以做到統(tǒng)一修改編譯屬性與依賴庫(kù)版本了

二、簽名屬性配置

通常，應(yīng)用的簽名類型會(huì)分為 release 和 debug 兩類，并分別使用不同的簽名文件

為了安全考慮以及實(shí)現(xiàn)自動(dòng)化打包，可以通過 gradle 來聲明簽名配置，包括簽名文件路徑、簽名別名、簽名密碼等

在 local.properties 文件中聲明簽名文件路徑以及簽名密碼

sdk.dir=C\:\\Software\\SDK
key.keyStorePath=..\\doc\\key.jks
key.keyAlias=leavesC
key.keyPassword=987654321
key.storePassword=123456789

根據(jù)配置可知，簽名文件是放在工程的 doc 文件夾內(nèi)

通過代碼獲取到簽名的各個(gè)配置項(xiàng)

Properties properties = new Properties()
properties.load(project.rootProject.file('local.properties').newDataInputStream())
def keyStorePath_ = properties.getProperty("key.keyStorePath")
def storePassword_ = properties.getProperty("key.storePassword")
def keyAlias_ = properties.getProperty("key.keyAlias")
def keyPassword_ = properties.getProperty("key.keyPassword")
def storeFile_ = file(keyStorePath_)

配置不同的簽名屬性以及 build 類型

 signingConfigs {
    release {
      storeFile storeFile_
      storePassword storePassword_
      keyAlias keyAlias_
      keyPassword keyPassword_
      v1SigningEnabled true
      v2SigningEnabled true
    }
    debug {
      storeFile storeFile_
      storePassword storePassword_
      keyAlias keyAlias_
      keyPassword keyPassword_
      v1SigningEnabled true
      v2SigningEnabled true
    }
  }

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

此處，我配置了兩種不同的 buildType ： debug 、 release ，并對(duì)應(yīng)不同的簽名文件

以后只要選定不同的 Build Variant ，即可打包具體簽名的 Apk 文件

而 local.properties 文件可以保存到服務(wù)器來實(shí)現(xiàn)遠(yuǎn)程打包，從而保證了隱私安全

三、多渠道打包

有時(shí)候，為了方便進(jìn)行精準(zhǔn)營(yíng)銷，會(huì)有生成不同渠道包的要求，此時(shí)就需要在同個(gè)應(yīng)用上打上不同的渠道ID（channelId），這可以通過 productFlavors 來實(shí)現(xiàn)

先在 AndroidManifest.xml 文件中配置占位符， appKey 即對(duì)應(yīng)各個(gè)渠道的 ID 值

 <meta-data
      android:name="APP_KEY"
      android:value="${appKey}" />

在 gradle.properties 文件中聲明需要的 ChannelId 以及對(duì)應(yīng)的 ApplicationId ，在此文件中聲明的屬性可以直接在 build.gradle 中直接獲取到

#默認(rèn)配置
defaultApplicationId=leavesc.hello.gradlesamples
##各個(gè)渠道的配置
#應(yīng)用寶
yingyongbaoChannelId="yingyongbao"
yingyongbaoApplicationId=leavesc.hello.gradlesamples.yingyongbao
yingyongbaoAppKey=appKey_yingyongbao
#豌豆莢
wandoujiaChannelId="wandoujia"
wandoujiaApplicationId=leavesc.hello.gradlesamples.wandoujia
wandoujiaAppKey=appKey_wandoujia
#小米
xiaomiChannelId="xiaomi"
xiaomiApplicationId=leavesc.hello.gradlesamples.xiaomi
xiaomiAppKey=appKey_xiaomi

productFlavors 可以理解為是對(duì)同個(gè)產(chǎn)品的不同“風(fēng)味要求”，可以根據(jù)配置項(xiàng)生成特定風(fēng)味的產(chǎn)品（App）

例如，此處就為不同渠道設(shè)定了不同的 applicationId

buildConfigField 屬性則用于在 BuildConfig.java 文件中生成特定類型的字段，此處就生成了一個(gè)類型為 String ，名為 channelId 的字段，用于方便在應(yīng)用運(yùn)行過程中判斷當(dāng)前應(yīng)用的渠道類型

manifestPlaceholders 就是用于替換 AndroidManifest.xml 文件中的指定占位符了

 productFlavors {
    yingyongbao {
      applicationId yingyongbaoApplicationId
      buildConfigField "String", "channelId", yingyongbaoChannelId
      manifestPlaceholders = [appKey: yingyongbaoAppKey]
    }
    wandoujia {
      applicationId wandoujiaApplicationId
      buildConfigField "String", "channelId", wandoujiaChannelId
      manifestPlaceholders = [appKey: wandoujiaAppKey]
    }
    xiaomi {
      applicationId xiaomiApplicationId
      buildConfigField "String", "channelId", xiaomiChannelId
      manifestPlaceholders = [appKey: xiaomiAppKey]
    }
  }

在主布局文件中展示當(dāng)前應(yīng)用的各項(xiàng)屬性值

 @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    StringBuilder sb = new StringBuilder();
    sb.append("ApplicationId: ");
    sb.append(getApplicationInfo().packageName);
    sb.append("\n");
    sb.append("ApplicationName: ");
    sb.append(getString(getApplicationInfo().labelRes));
    sb.append("\n");
    sb.append("ChannelId: ");
    sb.append(BuildConfig.channelId);
    sb.append("\n");
    try {
      ApplicationInfo appInfo = getPackageManager().getApplicationInfo(getPackageName(), PackageManager.GET_META_DATA);
      String appKey = appInfo.metaData.getString("APP_KEY");
      sb.append("AppKey: ");
      sb.append(appKey);
    } catch (PackageManager.NameNotFoundException e) {
      e.printStackTrace();
    }
    TextView tv_appInfo = findViewById(R.id.tv_appInfo);
    tv_appInfo.setText(sb);
    ImageView iv_log = findViewById(R.id.iv_log);
    iv_log.setImageResource(getApplicationInfo().icon);
  }

四、打包時(shí)指定 Apk 名字

為了方便標(biāo)識(shí)各個(gè)測(cè)試包的版本已經(jīng)打包時(shí)間，可以通過 Gradle 來指定生成的 Apk 文件的命名規(guī)則

例如，以下配置就根據(jù) buildType、flavorName 和 編譯時(shí)間 來命名 Apk 文件

applicationVariants.all { variant ->
    def buildType = variant.buildType.name
    def flavorName = variant.flavorName
    def createTime = new Date().format("YYYY-MM-dd_hh_mm_ss", TimeZone.getTimeZone("GMT+08:00"))
    variant.outputs.all {
      outputFileName = flavorName + "_" + buildType + "_v" + defaultConfig.versionName + "_" + createTime + ".apk"
    }
  }

五、生成屬性字段與資源文件值

上邊講過， buildConfigField 屬性可用于在 BuildConfig.java 文件中生成特定類型的字段，此處可以利用其來記錄應(yīng)用的編譯時(shí)間

此外，也可以利用 resValue 來生成一個(gè) ID 引用類型的 string 字符串

首先，聲明兩個(gè)方法，分別用于獲取當(dāng)前時(shí)間以及當(dāng)前電腦的用戶信息

static def buildTime() {
  return new Date().format("yyyy-MM-dd HH:mm:ss")
}

static def hostName() {
  return System.getProperty("user.name") + "@" + InetAddress.localHost.hostName
}

defaultConfig {
    applicationId defaultApplicationId
    minSdkVersion globalConfiguration["minSdkVersion"]
    targetSdkVersion globalConfiguration["targetSdkVersion"]
    versionCode globalConfiguration["versionCode"]
    versionName globalConfiguration["versionName"]
    testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    flavorDimensions '1'
    resValue "string", "build_host", hostName()
    buildConfigField "String", "build_time", "\"" + buildTime() + "\""
  }

用代碼來獲取這兩個(gè)屬性值

@Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    StringBuilder sb = new StringBuilder();
    sb.append("ApplicationId: ");
    sb.append(getApplicationInfo().packageName);
    sb.append("\n");
    sb.append("ApplicationName: ");
    sb.append(getString(getApplicationInfo().labelRes));
    sb.append("\n");
    sb.append("ChannelId: ");
    sb.append(BuildConfig.channelId);
    sb.append("\n");
    sb.append("BuildTime: ");
    sb.append(BuildConfig.build_time);
    sb.append("\n");
    sb.append("BuildUser: ");
    sb.append(getString(R.string.build_host));
    sb.append("\n");
    try {
      ApplicationInfo appInfo = getPackageManager().getApplicationInfo(getPackageName(), PackageManager.GET_META_DATA);
      String appKey = appInfo.metaData.getString("APP_KEY");
      sb.append("AppKey: ");
      sb.append(appKey);
    } catch (PackageManager.NameNotFoundException e) {
      e.printStackTrace();
    }
    TextView tv_appInfo = findViewById(R.id.tv_appInfo);
    tv_appInfo.setText(sb);
    ImageView iv_log = findViewById(R.id.iv_log);
    iv_log.setImageResource(getApplicationInfo().icon);
  }

六、替換資源文件

在多渠道打包時(shí)，除了需要在應(yīng)用中打上特定的標(biāo)簽外，也可能需要使之使用不同的資源文件，例如應(yīng)用圖標(biāo)和應(yīng)用名稱

此時(shí)可以以各個(gè) productFlavor 的名稱來命名相應(yīng)的文件夾，并在其中放置相應(yīng)的圖標(biāo)文件以及聲明了應(yīng)用名稱的 string.xml 文件，這樣在多渠道打包時(shí)，Gradle 就會(huì)自動(dòng)引用相應(yīng)的資源文件