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

原创 2017年08月15日 15:08:59

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


异步社区试读地址:http://www.epubit.com.cn/book/details/4889

第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官网https://gradle.org/ 下载好Gradle SDK,直接下载地址为https://downloads.gradle.org/distributions/gradle-2.14.1-all.zip。我们下载的是all版本,也就是说,里面包含了Gradle SDK所有相关的内容,包括源代码、文档、示例等。如果因为网络问题下载不了,可以使用镜像下载,镜像首页为http://mirrors.flysnow.org/,该Gradle版本下载地址为http://mirrors.flysnow.org/gradle/gradle-2.14.1-all.zip,下载之后进行解压,我们可以得到如下目录清单。

① 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: http://gradle.org/docs/2.14.1/userguide/gradle_daemon.html

生成的文件如下:

├──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: http://gradle.org/docs/2.14.1/userguide/gradle_daemon.html

从输出中我们可以看到,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这样的方式来执行。

版权声明:本文为博主原创文章,未经博主允许不得转载。

相关文章推荐

[Android Studio 权威教程]AS构建系统-Gradle

前几篇我们主要讲了AS的配置的一些东西,今天我们就开始认识一下Android Studio的【构建系统】-Gradle。 Gradle是什么?Gradle 是以 Groovy 语言为基础,面...

Android Gradle 用户指南

  • 2015-10-15 13:43
  • 980KB
  • 下载

[Android Studio 权威教程]AS构建系统-Gradle

前几篇我们主要讲了AS的配置的一些东西,今天我们就开始认识一下Android Studio的【构建系统】-Gradle。 Gradle是什么?Gradle 是以 Groovy 语言为基础,面向J...

Gradle入门指南(二)

转载请标明出处: 本文出自:【ouyida3的博客】注意:本文内容都是通过gradle命令行完成,不涉及eclipse的插件。1、先阅读Gradle入门指南(一)2、常用命令gradle -v g...

gradle入门指南

转载请标明出处: http://blog.csdn.net/ouyida3/article/details/46045261 本文出自:【ouyida3的博客】1、介绍点击:gradle官网地址...

Gradle 教程说明 用户指南 第7章 构建Java工程----快速入门

官网地址:http://www.gradle.org/docs/2.1/userguide/tutorial_java_projects.html Using the Java plugin A ...

Java Gradle入门指南之内建与定制任务类

1.内建任务类(in-built tasks)Gradle在不断地更新,其内建任务也在不断地丰富,这一章节介绍Gradle中最常用的几个内建任务类,这只是Gradle众多内建任务类中的一部分,抛砖引玉...

Android Gradle插件用户指南(译)

Android Gradle插件用户指南(译) 原文Gradle Plugin User Guide - Android Tools Project Site samples see bot...

Android Gradle Plugin指南(四)——测试

原文地址:http://tools.android.com/tech-docs/new-build-system/user-guide#TOC-Testing 5、Testing(测试) 构建...

Android官方技术文档翻译——Gradle 插件用户指南(1-3)

简介 本文档是 Gradle 插件 0.9 版本的文档。在 1.0 之前,我们所介绍的早期版本可能由于不兼容问题会有所不同。 新构建系统的目标 新的构建系统的目标是: 可以很容易地重用代码和资源 ...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

(最多只允许输入30个字)