Gradle快速入门学习
1 Gradle简介
1.1 概述
官网地址: https://gradle.org/
Gradle 是一款Google 推出的基于 JVM、通用灵活的项目构建工具,支持 Maven,JCenter 等多种第三方仓库;支持传递性依赖管理、废弃了繁杂的xml 文件,转而使用简洁的、支持多种语言(例如:java、groovy 等)的 build 脚本文件。目前市面上常见的项目构建工具还有Ant、Maven。
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 约定大于配置的项目目录优势,支持多种远程仓库和插件,侧重于大项目构建。缺点:学习成本高、资料少、脚本灵活、版本兼容性差等。
2 安装Gradle
Gradle官网:https://docs.gradle.org/current/userguide/userguide.html
Gradle官方下载安装教程页面:https://docs.gradle.org/current/userguide/userguide.html
Gradle官方用户手册:https://docs.gradle.org/current/userguide/userguide.html
Gradle要求安装环境的JDK版本在1.8以上
当前gradle的官方版本最新到8.14.2,考虑到
2.1下载并解压缩
点击 Binary-only下载,下载链接:https://services.gradle.org/distributions/gradle-8.14.2-bin.zip
解压到目录:D:\devTool\gradle-8.14.2
2.2 配置环境变量
配置GRADLE_HOME环境变量:
然后在Path变量中添加变量值的引用
特别注意:这里我们接着再配置一个GRADLE_USER_HOME 环境变量:
GRADLE_USER_HOME 相当于配置Gradle 本地仓库位置和 Gradle Wrapper 缓存目录。
通过gradle -v
或者 gradle --version
检测是否安装成功
2.3 Gradle项目的目录结构
Gradle 项目默认目录结构和Maven 项目的目录结构一致,都是基于约定大于配置(Convention Over Configuration)。其完整项目目录结构如下所示:
说明:
- 只有war工程才有webapp目录,对于普通的jar工程并没有webapp目录
- gradlew与gradlew.bat执行的指定wrapper版本中的gradle指令,不是本地安装的gradle指令。
3 Gradle常用指令
gradle 的指令要在含有build.gradle 的目录执行。
4 Maven下载源配置
Gradle 自带的Maven 源地址是国外的,该Maven 源在国内的访问速度是很慢的。一般情况下,我们建议使用国内的第三方开放的Maven 源或企业内部自建Maven 源。
我们可以在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/' }}}
}
4.1 init.gradle 文件说明
启动init.gradle文件的方法有:
- 在命令行指定文件,例如:gradle --init-script yourdir/init.gradle -q taskName。你可以多次输入此命令来指定多个init文件
- 把init.gradle文件放到 USER_HOME/.gradle/ 目录下
- 把以.gradle结尾的文件放到 USER_HOME/.gradle/init.d/ 目录下
- 把以.gradle结尾的文件放到 GRADLE_HOME/init.d/ 目录下
如果存在上面的4种方式的2种以上,gradle会按上面的1-4序号依次执行这些文件,如果给定目录下存在多个init脚本,会按拼音a-z顺序执行这些脚本,每个init脚本都存在一个对应的gradle实例,你在这个文件中调用的所有方法和属性,都会委托给这个gradle实例,每个init脚本都实现了Script接口。
4.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目录下存放jar文件不是按照maven仓库中存放的方式。
阿里云仓库地址请参考:https://developer.aliyun.com/mvn/guide
5 Gradle 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 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就不用下载了
- 4.之后执行的 ./gradlew 所有命令都是使用指定的 gradle 版本。如下图所示:
gradle-wrapper.properties 文件解读:
注意:前面提到的 GRALE_USER_HOME 环境变量用于这里的Gradle Wrapper 下载的特定版本的gradle 存储目录。如果我们没有配置过GRALE_USER_HOME 环境变量,默认在当前用户目录下的.gradle 文件夹中。
那什么时候选择使用 gradle wrapper、什么时候选择使用本地gradle?
下载别人的项目或者使用操作以前自己写的不同版本的gradle项目时用Gradle wrapper即gradlew
什么时候使用本地gradle?新建一个项目时,使用gradle指令即可。
6 IDEA中创建Java工程
第一步,创建由 Gradle 管理的项目
第二步:修改当前项目使用本地安装的 gradle,本地的Gradle配置了私服地址可以加快下载项目依赖 jar 包的速度
因为gradlew使用的是gradle wrapper,所以在 Terminal 中执行以 gradlew 开头命令和操作图形化的 IDEA 使用 Gradle 版本不一定是同一个版本哦。
当 我 们 在 gradle.build 文 件 添 加 依 赖 之 后 , 这 些 依 赖 会 在 下 载 到 GRADLE_USER_HOME/caches/modules-2/files-2.1 目录下面,所以这里的 GRADLE_USER_HOME 相当于 Gradle 的本地仓库,当然也可以如下方式找到 jar 包位置。
7 Gretty插件部署项目
当我们将一个 java 项目打成 war 包之后,就需要部署到服务器运行,这里有两种方式:
- 我们将项目打成 war 包,部署到本地 tomcat
- 使用 Gretty 插件中内置服务器方式部署项目
Gretty 官网地址:http://akhikhl.github.io/gretty-doc/index.html
Gretty 是一个功能丰富的 gradle 插件,用于在嵌入的 servlet 容器上运行 web 应用程序,让项目开发和部署更加简单。 目前 Gretty 插件已经作为 gradle 的核心库使用了,Gretty 其核心功能为:
- 底层支持 Jetty, Tomcat 等 Servlet 容器
- 支持项目热部署、HTTPS、调试。
下面是使用的基本步骤:
- 引入Gretty插件
plugins { id ‘war’id 'org.gretty' version '2.2.0'}
- 指定maven仓库
repositories {
//指定jcenter仓库,一定要放在前面 jcenter()
mavenCentral()
}
- 针对Gretty插件的设置
gretty { httpPort = 8888contextPath = "/web" debugPort = 5005 // default debugSuspend = true // default httpsEnabled = true managedClassReload=true //修改了类之后重新加载//servletContainer = 'tomcat8' //如果不指定默认的servlet容器,支持tomcat7/8,默认是使用的是Jetty服务器httpsPort = 4431}
- 执行Gretty插件
gradle appRun
如果大家想进一步了解的属性配置 , 比如 Gretty 热部署等设置 , 可以参考官方文档 http://akhikhl.github.io/gretty-doc/Gretty-configuration.html。
8 Gradle对测试的支持
测试任务自动检测并执行测试源集中的所有单元测试。测试执行完成后会生成一个报告。支持 JUnit 和 TestNG 测试。
8.1 默认测试目录及标准输出
8.2 Junit使用
dependencies {
testImplementation group: 'junit', name: 'junit', version: '4.12'
}test {useJUnit()
}
Gradle 对于 Junit5.x 版本支持
dependencies {
testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
}test {
useJUnitPlatform()
}
注意:无论是 Junt4.x 版本还是 Junit5.x 版本,我们只需在 build.gradle 目录下执行 gradle test 指令,gradle 就会帮我们执行所有的加了@Test 注解的测试,并生成测试报告。
8.3 包含和排除特定测试
test {
enabled true useJUnit()
include 'com/**'
exclude 'com/abc/**'
}
gradle 在 junit 中的批量测试,可以设置包含或者排除某些特定测试。
总结参考:https://www.bilibili.com/video/BV1yT41137Y7