gradle项目、任务、插件、仓库、依赖等概念解释
名词解释
DAG:有向无环图(理解:有方向但没有闭环),构建实质上配置了一组任务,并根据它们的依赖关系将它们连接在一起以创建该DAG。创建任务图后,Gradle将确定需要按顺序运行的任务,然后继续执行它们。
任务本身包括以下部分,它们通过依赖链接在一起:
- 动作-做某事的工作,例如复制文件或编译源代码
- 输入-操作使用或对其进行操作的值,文件和目录
- 输出-操作修改或生成的文件和目录
Projects 和 tasks
任何一个 Gradle 构建都是由一个或多个 projects 组成。每个 project 包括许多可构建组成部分。 这完全取决于你要构建些什么。举个例子,每个 project 或许是一个 jar 包或者一个 web 应用,它也可以是一个由许多其他项目中产生的 jar 构成的 zip 压缩包。
每个 project 都由多个 tasks 组成。每个 task 都代表了构建执行过程中的一个原子性操作。如编译,打包,生成 javadoc,发布到某个仓库等操作。
xxx.gradle就是gradle的构建配置,但它在gradle中叫做脚本;
运行 gradle tasks 列出任务列表;
gradle的域模型理解:gradle脚本提供了project、task、dependences、reponsitories等域结构写法,这些域模型是基于groovy语言开发的。
gradle构建脚本基于gradle提供的域模型来编写,同时也可以使用groovy来写额外的逻辑。
gradle插件背景:
Gradle 是一个通用工具。它可以通过脚本构建任何你想要实现的东西,真正实现开箱即用。但前提是你需要在脚本中编写好代码才行。
大部分 Java 项目基本流程都是相似的:编译源文件,进行单元测试,创建 jar 包。使用 Gradle 做这些工作不必为每个工程都编写代码。Gradle 已经提供了完美的插件来解决这些问题。插件就是 Gradle 的扩展,简而言之就是为你添加一些非常有用的默认配置。Gradle 自带了很多插件,并且你也可以很容易的编写和分享自己的插件。Java plugin 作为其中之一,为你提供了诸如编译,测试,打包等一些功能。
仓库
Gradle 是在一个被称之为仓库的地方找寻所需的外部依赖。仓库即是一个按 group,name 和 version 规则进行存储的一些文件。Gradle 可以支持不同的仓库存储格式,如 Maven 和 Ivy,并且还提供多种与仓库进行通信的方式,如通过本地文件系统或 HTTP。
默认情况下,Gradle 没有定义任何仓库,你需要在使用外部依赖之前至少定义一个仓库,例如 Maven 中央仓库。
一个项目可以采用多个库。Gradle 会按照顺序从各个库里寻找所需的依赖文件,并且一旦找到第一个便停止搜索。
Gradle修改本地仓库的位置
Gradle和Maven都是当前热门的自动化构建工具。使用Gradle去构建项目,由于没有办法像Maven一样配置Setting文件来修改本地库的位置,我们可以通过设置环境变量GRADLE_USER_HOME的路径来改变gradle的本地仓库的位置。
因为Gradle如果不配置环境变量,则会在用户主目录下(Windows下是C:\Users\xxx目录)创建.gradle目录,并将下载的依赖文件保存在这个目录里。
如果不想使用缺省目录,则可以设置环境变量GRADLE_USER_HOME的路径,就可改变gradle的仓库目录。
Project API
gradle在构建的每一个项目中,Gradle 创建了一个 Project 类型的实例,并在构建脚本中关联此 Project 对象。当构建脚本执行时,它会配置此 Project 对象:
- 在构建脚本中,你所调用的任何一个方法,如果在构建脚本中未定义,它将被委托给 Project 对象。
- 在构建脚本中,你所访问的任何一个属性,如果在构建脚本里未定义,它也会被委托给 Project 对象。
标准 project 属性
Project对象提供了一些在构建脚本中可用的标准的属性。下表列出了常用的几个属性。
表 13.1. Project 属性
名称 | 类型 | 默认值 |
project | Project 实例 | |
name | String | 项目目录的名称。 |
path | String | 项目的绝对路径。 |
description | String | 项目的描述。 |
projectDir | File | 包含生成脚本的目录。 |
buildDir | File | projectDir /build |
group | Object | 未指定 |
version | Object | 未指定 |
ant | AntBuilder 实例 |
gradle默认构建目录:project目录/build/ 目录
Script API
当 Gradle 执行一个脚本时,它将脚本编译为一个实现了 Script 接口的类。这意味着所有由该Script 接口声明的属性和方法在您的脚本中是可用的。
声明变量
有两类可以在生成脚本中声明的变量: 局部变量和额外属性。
局部变量局部
局部变量是用 def 关键字声明的。它们只在定义它们的范围内可以被访问。局部变量是 Groovy 语言底层的一个特征。
额外属性
Gradle 的域模型中,所有增强的对象都可以容纳用户定义的额外的属性。这包括但并不限于项目(project)、任务(task)和源码集(source set)。额外的属性可以通过所属对象的 ext 属性进行添加,读取和设置。或者,可以使用 ext 块同时添加多个属性。
gradle的域模型理解:gradle脚本提供了project、task、dependences、reponsitories等域结构写法,这些域模型是基于groovy语言开发的。
依赖
gradle依赖的粒度控制相较于Maven也更加精细,maven只有compile、provided、test、runtime四种scope,而gradle有以下几种scope:
1.implementation,默认的scope。implementation的作用域会让依赖在编译和运行时均包含在内,但是不会暴露在类库使用者的编译时。举例,如果我们的类库包含了gson,那么其他人使用我们的类库时,编译时不会出现gson的依赖。
2.api,和implementation类似,都是编译和运行时都可见的依赖。但是api允许我们将自己类库的依赖暴露给我们类库的使用者。
3.compileOnly和runtimeOnly,这两种顾名思义,一种只在编译时可见,一种只在运行时可见。而runtimeOnly和Maven的provided比较接近。
4.testImplementation,这种依赖在测试编译时和运行时可见,类似于Maven的test作用域。
5.testCompileOnly和testRuntimeOnly,这两种类似于compileOnly和runtimeOnly,但是作用于测试编译时和运行时。