第一章 Gradle入门

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

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


配置Gradle环境



Linux下搭建 Gradle 构建环境


Gradle 可运行在所有主流的操作系统上,只需要安装一个 Java JDK 或 JRE 8或更高版本即可。


运行 java -version 将检查 Java 环境:

$ java -version
java version "1.8.0_121"


先到 Gradle 官网 https://gradle.org/ 下载 Gradle。这里区分 binary-only 版或者 complete 版(with docs and sources)


将发行版 zip 文件解压缩到你选择的目录中,例如:

$ mkdir /opt/gradle
$ unzip -d /opt/gradle gradle-6.3-bin.zip


配置你的 PATH / 环境变量包含解压缩发行版的 bin 目录,例如:

GRADLE_HOME=/opt/gradle/gradle-6.3
PATH=$PATH:${GRADLE_HOME}/bin
export GRADLE_HOME PATH


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


如果你想让所有用户都可以使用gradle,那么你就需要在/etc/profile中添加以上内容,在这里添加后,对所有用户都生效,这种方式的添加,必须要重启电脑才可以

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


Window下搭建Gradle构建环境


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


Mac下搭建Gradle构建环境


同 Linux 类似。在终端中输入:open -e ~/.bash_profile,打开.bash_profile文件

GRADLE_HOME=/Users/ale/opt/gradle/gradle-7.2
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

$ gradle -v


Gradle 版 Hello World



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

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


cd 到对应目录,使用 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() 这个方法添加到 java.lang.Object,而在Groovy中,方法的调用可以省略签名中的括号,以一个空格分开即可,所以就有了上面的写法。还有一点要说明的就是在Groovy中,单引号和双引号所包含的内容都是字符串,不像 Java 中,单引号是字符,双引号才是字符串。


Gradle Wrapper



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


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


image.png


生成的文件


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


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


自定义Wrapper Task


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


image.png


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


Gradle日志



日志级别


image.png


日志级别

# 输出 quiet 级别及其以上的日志
gradle -q tasks
# 输出 info 级别及其以上的日志
gradle -i tasks


输出错误堆栈信息


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


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


image.png


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


通常情况下我们一般都是使用print系列方法,把日志信息输出到标准的控制台输出流(它被Gradle定向为QUIET级别日志)。


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


image.png


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


Gradle命令行



记得使用帮助


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


image.png


查看所有可执行的Tasks


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


gradle help 任务


除了上面我们说的每个命令行都有帮助外,Gradle还内置了一个help task,这个help可以让我们了解每一个task的使用帮助,


用法是 ./gradlew help --task <task name>,


比如 ./gradlew help --task tasks,就可以显示tasks任务的帮助信息:


强制刷新依赖


我们一个功能不可避免的会依赖很多第三方库,像 Maven 这类工具都是有缓存的,因为不可能每次编译的时候都要重新下载第三方库,缓存就是这个目的,先使用缓存,没有再下载。默认情况下Maven这类工具会控制缓存的更新,但是也有例外,比如 Version 一样,但是里面的代码变了;还有就是联调测试时使用的snapshot 版本。以上两种情况我们在实际项目中都遇到过,最后就是通过强制刷新解决的。


强制刷新很简单,只要在命令行运行的时候加上--refresh-dependencies 参数就可以,这是IDE很难做到的(需要你了解配置),所以命令行的优势就体现出来了,非常简单。

gradle --refresh-dependencies assemble


多任务调用


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


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


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


参考



本文纯属自学历程 + 一些记录,绝大部分内容来自原书 Android Gradle权威指南。觉得对你有用,请支持原书。



相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
4月前
|
XML Java 测试技术
Gradle安装部署与基础入门详解
Gradle安装部署与基础入门详解
460 0
|
Java 测试技术 Spring
Gradle从0入门到实战系列【八】SpringBoot集成Junit单元测试
JUnit 是一个 Java 编程语言的单元测试框架。JUnit 在测试驱动的开发方面有很重要的发展,是起源于 JUnit 的一个统称为 xUnit 的单元测试框架之一。
1310 1
Gradle从0入门到实战系列【八】SpringBoot集成Junit单元测试
|
Java API Apache
Gradle从0入门到实战系列【一】Hello World Gradle
早期没有项目管理工具时,对于项目所依赖的第三方包采用的是:拷贝三方jar包到本地,然后加入到lib目录下,这样做劣势不言而喻,管理复杂容易冲突。 Gradle是一个基于Apache Ant和Apache Maven概念的项目自动化构建开源工具。它使用一种基于Groovy的特定领域语言(DSL)来声明项目设置,也增加了基于Kotlin语言的kotlin-based DSL,抛弃了基于XML的各种繁琐配置。面向Java应用为主。
452 0
Gradle从0入门到实战系列【一】Hello World Gradle
|
9月前
|
XML Java Apache
Gradle极简入门
Gradle是一个基于Apache Ant和Apache Maven概念的项目自动化构建工具。它使用一种基于Groovy的特定领域语言(DSL)来声明项目设置,而不是传统的XML。Gradle构建脚本是用Groovy编写的,也可以使用Kotlin编写,两者都是基于JVM的语言。
239 0
|
XML 存储 缓存
|
弹性计算 Java jenkins
Gradle从0入门到实战系列【十】集成Dockerfile构建Docker镜像
在工作中,我们会将SpringBoot程序打包成Docker镜像,这就需要在Gradle中配置Dockerfile构建程序,并且能将打包后的镜像部署并启动为一个容器,Gradle的插件能够帮我们完成这件事
911 0
Gradle从0入门到实战系列【十】集成Dockerfile构建Docker镜像
|
缓存 Java Linux
Gradle从0入门到实战系列【九】仓库与私服
Gradle沿用了Maven仓库,在使用仓库时能够很友好的基于Maven仓库提供功能,但Gradle所产生的构建并不会提供给Maven仓库,因为Gradle自己拷贝了一份Maven本地仓库缓存到了自己仓库目录下。
961 0
Gradle从0入门到实战系列【九】仓库与私服
|
缓存 API
Gradle从0入门到实战系列【六】生命周期剖析
Gradle的核心是一种基于依赖的编程语言,任务与任务之间有一定的依赖关系,并且每个任务只会执行一次。在构建时,Gradle会把这些任务串联起来形成有向无环图。那Gradle是在什么时候进行串联的呢?这就需要充分了解Gradle在各个阶段做了什么事情了,从一开始到结束的这一连串动作我们称为生命周期。
255 0
Gradle从0入门到实战系列【六】生命周期剖析
|
Web App开发 Java 测试技术
Gradle从0入门到实战系列【五】工程化之插件
插件可以封装一系列任务,例如 编译,测试,打包等。 IDEA、VsCode、Eclipse、Maven、Chrome等都是支持插件集成的工具。插件意味着扩展,Gradle只要定义好插件规范,各大厂商或个人开发者遵循这个规范就能开发出很多有用的插件,从而丰富Gradle生态。
151 0
Gradle从0入门到实战系列【五】工程化之插件