《Android Gradle权威指南》之Gradle入门

本文摘自人民邮电出版社异步社区《Android Gradle权威指南》一文

异步社区试读地址： www.epubit.com.cn/book/detail…

第1章　Gradle入门

Gradle是一款很是优秀的构建系统工具，它的DSL基于Groovy实现，可让你很方便地经过代码控制这些DSL来达到你构建的目的。Gradle构建的大部分功能都是经过插件的方式来实现，因此很是灵活方便，若是内置插件不能知足你的需求你能够自定义本身的插件。

本章咱们就介绍Gradle的入门知识，在介绍以前，咱们先假定读者已经具有如下知识。

（1）了解而且会使用Java，精通最好。

（2）会独立搭建Java开发环境。

（3）最好会使用Linux操做系统，好比Ubuntu。

为何会有这样的假定呢？由于这本书是介绍Android Gradle开发构建的书，因此不会讲Java的基本知识。但愿读者会用Linux操做系统的缘由，是由于本书的全部脚本、代码、IDE等都是基于Ubuntu完成的，固然好比涉及Gradle安装还会介绍一下Windows的安装步骤，可是不会太多涉及Windows的东西，因此仍是但愿读者在阅读本书前已经掌握了这些知识。

1.1　配置Gradle环境

安装以前确保已经安装配置好Java环境，要求JDK 6以上，而且在环境变量里配置了JAVA_HOME，查看Java版本能够在终端输入以下命令：

java –version复制代码

我这里使用的是open jdk 1.8.0_91：

➜  ~ java -version
openjdk version "1.8.0_91"
OpenJDK Runtime Environment (build 1.8.0_91-8u91-b14-3ubuntu1~16.04.1-b14)
OpenJDK 64-Bit Server VM (build 25.91-b14, mixed mode)复制代码

1.1.1　Linux下搭建Gradle构建环境

这里以Ubuntu 16.04发行版为例介绍如何在Linux下搭建Gradle构建环境，其余诸如CentOS大同小异，参考一下就能够了。

咱们这里以Gradle 2.14.1版本为准进行介绍。先到Gradle官网gradle.org/ 下载好Gradle SDK，直接下载地址为downloads.gradle.org/distributio… SDK全部相关的内容，包括源代码、文档、示例等。若是由于网络问题下载不了，可使用镜像下载，镜像首页为mirrors.flysnow.org/，该Gradle版本下…

① docs：API、DSL、指南等文档。

② getting-started.html：入门连接。

③ init.d：gradle的初始化脚本目录。

④ lib：相关库。

⑤ LICENSE。

⑥ media：一些icon资源。

⑦ NOTICE。

⑧ samples：示例。

⑨ src：源文件。

要运行Gradle，必须把GRADLE_HOME/bin目录添加到你的环境变量PATH的路径里才能够。在Linux下，若是你只想为当前登陆的用户配置能够运行Gradle，那么能够编辑～/.bashrc文件添加如下内容：

#这里是做者的Gradle目录，要换成你本身的
GRADLE_HOME=/home/flysnow/frame/gradle

PATH=${PATH}:${GRADLE_HOME}/bin
Export GRADLE_HOME PATH复制代码

上面GRADLE_HOME是个人Gradle解压后的目录，这里要换成你本身的。以上添加后保存，而后在终端输入source ~/.bashrc，回车执行让刚刚的配置生效。

若是你想让全部用户均可以使用Gradle，那么你就须要在/etc/profile中添加以上内容，在这里添加后，对全部用户都生效，这种方式的添加，必需要重启计算机才能够。

好了，如今咱们已经配置好了，要验证咱们的配置是否正确，是否能够运行Gradle，咱们只须要打开终端，输入gradle -v命令查看便可。若是能正确显示Gradle版本号、Groovy版本号、JVM等相关信息，那么说明你已经配置成功了。这里以验证个人配置为例：

➜  ~ gradle -v
------------------------------------------------------------
Gradle 2.14.1
------------------------------------------------------------

Build time:   2016-10-20 03:46:36 UTC
Build number: none
Revision:     b463d7980c40d44c4657dc80025275b84a29e31f

Groovy:       2.4.4
Ant:          Apache Ant(TM) version 1.9.3 compiled on December 23 2013
JVM:          1.8.0_91 (Oracle Corporation 25.91-b14)
OS:           Linux 4.4.0-38-generic amd64复制代码

1.1.2　Windows下搭建Gradle构建环境

Windows下搭建Gradle环境和Linux很是类似，只不过方式不一样。咱们经过右击个人电脑，打开属性面板，而后找到环境变量配置项，添加GRADLE_HOME环境变量，而后把GRADLE_HOME\bin添加到PATH系统变量里保存便可。完成后打开CMD，运行gradle -v来进行验证，总体效果和Linux差很少，这里就再也不一一详述。

1.2　Gradle版Hello World

环境搭建好了，那么咱们就开始写一个Hello World版的Gradle脚本。

新建好一个目录，我这里是android-gradle-book-code，而后在该目录下建立一个名为build.gradle的文件，打开编辑该文件，输入如下内容：

task hello{
    doLast{
        println'Hello World!'
    }
}复制代码

打开终端，而后移动到android-gradle-book-code下，使用gradle -q hello命令来执行构建脚本：

$ gradle -q hello
Hello World!复制代码

好了，如愿以偿地打印出来咱们想要的结果，下面咱们一步步分析结果产生的步骤和缘由。build.gradle是Gradle默认的构建脚本文件，执行Gradle命令的时候，会默认加载当前目录下的build.gradle脚本文件。熟悉Ant的读者感受和build.xml差很少，固然你也能够经过 -b参数指定想要加载执行的文件。

这个构建脚本定义一个任务（Task），任务名字叫hello，而且给任务hello添加了一个动做，官方名字是Action，阅读Gradle源代码你会处处见到它，其实它就是一段Groovy语言实现的闭包。在这里我以为叫业务代码逻辑或者回调实现更贴切一些，由于doLast就意味着在Task执行完毕以后要回调doLast的这部分闭包的代码实现。

熟悉Ant的读者，会以为任务（Task）和Ant里的Target（目标）很是类似。其实没错，如今能够认为它们基本上相同。

再看gradle -q hello这段运行命令，意思是要执行build.gradle脚本中定义的名为hello的Task，-q参数用于控制gradle输出的日志级别，以及哪些日志能够输出被看到。

看到println 'Hello World!'了吗，它会输出Hello World!，经过名字相信你们已经猜出来了，它其实就是System.out.println("Hello World!")的简写方式。Gradle能够识别它，是由于Groovy已经把println()这个方法添加到java.lang.Object，而在Groovy中，方法的调用能够省略签名中的括号，以一个空格分开便可，因此就有了上面的写法。还有一点要说明的就是，在Groovy中，单引号和双引号所包含的内容都是字符串；不像Java中，单引号是字符，双引号才是字符串。

1.3　Gradle Wrapper

Wrapper，顾名思义，其实就是对Gradle的一层包装，便于在团队开发过程当中统一Gradle构建的版本，这样你们均可以使用统一的Gradle版本进行构建，避免由于Gradle版本不统一带来的没必要要的问题。

在这里特别介绍的目的是由于，咱们在项目开发过程当中，用的都是Wrapper这种方式，而不是咱们在1.1节里介绍的本身下载ZIP压缩包，配置Gradle的环境的方式。Wrapper在Windows下是一个批处理脚本，在Linux下是一个shell脚本。当你使用Wrapper启动Gradle的时候，Wrapper会检查Gradle有没有被下载关联，若是没有将会从配置的地址（通常是Gradle官方库）进行下载并运行构建。这对咱们每一个开发人员是很是方便的，由于你不用去专门配置环境了，只要执行Wrapper命令，它会帮你搞定一切。这种方式也方便咱们在服务器上作持续集成（CI），由于咱们不用在服务器上配置Gradle环境。

1.3.1　生成Wrapper

Gradle提供了内置的Wrapper task帮助咱们自动生成Wrapper所需的目录文件，在一个项目的根目录中输入gradle wrapper便可生成：

$ gradle wrapper
:wrapper

BUILD SUCCESSFUL

Total time: 2.804 secs

This build could be faster, please consider using the Gradle Daemon: gradle.org/docs/2.14.1…复制代码

生成的文件以下：

├──gradle
│   └──wrapper
│       ├──gradle-wrapper.jar
│       └──gradle-wrapper.properties
├──gradlew
└──gradlew.bat复制代码

gradlew和gradlew.bat分别是Linux和Windows下的可执行脚本，它们的用法和Gradle原生命令是同样的，Gradle怎么用，它们也就能够怎么用。gradle-wrapper.jar是具体业务逻辑实现的jar包，gradlew最终仍是使用Java执行的这个jar包来执行相关Gradle操做。gradle-wrapper.properties是配置文件，用于配置使用哪一个版本的Gradle等，稍后会详细讲解。

这些生成的Wrapper文件能够做为你项目工程的一部分提交到代码版本控制系统里（Git），这样其余开发人员就会使用这里配置好的、统一的Gradle进行构建开发。

1.3.2　Wrapper配置

当咱们在终端执行gradle wrapper生成相关文件的时候，能够为其指定一些参数，来控制Wrapper的生成，好比依赖的版本等，如表1-1。

表1-1　Wrapper配置参数

参数名	说明
--gradle-version	用于指定使用的Gradle版本
--gradle-distribution-url	用于指定下载Gradle发行版的url地址

使用方法为gradle wrapper --gradle-version 2.4，这样就意味着咱们配置Wrapper使用2.4版本的Gradle，它会影响gradle-wrapper.properties中的distributionUrl的值，该值的规则是http\://services.gradle.org/distributions/gradle-${gradleVersion}-bin.zip。

若是咱们在调用gradle wrapper的时候不添加任何参数，那么就会使用你当前Gradle的版本做为生成的Wrapper的gradle version。例如，你当前安装的Gradle是2.8版本的，那么生成的Wrapper也是2.8版本的。

1.3.3　gradle-wrapper.properties

该配置文件是gradle wrapper的相关配置文件，咱们上面执行该任务的任何配置都会被写进该文件中。如今咱们来看看该文件的配置字段，如表1-2。

表1-2　gradle-wrapper.properties的配置字段

字段名	说明
distributionBase	下载的Gradle压缩包解压后存储的主目录
distributionPath	相对于distributionBase的解压后的Gradle压缩包的路径
zipStoreBase	同distributionBase，只不过是存放zip压缩包的
zipStorePath	同distributionPath，只不过是存放zip压缩包的
distributionUrl	Gradle发行版压缩包的下载地址

咱们比较关注的就是distributionUrl这个字段，这个决定你的gradle wrapper依赖哪一个Gradle版本。通常生成的都是这样的https\://services.gradle.org/distributions/gradle-2.14.1-bin.zip，我一般都会把bin改成all，这样在开发过程当中，就能够看到Gradle的源代码了。

基于Gradle 2.14.1默认生成的gradle-wrapper.properties以下：

#Wed Sep 16 23:14:52 CST 2016
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-2.14.1-bin.zip复制代码

distributionUrl是下载Gradle的路径，若是运行./gradlew的时候计算机一直被卡着不动，多是由于官方的Gradle地址被封闭了，建议把该地址换成别的镜像地址。

1.3.4　自定义Wrapper Task

前面咱们讲了，gradle-wrapper.properties是由Wrapper Task生成的，那么咱们是否能够自定义配置该Wrapper task来达到咱们配置gradle-wrapper.properties的目的呢？答案是确定的。在build.gradle构建文件中录入以下脚本：

task wrapper(type: Wrapper) {
    gradleVersion = '2.4'
}复制代码

这样咱们再执行gradle wrapper的时候，就会默认生成2.4版本的wrapper了，而不用使用--gradle-version 2.4进行指定了。一样，你也能够配置其余参数：

task wrapper(type: Wrapper) {
    gradleVersion = '2.4'
    archiveBase = 'GRADLE_USER_HOME'
    archivePath = 'wrapper/dists'
    distributionBase = 'GRADLE_USER_HOME'
    distributionPath = 'wrapper/dists'
    distributionUrl = 'http\://services.gradle.org/distributions/gradle-2.4-all.zip'
}复制代码

以上是我本身配置的一些值，也能够修改为你本身的。

1.4　Gradle日志

在这里单独介绍Gradle日志是为了便于咱们在遇到问题的时候，可以根据日志信息分析和解决问题。Gradle的日志和Java、Android的差很少，也分一些级别，用于分类显示日志信息，这样咱们只需根据不一样的状况显示不一样类别的信息，不至于被大量的日志搞得晕头转向。

1.4.1　日志级别

上面提到Gradle的日志级别和咱们使用的大部分语言的差很少。除了这些通用的以外，Gradle又增长了QUIET和LIFECYCLE两个级别，用于标记重要以及进度级别的日志信息，如表1-3。

表1-3　日志级别

级别	用于
ERROR	错误消息
QUIET	重要消息
WARNING	警告消息
LIFECYCLE	进度消息
INFO	信息消息
DEBUG	调试信息

表1-3明确列出了6种日志级别以及它们的做用，如今咱们就看一下怎样使用它们。要使用它们，显示咱们想要显示级别的日志，就要经过命令行选项中的日志开关来控制。

#输出QUIET级别及其之上的日志信息
$ gradle -q tasks
#输出INFO级别及其之上的日志信息
$ gradle -i tasks复制代码

如下列出全部经过命令行开关选项能够控制的级别，在命令行里只需加上这些选项便可控制使用，如表1-4。

表1-4　日志开关选项

开关选项	输出的日志级别
无选项	LIFECYCLE及其更高级别
-q或者 --quiet	QUIET及其更高级别
-i或者 --info	INFO及其更高级别
-d或者 --debug	DEBUG及其更高级别，这通常会输出全部日志

1.4.2　输出错误堆栈信息

在使用Gradle构建的时候，不免会有这样或者那样的问题致使你的构建失败，这时就须要你根据日志分析解决问题。除了以上的日志信息以外，Gradle还提供了堆栈信息的打印，相信你们用过Java语言的都会很熟悉错误堆栈信息，它能帮助咱们很好地定位和分析问题。

默认状况下，堆栈信息的输出是关闭的，须要咱们经过命令行的堆栈信息开关打开它，这样在咱们构建失败的时候，Gradle才会输出错误堆栈信息，便于咱们定位分析和解决问题，如表1-5。

表1-5　错误堆栈开关选项

命令行选项	用于
无选项	没有堆栈信息输出
-s或者 --stacktrace	输出关键性的堆栈信息
-S或者--full-stacktrace	输出所有堆栈信息

通常推荐使用-s而不是-S，由于-S输出的堆栈太多太长，很是很差看；而-s比较精简，能够定位解决咱们大部分的问题。

1.4.3　本身使用日志信息调试

在编写Gradle脚本的过程当中，咱们有时候须要输出一些日志，来验证咱们的逻辑或者一些变量的值是否正确，这时候咱们就可使用Gradle提供的日志功能。

一般状况下咱们通常都是使用print系列方法，把日志信息输出到标准的控制台输出流（它被Gradle定向为QUIET级别日志）：

println'输出一段日志信息'复制代码

除了print系列方法以外，你也可使用内置的logger更灵活地控制输出不一样级别的日志信息：

logger.quiet('quiet日志信息.')
logger.error('error日志信息.')
logger.warn('warn日志信息.')
logger.lifecycle('lifecycle日志信息.')
logger.info('info日志信息.')
logger.debug('debug日志信息.')复制代码

这里实际上是调用的Project的getLogger()方法获取的Logger对象的实例。

1.5　Gradle命令行

Gradle命令行单独用一节讲解的目的是，想提倡你们尽量使用命令行，而不要太依赖于各类IDE。虽然IDE很方便，可是，若是你换了一家公司，不使用这个IDE，若是让你作自动构建没有IDE可用，所有都是基于命令行的。这个就像咱们第一次学习编程语言时老师没说让你用IDE，而是直接用记事本或者其余文本工具写程序，目的就是让咱们不要太依赖第三方工具，这样才能以不变应万变。那么IDE该不应用，有没有必要，这个是确定的，必定要用，由于它能提升工做效率。可是用以前你要知道若是不借助IDE作一件事，好比执行Gradle一个Task，在Android Studio下很简单，双击那个Task就能够执行了，可是若是没有Android Studio，你也要知道如何在命令行下运行它。咱们要知其因此然，否则你的开发水平很难提升。

1.5.1　记得使用帮助

命令行下的工具都有命令。若刚开始咱们不会用或者不知道有什么命令或者参数，咱们能够经过帮助来了解。基本上全部的命令行工具都有帮助，查看帮助的方式也很简单，基本上都是在命令后跟-h或者--help，有的时候会有-?，以Gradle Wrapper为例：

./gradlew -?
./gradlew -h
./gradlew –help复制代码

1.5.2　查看全部可执行的Tasks

有时候咱们不知道如何构建一个功能，不知道执行哪一个Task，这时候就须要查看哪些Task可执行，都具有什么功能。经过运行./gradlew tasks命令，输出以下：

:tasks

------------------------------------------------------------
All tasks runnable from root project
------------------------------------------------------------

Build Setup tasks
-----------------
init - Initializes a new Gradle build. [incubating]
wrapper - Generates Gradle wrapper files. [incubating]

Help tasks
----------
components - Displays the components produced by root project 'flysnow'. [incubating]
dependencies - Displays all dependencies declared in root project 'flysnow'.
dependencyInsight - Displays the insight into a specific dependency in root project'flysnow'.
help - Displays a help message.
model - Displays the configuration model of root project 'flysnow'. [incubating]
projects - Displays the sub-projects of root project 'flysnow'.
properties - Displays the properties of root project 'flysnow'.
tasks - Displays the tasks runnable from root project 'flysnow'.

To see all tasks and more detail, run gradle tasks --all

To see more detail about a task, run gradle help --task <task>

BUILD SUCCESSFUL

Total time: 2.321 secs

This build could be faster, please consider using the Gradle Daemon: gradle.org/docs/2.14.1…复制代码

从输出中咱们能够看到，Gradle会以分组的方式列出Task列表，好比构建类的有init、wrapper，帮助类的有help、tasks等。

1.5.3　Gradle Help任务

除了上面咱们说的每一个命令行都有帮助外，Gradle还内置了一个help task，这个help可让咱们了解每个Task的使用帮助，用法是 ./gradlew help –task。好比 ./gradlew help --task tasks，就能够显示tasks任务的帮助信息：

:help
Detailed task information for tasks

Path
     :tasks

Type
     TaskReportTask (org.gradle.api.tasks.diagnostics.TaskReportTask)

Options
     --all     Show additional tasks and detail.

Description
     Displays the tasks runnable from root project 'android-gradle-book-code' (some
of the displayed tasks may belong to subprojects).

Group
     help

BUILD SUCCESSFUL复制代码

从帮助信息中咱们能够看到这个Task有什么用，是什么类型，属于哪一个分组，有哪些可使用的参数。好比这里就有--all参数，能够查看不少额外的详细信息。

1.5.4　强制刷新依赖

咱们一个功能不可避免地会依赖不少第三方库。像Maven这类工具都是有缓存的，由于不可能每次编译的时候都要从新下载第三方库，缓存就是这个目的，先使用缓存，没有再下载第三方库。默认状况下Maven这类工具会控制缓存的更新，可是也有例外，好比Version，里面的代码变了，还有就是联调测试时使用的snapshot版本。以上两种状况咱们在实际项目中都遇到过，最后就是经过强制刷新解决的。强制刷新很简单，只要在命令行运行的时候加上--refresh-dependencies参数就能够，这是IDE很难作到的（须要你了解配置）。因此，命令行的优点就体现出来了，很是简单：

./gradlew --refresh-dependencies assemble复制代码

其余还有不少有用的命令、参数以及Tasks，就不一一介绍了，你们能够经过上面讲的两种帮助方法来了解。

1.5.5　多任务调用

有时候咱们须要同时运行多个任务，好比在执行jar以前先进行clean，那么咱们就须要先执行clean对class文件清理，而后再执行jar生成一个jar包。经过命令行执行多个任务很是简单，只须要按顺序以空格分开便可，好比./gradlew clean jar，这样就能够了。有更多的任务时，能够继续添加。

1.5.6　经过任务名字缩写执行

有的时候咱们的任务名字很长，若是在执行的时候所有写一遍也挺费时间，为此Gradle提供了基于驼峰命名法的缩写调用，好比connectCheck，咱们执行的时候可使用./gradlew connectCheck，也可使用./gradlew cc这样的方式来执行。