鍍金池/ 教程/ Android/ 基本項目 - Basic Project
依賴(lài)關(guān)系,Android 庫和多項目設置 - Dependencies,Android Libraries and Multi-
要求 - Requirements
構建變種版本 - Build Variants
高級構建定制 - Advanced Build Customization
測試 - Testing
基本項目 - Basic Project
簡(jiǎn)介 - Introduction

基本項目 - Basic Project

一個(gè)Gradle項目的構建過(guò)程定義在build.gradle文件中,位于項目的根目錄下。

簡(jiǎn)單的構建文件

一個(gè)最簡(jiǎn)單的Gradle純Java項目的build.gradle文件包含以下內容:

    apply plugin: 'java'

這里引入了Gradle的Java插件。這個(gè)插件提供了所有構建和測試Java應用程序所需要的東西。

最簡(jiǎn)單的Android項目的build.gradle文件包含以下內容:

    buildscript {
        repositories {
            mavenCentral()
        }

        dependencies {
            classpath 'com.android.tools.build:gradle:0.11.1'
        }
    }

    apply plugin: 'android'

    android {
        compileSdkVersion 19
        buildToolsVersion "19.0.0"
    }

這里包括了Android build file的3個(gè)主要部分:

buildscrip{...}這里配置了驅動(dòng)構建過(guò)程的代碼。

在這個(gè)部分,它聲明了使用Maven倉庫,并且聲明了一個(gè)maven文件的依賴(lài)路徑。這個(gè)文件就是包含了0.11.1版本android gradle插件的庫。

注意:這里的配置只影響控制構建過(guò)程的代碼,不影響項目源代碼。項目本身需要聲明自己的倉庫和依賴(lài)關(guān)系,稍后將會(huì )提到這部分。

接下來(lái),跟前面提到的Java Plugin一樣添加了android plugin。

最后,andorid{...}配置了所有android構建過(guò)程需要的參數。這里也是Android DSL的入口點(diǎn)。

默認情況下,只需要配置目標編譯SDK版本和編譯工具版本,即compileSdkVersionbuildToolsVersion屬性。 這個(gè)complieSdkVersion屬性相當于舊構建系統中project.properites文件中的target屬性。這個(gè)新的屬性可以跟舊的target屬性一樣指定一個(gè)int或者String類(lèi)型的值。

重要:
你只能添加android plugin。同時(shí)添加java plugin會(huì )導致構建錯誤。

注意:
你同樣需要在相同路徑下添加一個(gè)local.properties文件,并使用sdk.dir屬性來(lái)設置SDK路徑。 另外,你也可以通過(guò)設置ANDROID_HOME環(huán)境變量,這兩種方式?jīng)]有什么不同,根據你自己的喜好選擇其中一種設置。

項目結構

上面提到的基本的構建文件需要一個(gè)默認的文件夾結構。Gradle遵循約定優(yōu)先于配置的概念,在可能的情況盡可能提供合理的默認配置參數。

基本的項目開(kāi)始于兩個(gè)名為“source sets”的組件,即main source code和test code。它們分別位于:

  • src/main/
  • src/androidTest/

里面每一個(gè)存在的文件夾對應相應的源組件。 對于Java plugin和Android plugin來(lái)說(shuō),它們的Java源代碼和資源文件路徑如下:

  • java/
  • resources/

但對于A(yíng)ndroid plugin來(lái)說(shuō),它還擁有以下特有的文件和文件夾結構:

  • AndroidManifest.xml
  • res/
  • assets/
  • aidl/
  • rs/
  • jni/

注意:
src/androidTest/AndroidManifest.xml是不需要的,它會(huì )自動(dòng)被創(chuàng )建。

配置結構

當默認的項目結構不適用的時(shí)候,你可能需要去配置它。根據Gradle文檔,重新為Java項目配置_sourceSets_可以使用以下方法:

    sourceSets {
        main {
            java {
                srcDir 'src/java'
            }
            resources {
                srcDir 'src/resources'
            }
        }
    }

注意:
srcDir將會(huì )被添加到指定的已存在的源文件夾中(這在Gradle文檔中沒(méi)有提到,但是實(shí)際上確實(shí)會(huì )這樣執行)。

替換默認的源代碼文件夾,你可能想要使用能夠傳入一個(gè)路徑數組的srcDirs來(lái)替換單一的srcDir。以下是使用調用對象的另一種不同方法:

    sourceSets {
        main.java.srcDirs = ['src/java']
        main.resources.srcDirs = ['src/resources']
    }

想要獲取更多信息,可以參考Gradle文檔中關(guān)于Java Pluign的部分。

Android Plugin使用的是類(lèi)似的語(yǔ)法。但是由于它使用的是自己的sourceSets,這些配置將會(huì )被添加在android對象中。

以下是一個(gè)示例,它使用了舊項目結構中的main源碼,并且將androidTest _sourceSet_組件重新映射到_tests_文件夾。

    android {
        sourceSets {
            main {
                manifest.srcFile 'AndroidManifest.xml'
                java.srcDirs = ['src']
                resources.srcDirs = ['src']
                aidl.srcDirs = ['src']
                renderscript.srcDirs = ['src']
                res.srcDirs = ['res']
                assets.srcDirs = ['assets']
            }

            androidTest.setRoot('tests')
        }
    }

注意:
由于舊的項目結構將所有的源文件(java,aidl,renderscripthe和java資源文件)都放在同一個(gè)目錄里面,所以我們需要將這些_sourceSet_組件重新映射到src目錄下。

注意:
setRoot()方法將移動(dòng)整個(gè)組件(包括它的子文件夾)到一個(gè)新的文件夾。示例中將會(huì )移動(dòng)src/androidTest/*tests/*下。
以上這些是Android特有的,如果配置在Java的_sourceSets_里面將不會(huì )有作用。

以上也是將舊構建系統項目遷移到新構建系統需要做的遷移工作。

構建任務(wù)

通用任務(wù)

添加一個(gè)插件到構建文件中將會(huì )自動(dòng)創(chuàng )建一系列構建任務(wù)(build tasks)去執行(注:gradle屬于任務(wù)驅動(dòng)型構建工具,它的構建過(guò)程是基于Task的)。Java plugin和Android plugin都會(huì )創(chuàng )建以下task:

  • assemble
    這個(gè)task將會(huì )組合項目的所有輸出。

  • check
    這個(gè)task將會(huì )執行所有檢查。

  • build
    這個(gè)task將會(huì )執行assemble和check兩個(gè)task的所有工作

  • clean
    這個(gè)task將會(huì )清空項目的輸出。

實(shí)際上assemble,check,build這三個(gè)task不做任何事情。它們只是一個(gè)Task標志,用來(lái)告訴android plugin添加實(shí)際需要執行的task去完成這些工作。

這就允許你去調用相同的task,而不需要考慮當前是什么類(lèi)型的項目,或者當前項目添加了什么plugin。 例如,添加了findbugs plugin將會(huì )創(chuàng )建一個(gè)新的task并且讓check task依賴(lài)于這個(gè)新的task。當check task被調用的時(shí)候,這個(gè)新的task將會(huì )先被調用。

在命令行環(huán)境中,你可以執行以下命令來(lái)獲取更多高級別的task:

    gradle tasks

查看所有task列表和它們之間的依賴(lài)關(guān)系可以執行以下命令:

    gradle tasks --all

注意:
Gradle會(huì )自動(dòng)監視一個(gè)task聲明的所有輸入和輸出。
兩次執行build task并且期間項目沒(méi)有任何改動(dòng),gradle將會(huì )使用UP-TO-DATE通知所有task。這意味著(zhù)第二次build執行的時(shí)候不會(huì )請求任何task執行。這允許task之間互相依賴(lài),而不會(huì )導致不需要的構建請求被執行。

Java 項目的 Task

Java plugin主要創(chuàng )建了兩個(gè)task,依賴(lài)于main task(一個(gè)標識性的task):

  • assemble
    • jar
      這個(gè)task創(chuàng )建所有輸出
  • check
    • test
      這個(gè)task執行所有的測試。

jar task自身直接或者間接依賴(lài)于其他task:classes task將會(huì )被調用于編譯java源碼。
testClasses task用于編譯測試,但是它很少被調用,因為test task依賴(lài)于它(類(lèi)似于classes task)。

通常情況下,你只需要調用到assemblecheck,不需要其他task。

你可以在Gradle文檔中查看java plugin的全部task。

Android 任務(wù)

Android plugin使用相同的約定以兼容其他插件,并且附加了自己的標識性task,包括:

  • assemble
    這個(gè)task用于組合項目中的所有輸出。
  • check
    這個(gè)task用于執行所有檢查。
  • connectedCheck
    這個(gè)task將會(huì )在一個(gè)指定的設備或者模擬器上執行檢查,它們可以同時(shí)在所有連接的設備上執行。
  • deviceCheck
    通過(guò)APIs連接遠程設備來(lái)執行檢查,這是在CL服務(wù)器上使用的。
  • build
    這個(gè)task執行assemble和check的所有工作。
  • clean
    這個(gè)task清空項目的所有輸出。

這些新的標識性task是必須的,以保證能夠在沒(méi)有設備連接的情況下執行定期檢查。 注意build task不依賴(lài)于deviceCheck或者connectedCheck。

一個(gè)Android項目至少擁有兩個(gè)輸出:debug APK(調試版APK)和release APK(發(fā)布版APK)。每一個(gè)輸出都擁有自己的標識性task以便能夠單獨構建它們。

  • assemble
    • assembleDebug
    • assembleRelease

它們都依賴(lài)于其它一些tasks以完成構建一個(gè)APK需要多個(gè)步驟。其中assemble task依賴(lài)于這兩個(gè)task,所以執行assemble將會(huì )同時(shí)構建出兩個(gè)APK。

小提示:
gradle在命令行終端上支持駱駝命名法的task簡(jiǎn)稱(chēng),例如,執行
gradle aR
命令等同于執行
gradle assembleRelease

check task也擁有自己的依賴(lài):

  • check
    • lint
  • connectedCheck
    • connectedAndroidTest
    • connectedUiAutomatorTest(目前還沒(méi)有應用到)
  • deviceCheck
    • 這個(gè)test依賴(lài)于test創(chuàng )建時(shí),其它實(shí)現測試擴展點(diǎn)的插件。

最后,只要task能夠被安裝(那些要求簽名的task),android plugin就會(huì )為所有構建類(lèi)型(debug,release,test)安裝或者卸載。

基本的構建定制

Android plugin提供了大量DSL用于直接從構建系統定制大部分事情。

Manifest 屬性

通過(guò)SDL可以配置一下manifest選項:

  • minSdkVersion
  • targetSdkVersion
  • versionName
  • applicationId (有效的包名 -- 更多詳情請查閱ApplicationId 對比 PackageName)
  • package Name for the test application
  • Instrumentation test runner

例如:

    android {
        compileSdkVersion 19
        buildToolsVersion "19.0.0"

        defaultConfig {
            versionCode 12
            versionName "2.0"
            minSdkVersion 16
            targetSdkVersion 16
        }
    }

android元素中的defaultConfig元素中定義所有配置。

之前的Android Plugin版本使用packageName來(lái)配置manifest文件中的packageName屬性。從0.11.0版本開(kāi)始,你需要在build.gradle文件中使用applicationId來(lái)配置manifest文件中的packageName屬性。 這是為了消除應用程序的packageName(也是程序的ID)和java包名所引起的混亂。

在構建文件中定義的強大之處在于它是動(dòng)態(tài)的。 例如,可以從一個(gè)文件中或者其它自定義的邏輯代碼中讀取版本信息:

    def computeVersionName() {
        ...
    }

    android {
        compileSdkVersion 19
        buildToolsVersion "19.0.0"

        defaultConfig {
            versionCode 12
            versionName computeVersionName()
            minSdkVersion 16
            targetSdkVersion 16
        }
    }

注意:
不要使用與在給定范圍內的getter方法可能引起沖突的方法名。例如,在defaultConfig{...}中調用getVersionName()將會(huì )自動(dòng)調用defaultConfig.getVersionName()方法,你自定義的getVersionName()方法就被取代掉了。

如果一個(gè)屬性沒(méi)有使用DSL進(jìn)行設置,一些默認的屬性值將會(huì )被使用。以下表格是可能使用到的值:

Property Name Default value in DSL object Default value
versionCode -1 value from manifest if present
versionName null value from manifest if present
minSdkVersion -1 value from manifest if present
targetSdkVersion -1 value from manifest if present
applicationId null value from manifest if present
testApplicationId null applicationId + “.test”
testInstrumentationRunner null android.test.InstrumentationTestRunner
signingConfig null null
proguardFile N/A (set only) N/A (set only)
proguardFiles N/A (set only) N/A (set only)

如果你在構建腳本中使用自定義代碼邏輯請求這些屬性,那么第二列的值將非常重要。例如,你可能會(huì )寫(xiě):

    if (android.defaultConfig.testInstrumentationRunner == null) {
        // assign a better default...
    }

如果這個(gè)值一直保持null,那么在構建執行期間將會(huì )實(shí)際替換成第三列的默認值。但是在DSL元素中并沒(méi)有包含這個(gè)默認值,所以,你無(wú)法查詢(xún)到這個(gè)值。
除非是真的需要,這是為了預防解析應用的manifest文件。

構建類(lèi)型

默認情況下,Android Plugin會(huì )自動(dòng)給項目設置同時(shí)構建應用程序的debug和release版本。 兩個(gè)版本之間的不同主要圍繞著(zhù)能否在一個(gè)安全設備上調試,以及APK如何簽名。

Debug版本采用使用通用的name/password鍵值對自動(dòng)創(chuàng )建的數字證書(shū)進(jìn)行簽名,以防止構建過(guò)程中出現請求信息。Release版本在構建過(guò)程中沒(méi)有簽名,需要稍后再簽名。

這些配置通過(guò)一個(gè)BuildType對象來(lái)配置。默認情況下,這兩個(gè)實(shí)例都會(huì )被創(chuàng )建,分別是一個(gè)debug版本和一個(gè)release版本。

Android plugin允許像創(chuàng )建其他構建類(lèi)型一樣定制debugrelease實(shí)例。這需要在buildTypes的DSL容器中配置:

    android {
        buildTypes {
            debug {
                applicationIdSuffix ".debug"
            }

            jnidebug.initWith(buildTypes.debug)
            jnidebug {
                packageNameSuffix ".jnidebug"
                jnidebugBuild true
            }
        }
    }

以上代碼片段實(shí)現了以下功能:

  • 配置默認的debug構建類(lèi)型
    • 將debug版本的包名設置為.debug以便能夠同時(shí)在一臺設備上安裝_debug_和_release_版本的apk。
  • 創(chuàng )建了一個(gè)名為jnidebug的新構建類(lèi)型,并且這個(gè)構建類(lèi)型是debug構建類(lèi)型的一個(gè)副本。
  • 繼續配置jnidebug構建類(lèi)型,允許使用JNI組件,并且也添加了不一樣的包名后綴。

創(chuàng )建一個(gè)新的構建類(lèi)型就是簡(jiǎn)單的在buildType標簽下添加一個(gè)新的元素,并且可以使用initWith()或者直接使用閉包來(lái)配置它。

以下是一些可能使用到的屬性和默認值:

Property name Default values for debug Default values for release / other
debuggable true false
jniDebugBuild false false
renderscriptDebugBuild false false
renderscriptOptimLevel 3 3
applicationIdSuffix null null
versionNameSuffix null null
signingConfig android.signingConfigs.debug null
zipAlign false true
runProguard false false
proguardFile N/A (set only) N/A (set only)
proguardFiles N/A (set only) N/A (set only)

除了以上屬性之外,_Build Type_還會(huì )受項目源碼和資源影響: 對于每一個(gè)Build Type都會(huì )自動(dòng)創(chuàng )建一個(gè)匹配的sourceSet。默認的路徑為:

    src/<buildtypename>/

這意味著(zhù)_BuildType_名稱(chēng)不能是_main_或者androidTest(因為這兩個(gè)是由plugin強制實(shí)現的),并且他們互相之間都必須是唯一的。

跟其他sourceSet設置一樣,Build Type的source set路徑可以重新被定向:

    android {
        sourceSets.jnidebug.setRoot('foo/jnidebug')
    }

另外,每一個(gè)_Build Type_都會(huì )創(chuàng )建一個(gè)新的assemble任務(wù)。

assembleDebugassembleRelease兩個(gè)Task在上面已經(jīng)提到過(guò),這里要講這兩個(gè)Task從哪里被創(chuàng )建。當debugrelease構建類(lèi)型被預創(chuàng )建的時(shí)候,它們的tasks就會(huì )自動(dòng)創(chuàng )建對應的這個(gè)兩個(gè)Task。

上面提到的build.gradle代碼片段中也會(huì )實(shí)現assembleJnidebug task,并且assemble會(huì )像依賴(lài)于assembleDebugassembleRelease一樣依賴(lài)于assembleJnidebug。

提示:你可以在終端下輸入gradle aJ去運行assembleJnidebug task。

可能會(huì )使用到的情況:

  • release模式不需要,只有debug模式下才使用到的權限
  • 自定義的debug實(shí)現
  • 為debug模式使用不同的資源(例如當資源的值由綁定的證書(shū)決定)

_BuildType_的代碼和資源通過(guò)以下方式被使用:

  • manifest將被混合進(jìn)app的manifest
  • 代碼行為只是另一個(gè)資源文件夾
  • 資源將疊加到main的資源中,并替換已存在的資源。

簽名配置

對一個(gè)應用程序簽名需要以下:

  • 一個(gè)Keystory
  • 一個(gè)keystory密碼
  • 一個(gè)key的別名
  • 一個(gè)key的密碼
  • 存儲類(lèi)型

位置,鍵名,兩個(gè)密碼,還有存儲類(lèi)型一起形成了簽名配置。

默認情況下,debug被配置成使用一個(gè)debug keystory。 debug keystory使用了默認的密碼和默認key及默認的key密碼。 debug keystory的位置在$HOME/.android/debug.keystroe,如果對應位置不存在這個(gè)文件將會(huì )自動(dòng)創(chuàng )建一個(gè)。

debug Build Type(構建類(lèi)型) 會(huì )自動(dòng)使用debug SigningConfig (簽名配置)。

可以創(chuàng )建其他配置或者自定義內建的默認配置。通過(guò)signingConfigs這個(gè)DSL容器來(lái)配置:

    android {
        signingConfigs {
            debug {
                storeFile file("debug.keystore")
            }

            myConfig {
                storeFile file("other.keystore")
                storePassword "android"
                keyAlias "androiddebugkey"
                keyPassword "android"
            }
        }

        buildTypes {
            foo {
                debuggable true
                jniDebugBuild true
                signingConfig signingConfigs.myConfig
            }
        }
    }

以上代碼片段修改debug keystory的路徑到項目的根目錄下。在這個(gè)例子中,這將自動(dòng)影響其他使用到debug構建類(lèi)型的構建類(lèi)型。

這里也創(chuàng )建了一個(gè)新的Single Config(簽名配置)和一個(gè)使用這個(gè)新簽名配置的新的Build Type(構建類(lèi)型)。

注意:只有默認路徑下的debug keystory不存在時(shí)會(huì )被自動(dòng)創(chuàng )建。更改debug keystory的路徑并不會(huì )自動(dòng)在新路徑下創(chuàng )建debug keystory。如果創(chuàng )建一個(gè)新的不同名字的SignConfig,但是使用默認的debug keystore路徑來(lái)創(chuàng )建一個(gè)非默認的名字的SigningConing,那么還是會(huì )在默認路徑下創(chuàng )建debug keystory。換句話(huà)說(shuō),會(huì )不會(huì )自動(dòng)創(chuàng )建是根據keystory的路徑來(lái)判斷,而不是配置的名稱(chēng)。

注意:雖然經(jīng)常使用項目根目錄的相對路徑作為keystore的路徑,但是也可以使用絕對路徑,盡管這并不推薦(除了自動(dòng)創(chuàng )建出來(lái)的debug keystore)。

注意:如果你將這些文件添加到版本控制工具中,你可能不希望將密碼直接寫(xiě)到這些文件中。下面Stack Overflow鏈接提供從控制臺或者環(huán)境變量中獲取密碼的方法:
http://stackoverflow.com/questions/18328730/how-to-create-a-release-signed-apk-file-using-gradle
我們以后還會(huì )在這個(gè)指南中添加更多的詳細信息。

運行 Proguard

從Gradle Plugin for ProGuard version 4.10之后就開(kāi)始支持ProGuard。ProGuard插件是自動(dòng)添加進(jìn)來(lái)的。如果_Build Type_的_runProguard_屬性被設置為true,對應的task將會(huì )自動(dòng)創(chuàng )建。

    android {
        buildTypes {
            release {
                runProguard true
                proguardFile getDefaultProguardFile('proguard-android.txt')
            }
        }

        productFlavors {
            flavor1 {
            }
            flavor2 {
                proguardFile 'some-other-rules.txt'
            }
        }
    }

發(fā)布版本將會(huì )使用它的Build Type中聲明的規則文件,product flavor(定制的產(chǎn)品版本)將會(huì )使用對應flavor中聲明的規則文件。

這里有兩個(gè)默認的規則文件:

  • proguard-android.txt
  • proguard-android-optimize.txt

這兩個(gè)文件都在SDK的路徑下。使用_getDefaultProguardFile()_可以獲取這些文件的完整路徑。它們除了是否要進(jìn)行優(yōu)化之外,其它都是相同的。

精簡(jiǎn)資源

你能夠在編譯的時(shí)候自動(dòng)化地移除不用的資源。更多的信息,請看文檔 Resource Shrinking