文章目录
- 一、Gradle入门
- 1.1 Gradle 简介
- 1.2 常见的项目构建工具
- 1.3 Gradle 安装
- 1.3.1 Gradle 安装说明
- 1.3.2 安装 JDK
- 1.3.3 下载并解压到指定目录
- 1.3.4 配置环境变量
- 1.3.5 检测是否安装成功
- 1.4 Gradle 项目目录结构
- 1.5 Gradle 创建第一个项目
- 1.5.1 Gradle 中的常用命令
- 1.5.2 修改 maven 下载源
- 1.5.3 Wrapper 包装器
【尚硅谷】Gradle教程-讲师:刘辉
生活明朗,万物可爱,人间值得,未来可期
一、Gradle入门
1.1 Gradle 简介
Gradle 是一款 Google 推出的基于 JVM、通用灵活的项目构建工具,支持 Maven,JCenter 多种第三方仓库。
支持传递性依赖管理、废弃了繁杂的 xml 文件,转而使用简洁的、支持多种语言(例如:java、groovy 等)的build 脚本文件。
Gradle官网地址
学习 Gradle 的原因:
- 目前已经有相当一部分公司在逐渐使用Gradle作为项目构建工具了。
- 作为Java开发程序员,如果想下载Spring、SpringBoot等Spring家族的源码,基本上基于Gradle构建的。
总之,虽然目前市面上常见的项目构建工具有 Ant、Maven、Gradle,主流还是 Maven,但是未来趋势 Gradle。
1.2 常见的项目构建工具
- Ant: 2000 年 Apache 推出的纯 Java 编写构建工具,通过 xml[build.xml]文件管理项目
- 优点:使用灵活,速度快(快于 gradle 和 maven)。
- 缺点:Ant 没有强加任何编码约定的项目目录结构,开发人员需编写繁杂 XML 文件构建指令,对开发人员是一个挑战。
- Maven:2004 年 Apache 组织推出的再次使用 xml 文件[pom.xml]管理项目的构建工具
- 优点:遵循一套约定大于配置的项目目录结构,使用统一的 GAV 坐标进行依赖管理,侧重于包管理。
- 缺点:项目构建过程僵化,配置文件编写不够灵活、不方便自定义组件,构建速度慢于 gradle。
- Gradle:2012 年 Google 推出的基于 Groovy 语言的全新项目构建工具,集合了 Ant 和 Maven 各自的优势
- 优点:集 Ant 脚本的灵活性+Maven 约定大于配置的项目目录优势,支持多种远程仓库和插件,侧重于大项目构建。
- 缺点:学习成本高、资料少、脚本灵活、版本兼容性差等。
Whatever:无论哪种项目构建工具,都有自身的优势和劣势,所以选择一款最适合自己的就是最好的。
1.3 Gradle 安装
1.3.1 Gradle 安装说明
SpringBoot 官方文档明确指出,目前 SpringBoot 的 Gradle 插件需要 gradle6.8 版本及以上,所以我们这里选择 7.x 版本。
其中 SpringBoot 与 Gradle 存在版本兼容问题,Gradle 与 Idea 也存在兼容问题,所以考虑到 java 程序员会使用 SpringBoot,所以要选择 6.8 版本及高于 6.8 版本的 Gradle,那么相应的 idea 版本也要升级,不能太老。
具体参考文档
在IDEA的目录中查看与当前版本匹配的gradle版本(IntelliJ IDEA 2022.1.3\plugins\gradle\lib)
1.3.2 安装 JDK
要求 Jdk 为 1.8 或者 1.8 版本以
1.3.3 下载并解压到指定目录
-
下载
Gradle官网下载地址
完整版与二进制的区别:
增加Gradle文档与Gradle源码 -
解压到指定目录: D:\Environment\gradle-7.5.1(这个地址随意,自己能找到就可以)
1.3.4 配置环境变量
GRADLE_USER_HOME 相当于配置 Gradle 本地仓库位置和 Gradle Wrapper 缓存目录。
GRADLE_HOME
GRADLE_USER_HOME
1.3.5 检测是否安装成功
gradle -v 或者 gradle --version: 通过gradle -v或者 gradle --version检测是否安装成功
1.4 Gradle 项目目录结构
Gradle 项目默认目录结构和 Maven 项目的目录结构一致,都是基于约定大于配置【Convention Over Configuration】。
其完整项目目录结构如下所示:
Tipe:
- 只有war工程才有webapp目录,对于普通的jar工程并没有webapp目录。
- gradlew与gradlew.bat执行的指定wrapper版本中的gradle指令,不是本地安装的gradle指令哦。
1.5 Gradle 创建第一个项目
借助于 spring 脚手架创建 gradle第一个项目
查看生成的 gradle 项目目录结构如下所
与上图对比会发现:总体的目录结构与上图说明的是一致的。
1.5.1 Gradle 中的常用命令
Gradle 常用命令说明:
常用gradle命令 | 作用 |
---|---|
gradle clean | 清空build目录 |
gradle classes | 编译业务代码和配置文件 |
gradle test | 编译测试代码,生成测试报告 |
gradle build | 构建项目 |
gradle build -x test | 跳过测试构建 |
需要注意的是:gradle 的指令要在含有 build.gradle 的目录执行。
1.5.2 修改 maven 下载源
Gradle 自带的 Maven 源地址是国外的,该 Maven 源在国内的访问速度是很慢的,除非使用了特别的手段。
一般情况下,我们建议使用国内的第三方开放的 Maven 源或企业内部自建 Maven 源。
认识 init.d 文件夹
我们可以在 gradle 的 init.d 目录下创建以.gradle 结尾的文件,.gradle 文件可以实现在 build 开始之前执行,所以你可以在
这个文件配置一些你想预先加载的操作。
在 init.d 文件夹创建 init.gradle文件
allprojects {
repositories {
mavenLocal()
maven { name "Alibaba" ; url "https://maven.aliyun.com/repository/public" }
maven { name "Bstek" ; url "https://nexus.bsdn.org/content/groups/public/" }
mavenCentral()
}
buildscript {
repositories {
maven { name "Alibaba" ; url 'https://maven.aliyun.com/repository/public' }
maven { name "Bstek" ; url 'https://nexus.bsdn.org/content/groups/public/' }
maven { name "M2" ; url 'https://plugins.gradle.org/m2/' }
}
}
}
拓展 1:启用 init.gradle
- 在命令行指定文件,例如:gradle --init-script yourdir/init.gradle -q taskName。
你可以多次输入此命令来指定多个init文件。 - 把init.gradle文件放到 USER_HOME/.gradle/ 目录下(当前用户家目录下的.gradle文件夹下)。
- 把以.gradle结尾的文件放到 USER_HOME/.gradle/init.d/ 目录下(当前用户家目录下的.gradle/init.d文件夹下)。
- 把以.gradle结尾的文件放到 GRADLE_HOME/init.d/ 目录下。
如果存在上面的4种方式的2种以上,gradle会按上面的1-4序号依次执行这些文件。
如果给定目录下存在多个init脚本,会按拼音a-z顺序执行这些脚本,每个init脚本都存在一个对应的gradle实例。
你在这个文件中调用的所有方法和属性,都会委托给这个gradle实例,每个init脚本都实现了Script接口。
拓展 2:仓库地址说明
mavenLocal():指定使用maven本地仓库,而本地仓库在配置maven时settings文件指定的仓库位置。
如E:/repository,gradle 查找jar包顺序如下:USER_HOME/.m2/settings.xml >> M2_HOME/conf/settings.xml >> USER_HOME/.m2/repository
maven { url 地址},指定maven仓库,一般用私有仓库地址或其它的第三方库【比如阿里镜像仓库地址】。
mavenCentral():这是Maven的中央仓库,无需配置,直接声明就可以使用。
jcenter():JCenter中央仓库,实际也是是用的maven搭建的,但相比Maven仓库更友好,通过CDN分发,并且支持https访
问,在新版本中已经废弃了,替换为了mavenCentral()。
总之,gradle可以通过指定仓库地址为本地maven仓库地址和远程仓库地址相结合的方式,避免每次都会去远程仓库下载依赖库。
这种方式也有一定的问题,如果本地maven仓库有这个依赖,就会从直接加载本地依赖,如果本地仓库没有该依赖,那么还是会从远程下载。
但是下载的jar不是存储在本地maven仓库中,而是放在自己的缓存目录中,默认在USER_HOME/.gradle/caches目录,当然如果我们配置过GRADLE_USER_HOME环境变量,则会放在GRADLE_USER_HOME/caches目录。
不可以将gradle caches指向maven repository,caches下载文件不是按照maven仓库中存放的方式。
拓展 3:阿里云仓库地址
在 gradle 中的使用说明:
1.5.3 Wrapper 包装器
Gradle Wrapper 实际上就是对 Gradle 的一层包装,用于解决实际开发中可能会遇到的不同的项目需要不同版本的 Gradle 问题。
例如:把自己的代码共享给其他人使用,可能出现如下情况:
- 对方电脑没有安装 gradle
- 对方电脑安装过 gradle,但是版本太旧
这时候,我们就可以考虑使用 Gradle Wrapper 了。
这也是官方建议使用 Gradle Wrapper 的原因。
实际上有了 Gradle Wrapper 之后,我们本地是可以不配置 Gradle 的,下载 Gradle 项目后,使用 gradle 项目自带的 wrapper 操作也是可以的。
那如何使用 Gradle Wrapper 呢?
- 项目中的gradlew、gradlew.cmd脚本用的就是wrapper中规定的gradle版本。参见源码
- 而我们上面提到的gradle指令用的是本地gradle,所以gradle指令和gradlew指令所使用的gradle版本有可能是不一样的。
- gradlew、gradlew.cmd的使用方式与gradle使用方式完全一致,只不过把gradle指令换成了gradlew指令。
当然,我们也可在终端执行 gradlew 指令时,指定指定一些参数,来控制 Wrapper 的生成,比如依赖的版本等,如下:
参数名 | 说明 |
---|---|
–gradle-version | 用于指定使用的Gradle版本 |
–gradle-distribution-url | 用于指定下载Gradle发行版的url地址 |
具体操作如下所示 :
gradle wrapper --gradle-version=4.4:升级wrapper版本号,只是修改gradle.properties中wrapper版本,未实际下载
gradle wrapper --gradle-version 5.2.1 --distribution-type all
GradleWrapper 的执行流程:
- 当我们第一次执行 ./gradlew build 命令的时候,gradlew 会读取 gradle-wrapper.properties 文件的配置信息
- 准确的将指定版本的 gradle 下载并解压到指定的位置(GRADLE_USER_HOME目录下的wrapper/dists目录中)
- 并构建本地缓存(GRADLE_USER_HOME目录下的caches目录中),下载再使用相同版本的gradle就不用下载了
- 之后执行的 ./gradlew 所有命令都是使用指定的 gradle 版本。如下图所示:
gradle-wrapper.properties 文件解读
字段名 | 说明 |
---|---|
distributionBase | 下载的Gradle压缩包解压后储存的主目录 |
distributionPath | 相对于distributionBase的解压包的Gradle压缩包的路径 |
zipStoreBase | 同distributionBase,只不过是存放zip压缩包 |
zipStorePath | 同distributionPath,只不过是存放zip压缩包的 |
distributionUrl | Gradle发行版压缩包的下载地址 |
注意:
前面提到的 GRALE_USER_HOME 环境变量用于这里的 Gradle Wrapper 下载的特定版本的 gradle 存储目录。
如果我们没有配置过 GRALE_USER_HOME 环境变量,默认在当前用户家目录下的.gradle 文件夹中。
那什么时候选择使用 gradle wrapper、什么时候选择使用本地 gradle?
下载别人的项目或者使用操作以前自己写的不同版本的gradle项目时:用Gradle wrapper,也即:gradlew
当新建一个项目时: 使用gradle指令即可。