Android Studio 中的Gradle构建系统示例

相信有很多像我一样的朋友在使用Android Studio时，对 Gradle 和 Gradle Android 插件的版本号和作用不是很清楚，本篇文章的将对这些进行解释，最后通过一个实际的项目工程来说明其中的配置块的含义，并通过源代码的角度去剖析脚本的结构。

一.第一部分：Q&A

1.Gradle是什么？

Gradle 是一个JVM平台上的自动化的构建工具，支持多项目构建,强有力依赖管理(本地或者远程依赖)，构建脚本使用Groovy语言编写。

在Android Studio的 project 视图下的 gradle/ wrapper/gradle-wrapper.properties 路径下声明了项目使用的Gradle版本号，这里使用的是 3.3版本

distributionUrl=https\://services.gradle.org/distributions/gradle-3.3-all.zip

2.Gradle Android Plugin 是什么？

在项目根目录中的build.gradle文件中有如下设置：

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

这里声明的是项目对 Gradle Android Plugin 的依赖，其版本号为2.3.3。Gradle的Android插件提供了许多专为构建Android的操作项。

classpath表明的是类路径，该Android Plugin for Gradle 的对应文件位置在Android Studio根目录下的：gradle/m2repository/com/android/tools/build/gradle/对应版本号/gradle-3.0.0.jar

附上我电脑上的路径

可以看到，我们依赖的仅仅就是jar文件，build.gradle的脚本是使用Groovy语言编写的，Groovy编写的程序可以运行在JVM虚拟机中。而Android Plugin for Gradle是专门为构建Android项目提供库文件。

平时我们经常使用的比如 buildToolsVersion、compileSdkVersion，buildTypes{ }、sourceSets { }、defaultConfig{ }等方法函数(是的，就是方法，这是Groovy语言中的闭包和函数调用时的特性，现在无需关心，后面第三部分有讲到这个)，都是Gradle Android Plugin 这个库提供的方法。可不要以为Gradle仅仅是用来构建Android项目。

3.Android Studio中的compileSdkVersion、buildToolsVersion、minSdkVersion、targetSdkVersion这些配置项是什么？

1. compileSdkVersion 26 :编译项目使用的Android SDK的版本号为26,可以使用对应版本号提供的API进行编程
2. minSdkVersion 14 ：定义最小可以运行app的android系统版本号为14
3. targetSdkVersion 26 ：指定测试app的android系统版本号为26
4. buildToolsVersion "26.0.2" :指定Android Studio中 sdk 构建工具的版本号、命令行工具等构建工具，在使用Android plugin 3.0.0版本或以上时，该属性可以不用设置，插件会提供默认版本号。

在导入github上面的工程时，如果该工程所需要的Gradle版本、Android Plugin版本、buildToolsVersion版本，SDK 版本与你本地不符合时，往往会卡死，所以在导入之前可以更改为你本地的版本，在进行导入即可。

4. Gradle Wrapper是什么？

The Gradle Wrapper allows you to execute Gradle builds on machines where Gradle is not installed. This is useful for example for some continuous integration servers. It is also useful for an open source project to keep the barrier low for building it. The wrapper is also very interesting for the enterprise. It is a zero administration approach for the client machines. It also enforces the usage of a particular Gradle version thus minimizing support issues.
Gradle Wrapper 可以在没有安装Gradle的机器上执行Gradle 构建，经常在持续性构建平台上所使用，例如jenkis。同时对于客户端机器来说零成本管理。

Gradle User Guide

第二部分. 关于Android Studio 工程项目你需要知道的一些东西

1. Android Studio项目工程包含一个Application module,包含若干个Library module。 Library module可以是Android library，也可以是java library。
2. Android Library : 包含Android项目中的源代码、资源文件、manifest文件，被编译为AAR文件。AAR文件可做为Android 应用模块的依赖。
3. java library : 仅包含java源文件，编译的结果为JAR文件，可作为Android 应用模块的依赖或者java 项目的依赖。
4. 每个module都可以被单独的构建，测试与调试，同时moudle可用来作为其他工程使用的library。

第三部分 .实际工程分析

通过github上的timber项目分析各模块下的build.gradle配件文件的含义。可以直接到github上搜索找到该项目。

1.Timber项目结构

根目录的setting.gradle文件，告诉Gradle需要构建的模块包括那些

include ':timber',include ':timber-lint',include ':timber-sample'

a.其中timber-sample是Application 模块，对应声明为

apply plugin: 'com.android.application'

b.timber是android library 模块,对应声明为

apply plugin: 'com.android.library'

c.timber-lint是java library模块，对应声明为

apply plugin: 'java-library'

2. build.gradle 文件中结构解释, 大招来了 :）

下面我将通过简单易懂的方式去让使用者理解build脚本文件的结构。

常见的模块下build.gradle文件格式如下：

apply plugin: 'com.android.application'

android {
  compileSdkVersion 25
  buildToolsVersion "26.0.1"
  defaultConfig {
   
  }
  buildTypes {

  }
}

dependencies {

}

2.1： “apply plugin: 'com.android.application'” 语句解释：

Gradle是使用Groovy所写，这里是调用了 apply方法，Groovy中方法调用时可以省略括号，在你按住Control + 左键（mac为command+左键）时，可以进入到对应的类中，之前上文也提到过，Android Plugin 仅仅是Jar文件，让我们进入看看其中的对应方法是什么？

public interface PluginAware {
  void apply(Map<String, ?> options);
}

在Grovvy中 a.b() 这种格式可以写为a b

所以呢 compileSdkVersion ,apply 等语句都是在调用对应的函数

2.2 xxx { } 格式到底是什么？

def debugClosure(int num, String str, Closure closure){ 
   //dosomething 
} 

debugClosure(1, "groovy", { 
 println"hello groovy!" 
})

首先"{ }" 在Groovy语言中是“闭包”,简单讲闭包就是用“{ }”扩起来的一段代码段 ，在Groovy中有调用方法的时候有这样一条规定：“在调用方法的时候，如果方法仅有一个参数是Closure类型(也就是闭包)，调用的时候，可以把闭包中的执行的代码写到括号中，为xxx({ })，当把括号省略之后就变成了 xxx{ } 格式”。

最前面代码中的"android{ }"语句函数定义在Project类中，函数定义为：

AppExtension android(Closure configuration);

结论：build.gradle脚本文件在运行的其实就是在执行一系列的函数

3. 根目录下build.gradle文件分析

该文件定义的是整个项目的构建配置，该配置同样生效于其他module

3.1 extra 属性

我们可以在项目顶级build.gradle中声明ext 块，在其中定义的属性可以在其他各个模块中去使用，通过这种方式可以一次性更改项目的各个模块的构建配置。

ext {
  compileSdkVersion = 26、
  supportLibVersion = "26.1.0"
}

使用：在其他模块通过rootProject.ext.compileSdkVersion去使用该属性。

3.2 buildScript 块

buildscript {
 repositories {
  jcenter()
  google()
 }

 dependencies {
  classpath deps.androidPlugin
  classpath 'com.github.ben-manes:gradle-versions-plugin:0.17.0'
 }
}

其中repositories中声明的是远程仓库的类别，平时我们在dependencies块中使用的类似compile 'io.reactivex:rxjava:1.0.0'语句，它在jcenter仓库中都是唯一存在，在构建的时候，本地如果没有的话，会到jcenter中去进行下载对应的版本。

4. 模块下的build.gradle文件分析

1、defaultConfig 块：定义的是APK各种构建版本的默认设置，这里面的一些属性可在AndroidManifest.xml文件中重载配置

  applicationId 'com.example.myapp'
  minSdkVersion 15
  targetSdkVersion 26
  versionCode 1
  versionName "1.0"
 }

productFlavors 块： 可以配置多种产品类型，比如可以一个是free，另外一种类型是免费

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

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

buildTypes 块：可以配置多种构建类型的相应的配置项，比如debug、relase版本。

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