第一章 Gradle入门

Gradle是一款非常优秀的构建系统工具,它的DSL基于Groovy实现,可以让你很方便的通过代码控制这些DSL来达到你构建的目的,其构建的大部分功能都是通过插件的方式来实现,所以非常灵活方便,如果内置插件不能满足你的需求你可以自定义自己的插件。

本章我们就介绍Gradle的入门,在介绍之前,我们先假定读者已经具备以下前提:

  1. 了解并且会使用Java,精通最好
  2. 会自己的独立的搭建Java开发环境
  3. 最好会使用Linux操作系统,比如Ubuntu

1.1 配置Gradle环境

1.1.1 Linux下搭建Gradle构建环境

先到Gradle官网 http://gradle.org/ 下载好Gradle SDK

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


上面GRADLE_HOME是我的Gradle解压后的目录,这里要换成你自己的。以上添加后保存,然后在终端输入source ~/.bashrc回车执行让刚刚的配置生效。
如果你想让所有用户都可以使用gradle,那么你就需要在/etc/profile中添加以上内容,在这里添加后,对所有用户都生效,这种方式的添加,必须要重启电脑才可以

输入gradle -v命令查看即可,如果能正确显示gradle版本号、Groovy版本号、JVM等相关信息,那么说明你已经配置成功了.

1.1.2 Window下搭建Gradle构建环境

右击我的电脑,打开属性面板,然后找到环境变量配置项,添加GRADLE_HOME环境变量,然后把GRADLE_HOME\bin添加到PATH系统变量里保存即可。完成后打开CMD运行gradle -v来进行验证,整体和Linux差不多,这里就不在一一详述。

1.1.3 Mac下搭建Gradle构建环境

下载好后随便解压到某一目录, 我的是/Users/ale/opt/gradle/gradle-4.10.1/bin/, 并开始操作
在终端中输入:open -e ~/.bash_profile,打开.bash_profile文件

GRADLE_HOME=/Users/ale/opt/gradle/gradle-4.10.1/bin
export GRADLE_HOME
export PATH=$PATH:$GRADLE_HOME/bin

Reload your terminal to see this change reflected or run the following command:
$ source ~/.bash_profile

Verify your installation
Open a console (or a Windows command prompt) and run gradle -v to run gradle and display the version, e.g.:

$ gradle -v

------------------------------------------------------------
Gradle 5.2.1
------------------------------------------------------------

1.2 Gradle版Hello World

新建好一个目录,我这里是android-gradle-book-code,然后在该目录下创建一个名为build.gradle的文件,打开编辑该文件,输入以下内容:

task hello{
    doLast{
        println'Hello world!'
    }
}

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

看到gradle -q hello这段运行命令,意思是要执行build.gradle脚本中定义的名为hello的Task,-q参数用于控制gradle输出的日志级别,哪些日志可以输出被看到。
看到println 'Hello World!'了吗,它会输出Hello World!,通过名字相信大家已经猜出来了,它其实就是System.out.println("Hello World!")的简写方式。Gradle可以识别它,是因为Groovy已经把println()这个方法添加到iava.lang.Object,而在Groovy中,方法的调用可以省略签名中的括号,以一个空格分开即可,所以就有了上面的写法。还有一点要说明的就是在Groovy中,单引号和双引号所包含的内容都是字符串,不像Java中,单引号是字符,双引号才是字符串。

1.3 Gradle Wrapper

Wrapper,顾名思义,其实就是对Gradle的一层包装,便于在团队开发过程中统一Gradle构建的版本,这样大家都可以使用统一的Gradle版本进行构建,避免因为Gradle版本不统一带来的不必要的问题。

Gradle提供了内置的wrapper task帮助我们自动生成wrapper所需的目录文件,在一个项目的根目录,输入gradle wrapper即可生成。

生成的文件

gradlew和gradlew.bat分别是Linux和Window下的可执行脚本,他们的用法和gradle原生命令是一样的,gradle怎么用,他们也就可以怎么用。gradle-wrapper.jar是具体业务逻辑实现的jar包,gradlew最终还是使用java执行的这个jar包来执行相关gradle操作。gradle-wrapper.properties是配置文件,用于配置使用哪个版本的gradle等,稍后会详细讲解。

这些生成的wrapper文件可以作为你项目工程的一部分提交到代码版本控制系统里(git),这样其他开发人员就会使用这里配置好的统一的gradle进行构建开发。

1.3.2 wrapper配置

1.3.3 gradle-wrapper.properties

1.3.4 自定义Wrapper Task

前面我们讲了,gradle-wrapper.properties是由wrapper task生成的,那么我们是否可以自定义配置该Wrapper task来达到我们配置gradle-wrapper.properties的目的呢,答案是肯定的。我们在我们的build.gradle构建文件中录入如下脚本:

这样我们再执行gradle wrapper的时候,就自定义了其他和默认生成2.4版本的wrapper

1.4 Gradle日志

1.4.1 日志级别

日志级别

1.4.2 输出错误堆栈信息

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

默认情况下,堆栈信息的输出是关闭的,需要我们通过命令行的堆栈信息开关打开它,这样在我们构建失败的时候,Gradle才会输出错误堆栈信息,便于我们定位分析和解决问题。

Paste_Image.png

在编写Gradle脚本的过程中,我们有时候需要输出一些日志,来验证我们的逻辑或者一些变量的值是否正确,这时候我们就可以使用Gradle提供的日志功能。
通常情况下我们一般都是使用print系列方法,把日志信息输出到标准的控制台输出流(它被Gradle定向为QUIET级别日志)。

除了print系列方法之外,你也可以使用内置的logger更灵活的控制输出不同级别的日志信息。

logger说是内置,这里其实是调用的Project的getLogger()方法获取的Logger对象的实例。

1.5 Gradle命令行

1.5.1 记得使用帮助

命令行下的工具都有命令,刚开始我们不会用或者不知道有什么命令或者参数,这没事,但是我们可以通过帮助来了解,基本上所有的命令行工具都有帮助,查看帮助的方式也很简单,基本上都是在命令后跟-h或者--help,有的时候会有-?,以Gradle Wrapper为例:

1.5.2 查看所有可执行的Tasks

有时候我们不知道如何构建一个功能,不知道执行哪个Task,这时候就需要查看哪些Task可执行,都具备什么功能,通过运行./gradlew tasks命令

1.5.3 gradle help 任务

除了上面我们说的每个命令行都有帮助外,Gradle还内置了一个help task,这个help可以让我们了解每一个task的使用帮助,
用法是 ./gradlew help --task <task name>,
比如 ./gradlew help --task tasks,就可以显示tasks任务的帮助信息:

1.5.4 强制刷新依赖
我们一个功能不可避免的会依赖很多第三方库,像Maven这类工具都是有缓存的,因为不可能每次编译的时候都要重新下载第三方库,缓存就是这个目的,先使用缓存,没有再下载。默认情况下Maven这类工具会控制缓存的更新,但是也有例外,比如Version一样,但是里面的代码变了;还有就是联调测试时使用的snapshot版本。以上两种情况我们在实际项目中都遇到过,最后就是通过强制刷新解决的。强制刷新很简单,只要在命令行运行的时候加上--refresh-dependencies参数就可以,这是IDE很难做到的(需要你了解配置),所以命令行的优势就体现出来了,非常简单。
gradlew --refresh-dependencies assemble

1.5.5 多任务调用

有时候我们需要同事运行多个任务,比如在执行Jar之前先进行clean,那么我们就需要先执行clean对class文件清理,然后再执行jar生成一个jar包。通过命令行执行多个任务非常简单,只需要按顺序以空格分开即可,比如./gradlew clean jar,这样就可以了,有更多的任务时,可以继续添加。

1.5.6 通过任务名字缩写执行执行

有的时候我们的任务名字很长,Gradle提供了基于驼峰命名法的缩写调用,比如connectCheck,我们执行的时候可以使用./gradlew connectCheck,也可以使用./gradlew cc这样的方式来执行。


本文属自学历程, 仅供参考
详情请支持原书 Android Gradle权威指南

推荐阅读更多精彩内容

  • Gradle是一款非常优秀的构建系统工具,它的DSL基于Groovy实现,可以让你很方便的通过代码控制这些DSL来...
    飞雪无情flysnow_org阅读 2,094评论 0 36
  • 是什么? 在语法上是基于Groovy语言的(Groovy 是一种基于JVM的敏捷开发语言,可以简单的理解为强类型语...
    千山万水迷了鹿阅读 56,482评论 5 85
  • Gradle对于很多开发者来说有一种既熟悉又陌生的感觉,他是离我们那么近,以至于我每天做项目都需要他,但是他又是离...
    阿_希爸阅读 7,320评论 15 196
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 76,087评论 12 117
  • 学习本系列前可以下载相关的github项目gradleLearnDemo。地址:https://github.co...
    sososeen09阅读 543评论 0 2