【译】从现在开始，玩转Android Studio系列：Gradle

本文翻译自：http://developer.android.com/tools/building/configuring-gradle.html

基本的构建配置

Android Studio项目包含了一个顶级的构建文件和适用于每个模块的构建文件。这些构建文件被命名为 build.gradle,这些都是纯文本文件，使用了Groovy语法并结合了Android plugin for Gradle提供的标签来配置项目的构建。多数情况下，你只需要编辑模块级别的构建文件。例如，BuildSystemExample 项目中的app模块下的构建文件：

注：BuildSystemExample 项目源码：点击下载

apply plugin: 'com.android.application'

android {
    compileSdkVersion 19
    buildToolsVersion "19.0.0"

    defaultConfig {
        minSdkVersion 8
        targetSdkVersion 19
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    compile project(":lib")
    compile 'com.android.support:appcompat-v7:19.0.1'
    compile fileTree(dir: 'libs', include: ['*.jar'])
}

apply plugin: 'com.android.application' 应用了Android plugin for Gradle来进行构建。它给顶级构建任务添加了特定于Android的构建任务，并且让android{...}标签可以用来指定特定于Android的构建参数。

android {...} 配置了所有的特定于Android的构建参数：

compileSdkVersion：指定了编译版本；
buildToolsVersion：指定了使用的构建工具的版本。可以通过SDK Manager来安装几个版本的构建工具

提示：构建工具的主版本号必须高于或等于使用的编译版本号和SDK版本号。

defaultConfig ：动态地从构建系统中配置核心的设置和清单文件中的条目。该值会在清单文件中重写。defaultConfig 中的配置适用于所有的构建变体，除非构建变体中重写了这些值。
buildTypes ：控制了如何构建和打包你的app。默认情况下，构建系统定义了两种类型：debug和release。dubug模式包含了调试符号，并且使用debug key进行签名。release模式不会进行默认签名。示例中，构建文件使用了ProGuard来配置release版本。

dependencies 标签是在android标签的外面和下面。它声明了该模块的依赖。这个在下面谈。

提示：当你修改了项目的构建文件，Android Studio 要求项目同步（Sync）来导入构建配置的改变。单击黄色通知栏的“Sync Now”。

【译】从现在开始，玩转Android Studio系列：Gradle_第1张图片

as-gradlesync.png

声明依赖

在示例中的app模块，生命了三个依赖：

...
dependencies {
    // Module dependency
    compile project(":lib")

    // Remote binary dependency
    compile 'com.android.support:appcompat-v7:19.0.1'

    // Local binary dependency
    compile fileTree(dir: 'libs', include: ['*.jar'])
}

每个依赖都会在下面详细描述。构建系统添加了所有的compile依赖到编译的classpath中并把它们包含到final package中。

模块依赖

app模块依赖于lib模块，因为MainActivity启动了LibActivity1，这个在 Open an Activity from a Library Module中描述了。

compile project(":lib") 声明了BuildSystemExample的lib模块的依赖。当你构建app模块时，构建系统会聚集和包含lib模块。

远端二进制依赖

app模块和lib模块都使用了Android Support Library中的ActionBarActivity 类，所以这些模块依赖于它。

compile 'com.android.support:appcompat-v7:19.0.1' 通过制定Maven库坐标，声明了一个版本为19.0.1的Android Support Library依赖。Android Support Library位于Android SDK中的Android Repository包，如果你的安装的SDK没有这个包，可以用SDK Manager类下载和安装。

本地二进制依赖

有些模块没有使用任何本地文件系统中的二进制依赖。如果有模块需要用到本地二进制依赖，复制下JAR文件到项目中的/libs。

compile fileTree(dir: 'libs', include: ['*.jar'])告诉了构建系统在app/libs下的JAR 文件是依赖，并且应该被包含进编译classpath和final package。

更多有关Gradle依赖的信息，参见Gradle用户引导的 Dependency Management Basics

运行ProGuard

构建系统可以在构建过程中运行ProGuard 来混淆类名。在BuildSystemExample中，修改app模块中的构建文件来生意哦那个release模式运行ProGuard。

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

getDefaultProguardFile('proguard-android.txt') 从Android SDK安装位置获取默认的混淆器设置。 Android Studio在模块的根目录加入了特定于模块的规则文件proguard-rules.pro，可以在这里添加自定义的混淆规则。

用于标识包的Application ID

在Android构建系统中，applicationId 属性是用来唯一标识发布的应用包。应用ID是在build.gradle文件中的android标签中设置的。

apply plugin: 'com.android.application'

    android {
        compileSdkVersion 19
        buildToolsVersion "19.1"

    defaultConfig {
        applicationId "com.example.my.app"
        minSdkVersion 15
        targetSdkVersion 19
        versionCode 1
        versionName "1.0"
    }
    ...

提示：applicationId 只需要在build.gradle中指定，而不是在AndroidManifest.xml中

当使用构建变体时，构建系统允许你给每一个定制的版本指定唯一标识的不同的包名和构建类型。构建类型中的应用id是以后缀形式添加的，省略的部分在定制版本中指定了。

productFlavors {
        pro {
            applicationId = "com.example.my.pkg.pro"
        }
        free {
            applicationId = "com.example.my.pkg.free"
        }
    }

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

包名还是必须在清单文件中指定的。它用于在源代码中涉及到R类和解析相关的 activity或service注册。

package="com.example.app">

提示：如果有多个清单文件（比如，一个定制版本指定的清单文件和一个构建类型的清单文件），那么包名在这些清单文件中是可选的。如果，要在这些清单文件中指定包名，那么包名必须跟在src/main文件夹中指定的包名一致。

更多有关构建文件和过程的信息，参加Build System Overview.

配置签名设置

debug和release版本的app在应用是否能被安全的设备调试和APK如何被签名上是不同的。构建系统使用一个默认的key和证书来签名debug版本，使用已知的证书是为了避免在构建时的密码提示。构建系统不会给release版本自动签名，除非你在构建文件中明确定义了一个签名配置。如果你没有一个release key，你可以参见Signing your Applications来生成一个。

使用构建变体工作

这部分构建系统如何帮助你从单一的项目中给同一个应用创建不同的版本。这个对于有演示版本和收费版本之分，或者想要在Google Play分成多个APK适用不同设备的配置的app很有用。

构建系统使用product flavors来创建app的不同产品版本。app的每个产品版本有不同的特性或设备要求。构建系统也使用构架类型来给每个产品版本应用不同的构建和打包的设置。每个定制产品和构建类型的组合构成了一个构建变体。构建系统会给app每一个的构建变体生成一个不同的APK。

构建变体

示例项目中包含了两种默认的构建类型（debug和release）和两种定制的app版本（demo和full）。更多有关构建变体的信息，参见Build System Overview

定制版本

创建定制版本的步骤：

在构建文件中定义定制版本；
给每个定制版本创建额外的源目录；
添加特定于定制版本的源到项目中。

接下来，用BuildSystemExample 项目带着你详细地走一边这些步骤。
你给BuildSystemExample app创建了两个定制版本，一个演示版（demo）和一个完整版（full）。定制版本间共享了MainActivity，在MainActivity中你添加了一个按钮来启动一个新的activity，SecondActivity。这个新的activity是每个定制版本都不同的，所以你要模拟一个场景，就是新创建的activity中，full版的要比demo版的有更多的特性。练习结束后，你就可以完成两个不同的APK的生成，每个代表一个定制版本。

在构建文件中定义定制版本

为了定义两个定制版本，需要编辑app模块的构建文件，添加下面的配置信息：

...
android {
    ...
    defaultConfig { ... }
    signingConfigs { ... }
    buildTypes { ... }
    productFlavors {
        demo {
            applicationId "com.buildsystemexample.app.demo"
            versionName "1.0-demo"
        }
        full {
            applicationId "com.buildsystemexample.app.full"
            versionName "1.0-full"
        }
    }
}
...

这些定制版本的定义支持相同的属性，比如defaultConfig。给所有定制版本的基本的设置就是在defaultConfig中指定的，各个定制版本可以重写其中的默认值。上面的构建文件使用applicationId 属性来给每个定制版本指定一个不同的包名：因为每个定制版本需要创建一个不同的app，所以需要不同的包名。

提示：为了在Google Play上使用Multiple APK Support来分发app，需要给每一个变体分配一个相同的包名但是versionCode不同。为了在Google Play上单独地分发每一个变体，需要给每个变体分配一个不同的包名。

给每个定制版本创建额外的源目录

现在你创建了一个源目录并且给每个定制版本添加了一个 SecondActivity 。为了创建给demo版创建源目录结构，你应该：

在Project面板，展开BuildSystemExample，再展开app目录；
右击app下的src目录，选择New > Directory；
输入demo作为新目录的名字并点击OK；
同理，创建下面的目录：
- app/src/demo/java
- app/src/demo/res
- app/src/demo/res/layout
- app/src/demo/res/values

最终的目录结构如下图。

【译】从现在开始，玩转Android Studio系列：Gradle_第2张图片

as-demoflavordirs.png

给每个定制版本添加一个新的activity

给demo版添加SecondActivity ：

在Project面板，在app模块下右击，选择New > Activity；
选择 Blank Activity 并单击Next；
输入"SecondActivity" 作为activity名；
输入 "com.buildsystemexample.app" 作为包名，并单击Finish；
在app/src/demo下的java目录右击并选择 New > Package；
输入 "com.buildsystemexample.app" 作为包名并单击OK；
拖动SecondActivity到在app/src/demo/java中新创建的包；
接受默认值并点击Refactor；

给demo版添加布局和字符串资源：

从app/src/main/res/layout中移动activity_second.xml到app/src/demo/res/layout去；
接受窗口显示的默认值并单击OK；
从app/src/main/res复制strings.xml到app/src/demo/res
替换新复制的strings.xml的内容，如下：



    Demo version only.

现在，你可以通过复制demo版来给full版添加源目录和SecondActivity ：

在Project面板，右击 app/src下的demo目录，选择Copy；
在app/src/下右击，并选择Paste；
在弹出的窗口中，输入“full”作为新的名字，并单击OK；
替换src/full/res/values下的strings.xml的内容，如下：



    This is the full version!

提示：从现在开始，你可以独立开发SecondActivity，它在每个定制版中是独立的。例如，你可以给full版添加额外的特性都这个activity中。

为了让特定的版本生效，点击IDE左侧的Build Variants窗口并选择你想要修改的定制版本，如下图所示。Android Studio可能在一个Build Variants面板中没有选择的那一个定制版本的源文件中会显示错误，但是这不会影响构建的输出。

【译】从现在开始，玩转Android Studio系列：Gradle_第3张图片

as-buildvariants.png

从MainActivity中启动特定于定制版本的activity

由于特定于定制版本的activity（SecondActivity）在所有定制版本中有着相同的包名和activity名，你可以从MainActivity中启动它。修改MainActivity如下：

编辑activity_main.xml并添加一个按钮到MainActivity中：

...
android:id="@+id/button2"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="@string/button2"
android:onClick="onButton2Clicked"/>


2. 点击布局文件中红色标注的区域并按Alt+Enter。跟随者Android Studio的建议，使用值 “Open Second Activity”添加一个新的字符串资源，并添加onButton2Clicked方法到MainActivity。

3. 添加下面的代码到MainActivity中的onButton2Clicked：

public void onButton2Clicked(View view) {
Intent intent = new Intent(this, SecondActivity.class);
startActivity(intent);
}


4. 编辑app的清单文件，包含进SecondActivity的记录：
    ```

    
        ...

构建类型

构建类型代表着为每个app包生成的构建包版本。默认提供debug和release构建类型。

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

提示：虽然在build.gradle文件中只显示了release构建类型，但是release和debug构建类型都适用于每次构建。

在示例中，产品的定制版本和构建类型产生了下面的构建变体：

demoDebug
demoRelease
fullDebug
fullRelease

为了构建示例项目，点击 Android Studio中的Build菜单选项或者从命令行中调用assemble任务。

提示：Build > Make Project 选项会编译自从上次编译后被修改的整个项目的所有文件。Build > Rebuild Project选项会重新编译项目中的所有文件。

单独的输出文件夹会被每个构建变体创建。

Android Studio 配置项目默认使用 Maven Central Repository（Maven中心仓库）。（这个配置被项目的顶级构建文件包含）