Gradle for Android 第四篇( 構(gòu)建變體 )
當(dāng)你在開發(fā)一個(gè)app,通常你會(huì)有幾個(gè)版本。大多數(shù)情況是你需要一個(gè)開發(fā)版本，用來測(cè)試app和弄清它的質(zhì)量，然后還需要一個(gè)生產(chǎn)版本。這些版本通常有不同的設(shè)置，例如不同的URL地址。更可能的是你可能需要一個(gè)免費(fèi)版和收費(fèi)版本。基于上述情況，你需要處理不同的版本：開發(fā)免費(fèi)版，開發(fā)付費(fèi)版本，生產(chǎn)免費(fèi)版，生產(chǎn)付費(fèi)版，而針對(duì)不同的版本不同的配置，這極大增加的管理難度。
Gradle有一些方便的方法來管理這些問題。我們很早之前談過debug和release版本，現(xiàn)在我們談到另外一個(gè)概念，不同的產(chǎn)品版本。構(gòu)建版本和生產(chǎn)版本通常可以合并，構(gòu)建版本和生產(chǎn)版本的合并版叫做構(gòu)建變種。
這一章我們將學(xué)習(xí)構(gòu)建版本，它能使得開發(fā)更有效率，并且學(xué)習(xí)如何使用它們。然后我們會(huì)討論構(gòu)建版本和生產(chǎn)版本的不同，以及如何將其合并。我們會(huì)探討簽名機(jī)制，如何針對(duì)不同的變種簽名等。
在這一章，我們遵循如下規(guī)則：
- Build types
- Product flavors
- Build variants
- Signing configurations
構(gòu)建版本
在Gradle的Android插件中，一個(gè)構(gòu)建版本意味著定義一個(gè)app或者依賴庫(kù)如何被構(gòu)建。每個(gè)構(gòu)建版本都要特殊的一面，比如是否需要debug，application id是什么，是否不需要的資源被刪除等等。你可以定義一個(gè)構(gòu)建版本通過buildTypes方法。例如：
- android {
- buildTypes {
- release {
- minifyEnabled false
- proguardFiles getDefaultProguardFile
- ('proguard-android.txt'), 'proguard-rules.pro'
- }
- }
- }
這個(gè)文件定義了該模塊是release版本，然后定義了proguard的位置。該release版本不是唯一的構(gòu)建版本，默認(rèn)情況下，還有個(gè)debug版本。Android studio把它視為默認(rèn)構(gòu)建版本。
創(chuàng)建自己的構(gòu)建版本
當(dāng)默認(rèn)的構(gòu)建版本不夠用的時(shí)候，創(chuàng)建版本也是很容易的一件事，創(chuàng)建構(gòu)建版本你只需要在buildTypes寫入自己的版本。如下所示：
- android {
- buildTypes {
- staging {
- applicationIdSuffix ".staging"
- versionNameSuffix "-staging"
- buildConfigField "String", "API_URL",
- "\"http://staging.example.com/api\""
- }
- }
- }
我們定義了一個(gè)staging版本，該版本定義了一個(gè)新的application id，這讓其與debug和release版本的applicationID不同。假設(shè)你使用了默認(rèn)的配置，那么applicationID將會(huì)是這樣的：
- Debug: com.package
- Release: com.package
- Staging: com.package.staging
這意味著你可以在你的設(shè)備上安裝staging版本和release版本。staging版本也有自己的版本號(hào)。buildConfigField定義了一個(gè)新的URL地址。你不必事事都去創(chuàng)建，所以最可能的方式是去繼承已有的版本。
- android {
- buildTypes {
- staging.initWith(buildTypes.debug)
- staging {
- applicationIdSuffix ".staging"
- versionNameSuffix "-staging"
- debuggable = false
- }
- }
- }
initWith()方法創(chuàng)建了一個(gè)新的版本的同時(shí)，復(fù)制所有存在的構(gòu)建版本，類似繼承。我們也可以復(fù)寫該存在版本的所有屬性。
Source sets
當(dāng)你創(chuàng)建了一個(gè)新的構(gòu)建版本，Gradle也創(chuàng)建了新的source set。默認(rèn)情況下，該文件夾不會(huì)自動(dòng)為你創(chuàng)建，所有你需要手工創(chuàng)建。
- app
- └── src
- ├── debug
- │ ├── java
- │ │ └── com.package
- │ │
- │ ├── res
- │ │ └── layout
- │ │ └── activity_main.xml
- │ └── AndroidManifest.xml
- ├── main
- │ ├── java
- │ │ └── com.package
- │ │
- │ ├── res
- └── MainActivity.java
- └── Constants.java
- │ │
- │ │
- │ │
- │ └── AndroidManifest.xml
- ├── staging
- │ ├── java
- │ │ └── com.package
- ├── drawable
- └── layout
- └── activity_main.xml
- │ │
- │ ├── res
- │ │ └── layout
- │ │ └── activity_main.xml
- │ └── AndroidManifest.xml
- └── release
- ├── java
- │ └── com.package
- │ └── Constants.java
- └── AndroidManifest.xml
注意：當(dāng)你添加一個(gè)Java類的時(shí)候，你需要知道以下過程，當(dāng)你添加了CustomLogic.java到staging版本，你可以添加相同的類到debug和release版本，但是不能添加到main版本。如果你添加了，會(huì)拋出異常。
當(dāng)使用不同的source sets的時(shí)候，資源文件的處理需要特殊的方式。Drawables和layout文件將會(huì)復(fù)寫在main中的重名文件，但是values文件下的資源不會(huì)。gradle將會(huì)把這些資源連同main里面的資源一起合并。
舉個(gè)例子，當(dāng)你在main中創(chuàng)建了一個(gè)srings.xml的時(shí)候：
- <resources>
- <string name="app_name">TypesAndFlavors</string>
- <string name="hello_world">Hello world!</string>
- </resources>
當(dāng)你在你的staing版本也添加了rings.xml：
- <resources>
- <string name="app_name">TypesAndFlavors STAGING</string>
- </resources>
然后合并的strings.xml將會(huì)是這樣的：
- <resources>
- <string name="app_name">TypesAndFlavors STAGING</string>
- <string name="hello_world">Hello world!</string>
- </resources>
當(dāng)你創(chuàng)建一個(gè)新的構(gòu)建版本而不是staging，最終的strings.xml將會(huì)是main目錄下的strings.xml。
manifest也和value文件下的文件一樣。如果你為你的構(gòu)建版本創(chuàng)建了一個(gè)manifest文件，那么你不必要去拷貝在main文件下的manifest文件，你需要做的是添加標(biāo)簽。Android插件將會(huì)為你合并它們。
我們將在會(huì)之后的章節(jié)講到合并的更多細(xì)節(jié)。
依賴包
每一個(gè)構(gòu)建版本都有自己的依賴包，gradle自動(dòng)為每一個(gè)構(gòu)建的版本創(chuàng)建不同的依賴配置。如果你想為debug版本添加一個(gè)logging框架，你可以這么做：
- dependencies {
- compile fileTree(dir: 'libs', include: ['*.jar'])
- compile 'com.android.support:appcompat-v7:22.2.0'
- debugCompile 'de.mindpipe.android:android-logging-log4j:1.0.3'
- }
你可以結(jié)合不同的構(gòu)建版本著不同的構(gòu)建配置，就像這種方式，這讓你的不同版本的不同依賴包成為可能。
product flavors
和構(gòu)建版本不同，product flavors用來為一個(gè)app創(chuàng)建不同版本。典型的例子是，一個(gè)app有付費(fèi)和免費(fèi)版。product flavors極大簡(jiǎn)化了基于相同的代碼構(gòu)建不同版本的app。
如果你不確定你是否需要一個(gè)新的構(gòu)建版本或者product flavors，你應(yīng)該問你自己，你是否需要內(nèi)部使用和外部使用的apk。如果你需要一個(gè)完全新的app去發(fā)布，和之前的版本完全隔離開，那么你需要product flavors。否則你只是需要構(gòu)建版本。
創(chuàng)建product flavors
創(chuàng)建product flavors非常的容易。你可以在productFlavors中添加代碼：
- android {
- productFlavors {
- red {
- applicationId 'com.gradleforandroid.red'
- versionCode 3
- }
- blue {
- applicationId 'com.gradleforandroid.blue'
- minSdkVersion 14
- versionCode 4
- }
- }
- }
product flavors和構(gòu)建版本的配置不同。因?yàn)閜roduct flavors有自己的ProductFlavor類，就像defaultConfig，這意味著你的所有productFlavors都分享一樣的屬性。
Source sets
就像構(gòu)建版本一樣，product Flavors也有自己的代碼文件夾。創(chuàng)建一個(gè)特殊的版本就像創(chuàng)建一個(gè)文件夾那么簡(jiǎn)單。舉個(gè)例子，當(dāng)你有的生產(chǎn)版本的blue flavors有一個(gè)不同的app圖標(biāo)，該文件夾需要被叫做blueRelease。
多個(gè)flavors構(gòu)建變體
在一些例子中，你可能需要?jiǎng)?chuàng)建一些product flavors的合并版本。舉個(gè)例子，client A和client B可能都想要一個(gè)free和paid的版本，而他們又都是基于一樣的代碼，但是有不一樣的顏色等。創(chuàng)建四個(gè)不同的flavors意味著有重復(fù)的配置。合并flavors最簡(jiǎn)單的做法可能是使用flavor dimensions，就像這樣：
- android {
- flavorDimensions "color", "price"
- productFlavors {
- red {
- flavorDimension "color"
- }
- blue {
- flavorDimension "color"
- }
- free {
- flavorDimension "price"
- }
- paid {
- flavorDimension "price"
- }
- }
- }
當(dāng)你添加了flavor dimensions，你就需要為每個(gè)flavor添加flavorDimension，否則會(huì)提示錯(cuò)誤。flavorDimensions定義了不同的dimensions，當(dāng)然其順序也很重要。當(dāng)你合并二個(gè)不同的flavors時(shí)，他們可能有一樣的配置和資源。例如上例：
- blueFreeDebug and blueFreeRelease
- bluePaidDebug and bluePaidRelease
- redFreeDebug and redFreeRelease
- redPaidDebug and redPaidRelease
構(gòu)建變體
構(gòu)建變體是構(gòu)建版本和生產(chǎn)版本的結(jié)合體。當(dāng)你創(chuàng)建了一個(gè)構(gòu)建版本或者生產(chǎn)版本，同樣的，新的變體也會(huì)被創(chuàng)建。舉個(gè)例子，當(dāng)你有debug和release版本，你創(chuàng)建了red和blue的生產(chǎn)版本，那么變體將會(huì)有四個(gè)：
你可以在Android studio的左下角找到它，或者通過VIEW|Tool Windows|Build Variants打開它。該視圖列出了所有的變體，并且允許你去切換它們。改變他們將會(huì)影響到你按Run按鈕。
如果你沒有product flavors，那么變體只是簡(jiǎn)單的包含構(gòu)建版本，就算你沒有定義任何構(gòu)建版本，Android studio也會(huì)默認(rèn)為你創(chuàng)建debug版本的。
tasks
android插件回味每一個(gè)變體創(chuàng)建不同的配置。一個(gè)新的Android項(xiàng)目會(huì)有debug和release版本，所有你可以使用assembleDebug和assembleRelease，當(dāng)然當(dāng)你使用assemble命令，會(huì)二者都執(zhí)行。當(dāng)你添加了一個(gè)新的構(gòu)建版本，新的task也會(huì)被創(chuàng)建。例如：
- assembleBlue uses the blue flavor configuration and assembles both BlueRelease and BlueDebug.
- assembleBlueDebug combines the flavor configuration with the build type configuration, and the flavor settings override the build type settings.
Source sets
構(gòu)建變體也可以有自己的資源文件夾，舉個(gè)例子，你可以有src/blueFreeDebug/java/。
資源文件和manifest的合并
在打包app之前，Android插件會(huì)合并main中的代碼和構(gòu)建的代碼。當(dāng)然，依賴項(xiàng)目也可以提供額外的資源，它們也會(huì)被合并。你可能需要額外的Android權(quán)限針對(duì)debug變體。舉個(gè)例子，你不想在main中申明這個(gè)權(quán)限，因?yàn)檫@可能導(dǎo)致一些問題，所以你可以添加一個(gè)額外的mainfest文件在debug的文件夾中，申明額外的權(quán)限。
資源和mainfests的優(yōu)先級(jí)是這樣的：
如果一個(gè)資源在main中和在flavor中定義了，那么那個(gè)在flavor中的資源有更高的優(yōu)先級(jí)。這樣那個(gè)在flavor文件夾中的資源將會(huì)被打包到apk。而在依賴項(xiàng)目申明的資源總是擁有***優(yōu)先級(jí)。
創(chuàng)建構(gòu)建變體
gradle讓處理構(gòu)建變體變得容易。
- android {
- buildTypes {
- debug {
- buildConfigField "String", "API_URL",
- "\"http://test.example.com/api\""
- }
- staging.initWith(android.buildTypes.debug)
- staging {
- buildConfigField "String", "API_URL",
- "\"http://staging.example.com/api\""
- applicationIdSuffix ".staging"
- }
- }
- productFlavors {
- red {
- applicationId "com.gradleforandroid.red"
- resValue "color", "flavor_color", "#ff0000"
- }
- blue {
- applicationId "com.gradleforandroid.blue"
- resValue "color", "flavor_color", "#0000ff"
- }
- }
- }
在這個(gè)例子中，我們創(chuàng)建了4個(gè)變體，分別是blueDebug，blueStaging，redDebug，redStaging。每一個(gè)變體都有其不同的api url以及顏色。例如：
變體過濾器
忽略某個(gè)變體也是可行的。這樣你可以加速你的構(gòu)建當(dāng)使用assemble的時(shí)候，這樣你列出的tasks將不會(huì)執(zhí)行那么你不需要的變體。你可以使用過濾器，在build.gradle中添加代碼如下所示：
- android.variantFilter { variant ->
- if(variant.buildType.name.equals('release')) {
- variant.getFlavors().each() { flavor ->
- if (flavor.name.equals('blue')) { variant.setIgnore(true);
- }
- }
- }
- }
在這個(gè)例子中，我們檢查下：
你可以看到blueFreeRelease和bluePaidRelease被排除在外，如果你運(yùn)行g(shù)radlew tasks，你會(huì)發(fā)現(xiàn)所有的關(guān)于上述變體的tasks不再存在。
簽名配置
在你發(fā)布你的應(yīng)用之前，你需要為你的app私鑰簽名。如果你有付費(fèi)版和免費(fèi)版，你需要有不同的key去簽名不同的變體。這就是配置簽名的好處。配置簽名可以這樣定義：
- android {
- signingConfigs {
- staging.initWith(signingConfigs.debug)
- release {
- storeFile file("release.keystore")
- storePassword"secretpassword"
- keyAlias "gradleforandroid"
- keyPassword "secretpassword"
- }
- }
- }
在這個(gè)例子中，我們創(chuàng)建了2個(gè)不同的簽名配置。debug配置是as默認(rèn)的，其使用了公共的keystore和password，所以沒有必要為debug版本創(chuàng)建簽名配置了。staging配置使用了initWith()方法，其會(huì)復(fù)制其他的簽名配置。這意味著staging和debug的key是一樣的。
release配置使用了storeFile，定義了key alias和密碼。當(dāng)然這不是一個(gè)好的選擇，你需要在 Gradle properties文件中配置。
當(dāng)你定義了簽名配置后，你需要應(yīng)用它們。構(gòu)建版本都有一個(gè)屬性叫做signingConfig，你可以這么干：
- android {
- buildTypes {
- release {
- signingConfig signingConfigs.release
- }
- }
- }
上例使用了buildTypes，但是你可能需要對(duì)每個(gè)版本生成不同的驗(yàn)證，你可以這么定義：
- android {
- productFlavors {
- blue {
- signingConfig signingConfigs.release
- }
- }
- }
當(dāng)然，你在flavor中定義這些，***會(huì)被重寫，所以***的做法是：
- android {
- buildTypes {
- release {
- productFlavors.red.signingConfig signingConfigs.red
- productFlavors.blue.signingConfig signingConfigs.blue
- }
- }
- }
總結(jié)
在這一章，我們討論了構(gòu)建版本和生產(chǎn)版本，以及如何結(jié)合它們。這將會(huì)是非常有用的工具，當(dāng)你需要不同的url以及不同的keys，而你們有相同的代碼和資源文件，但是有不同的類型以及版本，構(gòu)建版本和生產(chǎn)版本將會(huì)讓你的生活更美好。
我們也談?wù)摿撕灻渲靡约叭绾问褂盟麄儭?/p>
下一章，你將會(huì)學(xué)習(xí)到多模塊構(gòu)建，因?yàn)楫?dāng)你想把你的代碼分成一個(gè)依賴包或者依賴項(xiàng)目的時(shí)候，或者你想把Android wear模塊放在你的應(yīng)用的時(shí)候，這將非常重要。
