Gradle - 构建的基本知识

本文是官网的个人简略版。

构建过程

官网上的图:

image.png

在生成最终的 APK 之前,packager 还会用 zipalign 来对 app 进行优化以减少运行时的占用内存。

自定义构建配置

利用 Gradle 和 Android 插件,可以从以下几方面对编译进行配置:

  • Build Types
    通常用于不同开发周期的配置,Android Studio 默认会创建 debug 和 release 两种编译类型。
  • Product Flavors
    用于为用户提供不同的 app 版本,如免费和收费版。
  • Build Variants
    Gradle 用于编译 app 的配置,build variant 由 build type 和 product flavor 共同产生。我们不直接配置 build variant,但通过 build type 和 product flavor 将生成 build variant。
  • Manifest Entries
    我们可以在 build variant 配置(也就是 build type 和 product flavor 的配置)中指定 manifest 文件某些属性的值,如应用名、最小 SDK、target SDK 等。
  • Dependencies
    本地或远程依赖。
  • Signing
    在编译配置中指定签名设置并在构建过程中自动为 apk 签名。
  • ProGuard
    可以为不同的 build variant 指定不同的混淆规则。
  • Multiple APK Support
    编译不同的 apk,这些 apk 只包含特定屏幕尺寸或 abi 所需要的代码和资源。

编译配置文件

一个 Android Studio 工程目录如下:

image.png

在编译配置文件中,普通文本文件使用 DSL(Domain Specific Language) 来描述配置,而操作编译逻辑使用的 Groovy。

Gradle 设置文件

工程根目录的 settings.gradle 用于告诉 Gradle 编译时需要包含哪些 module。如:

include ‘:app’

顶层的编译文件

工程根目录的 build.gradle 文件,定义了应用于工程中所有 module 的编译配置。默认的,它使用 buildscript 块来确定所有 module 的 Gradle 仓库和依赖。
如:

/**
 * buildscript 块用于配置 Gradle 自身的仓库和依赖。
 * 如它依赖的 Android plugin 将为 Gradle 提供编译 Android app 模块所需的额外指令。
 */

buildscript {

    /**
     * Gradle 搜索和下载依赖所用的仓库。Gradle 预配置的有 JCenter、MavenCentral、Ivy。
     */

    repositories {
        jcenter()
    }

    /**
     * Gradle 编译工程所需要的依赖。
     */

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

/**
 * allprojects 块用来配置所用 module 使用的仓库和依赖。
 */

allprojects {
   repositories {
       jcenter()
   }
}

配置工程范围的属性

我们可以在顶层的 build.gradle 中添加一个 ext 块来配置额外属性,这些属性将在所有 module 中共享。
如:

buildscript {...}

allprojects {...}

// ext 块包含自定义属性并对所有 module 可用。
ext {
    // The following are only a few examples of the types of properties you can define.
    compileSdkVersion = 26
    buildToolsVersion = "26.0.1"
    // You can also create properties to specify versions for dependencies.
    // Having consistent versions between modules can avoid conflicts with behavior.
    supportLibVersion = "26.1.0"
    ...
}
...

在 module 的 build.gradle 文件中可以使用以下语法来访问这些属性:

android {
  // Use the following syntax to access properties you defined at the project level:
  // rootProject.ext.property_name
  compileSdkVersion rootProject.ext.compileSdkVersion
  buildToolsVersion rootProject.ext.buildToolsVersion
  ...
}
...
dependencies {
    compile "com.android.support:appcompat-v7:${rootProject.ext.supportLibVersion}"
    ...
}

注意:应避免这种用法,因为它将导致使用这些属性的 module 耦合在一起。

Module 层的编译文件

每一个 module 目录的 build.gradle 文件。
如:

/**
 * 第一行将 Android plugin 应用到编译该 module 的 Gradle,这样 android 块才可用于指定 Android特定的编译项。
 */

apply plugin: 'com.android.application'

/**
 * android 块用于配置所有的 Android 特定编译项。
 */

android {

  /**
   * buildToolsVersion:SDK build tools 的版本。
   */

  compileSdkVersion 26
  buildToolsVersion "26.0.1"

  /**
   * The defaultConfig 块包含了所有 build variant 的默认配置,编译系统可以动态
     * 覆盖 main/AndroidManifest.xml 的默写属性。我们也可以在 product flavors 中为不同版本的 app 重写这些值。 
   */

  defaultConfig {

    /**
     * 发布的包的唯一标识,但源码仍会引用定义在 main/AndroidManifest.xml 文件中的包名。
     */

    applicationId 'com.example.myapp'

    minSdkVersion 15

    targetSdkVersion 26

    versionCode 1

    versionName "1.0"
  }

  /**
   * buildTypes 块用于配置多种 build type。
   * 编译系统默认会定义两种 build type:debug和release。debug 版本不会显式地显示在默认的编译配置中,但
   * 它包含了调试工具并会使用 debug 密钥进行签名。
   * release 版本会使用混淆设置并且默认没有签名。
     * (这里指的是默认生成的文件内容,实际中往往会做修改,如为 release 配置签名)
   */

  buildTypes {

    release {
        minifyEnabled true // Enables code shrinking for the release build type.
        proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
    }
  }

  /**
   * productFlavors 块用于配置多种的 product flavors。编译系统默认生成的文件没有创建这部分。
   */

  productFlavors {
    free {
      applicationId 'com.example.myapp.free'
    }

    paid {
      applicationId 'com.example.myapp.paid'
    }
  }

  /**
   * splits 块配置不同的 apk 编译,每一个将只包含所支持的屏幕尺寸或 abi 的源码和资源。
   */

  splits {
    // 设置基于屏幕尺寸的 multiple apk
    density {

      // 是否编译 multiple apk
      enable false

      // 在编译 multiple apk 时排除这些密度
      exclude "ldpi", "tvdpi", "xxxhdpi", "400dpi", "560dpi"
    }
  }
}

/**
 * module 级别依赖
 */

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

Gradle 属性文件

gradle.properties
配置工程范围的 Gradle 设置,如 Gradle 进程的最大堆大小。

local.properties
为编译系统配置本地环境变量,如 SDK 安装目录。该目录内容一般由 Android Studio 自动生成,所以通常不应该手动修改或者引入版本控制系统(不过因为没必要引入 VCS 中,所以我们可以在这里配置签名信息)。

Source Sets 源集

Android Studio将每一个 module 的代码和资源归到一个源集中,一个 module 的 main/ 源集包含了所有 build variant 共用的代码和资源。
我们可以为不同的 build variant 添加额外的源集目录:

  • src/main/
  • src/buildType/
  • src/productFlavor/
  • src/productFlavorBuildType/

例如,在生成一个「fullDebug」版本应用时,编译系统将从以下目录合并代码、设置、资源

  • src/fullDebug/ (build variant 源集)
  • src/debug/ (build type 源集)
  • src/full/ (product flavor 源集)
  • src/main/ (main 源集)

如果不同源集中包含了同一文件的不同版本,Gradle 将采用以下的优先级顺序:
build variant > build type > product flavor > main source set > library dependencies

参考:
build process

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 193,495评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,469评论 2 369
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 140,825评论 0 318
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 51,974评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,849评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 45,990评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,415评论 3 380
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,125评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,351评论 1 288
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,474评论 2 307
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,249评论 1 324
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,119评论 3 310
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,496评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,838评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,118评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,366评论 2 340
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,573评论 2 335

推荐阅读更多精彩内容