Gradle安装部署与基础入门详解

时间:2022-12-05 01:15:51


【1】Gradle简介

Gradle 是一款Google 推出的基于JVM、通用灵活的项目构建工具,支持Maven,JCenter 多种第三方仓库;支持传递性依赖管理、废弃了繁杂的xml 文件,转而使用简洁的、支持多种语言(例如:java、groovy 等)的build 脚本文件。

官网地址: https://gradle.org/

Gradle安装部署与基础入门详解

① 常见的项目构建工具

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 约定大于配置的项目目录优势,支持多种远程仓库和插件,侧重于大项目构建。
  • 缺点:学习成本高、资料少、脚本灵活、版本兼容性差等。

Gradle安装部署与基础入门详解

② Gradle安装

下载

(需要先安装jdk1.8)与Maven一样,这里下载下来的是一个zip,需要解压进行环境变量配置。在如下页面https://gradle.org/releases/ 可以下载自己需要的版本,版本需要jdk、idea兼容哦。

Gradle安装部署与基础入门详解

配置环境变量

这里需要配置两个环境变量:

GRADLE_HOME
D:\softinstall\gradle\gradle-7.4

GRALE_USER_HOME
D:\Maven\workspace

GRADLE_HOME就是解压后的路径,这个GRALE_USER_HOME你没有看错,配置的是maven的仓库路径。GRALE_USER_HOME 相当于配置Gradle 本地仓库位置和Gradle Wrapper 缓存目录,我们是可以和maven仓库在一起的,当然也可以不用。

配置命令路径:

# 添加进path中
%GRADLE_HOME%\bin

常用命令

说明

gradle clean

清空build目录

gradle classes

编译业务代码和配置文件

gradle test

编译测试代码,生成测试报告

gradle build

构建项目

gradle build -x test

跳过测试构建构建

需要注意的是:gradle 的指令要在含有build.gradle 的目录执行。

③ Gradle 项目目录结构

Gradle 项目默认目录结构和Maven 项目的目录结构一致,都是基于约定大于配置。

其完整项目目录结构如下所示:

Gradle安装部署与基础入门详解

可以看到基础工程目录结构是相似的,build目录类似以前javase时编译后的目录。我们主要使用的配置文件就是build.gradle和settings.gradle。

④ Wrapper 包装器

Gradle Wrapper 实际上就是对Gradle 的一层包装,用于解决实际开发中可能会遇到的不同的项目需要不同版本的Gradle问题。例如:把自己的代码共享给其他人使用,可能出现如下情况:

1.对方电脑没有安装gradle
2.对方电脑安装过gradle,但是版本太旧了

这时候,我们就可以考虑使用Gradle Wrapper 了。这也是官方建议使用Gradle Wrapper 的原因。实际上有了GradleWrapper 之后,我们本地是可以不配置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版本
--gradle-version

# : 用于指定下载Gradle发行版的url地址
--gradle-distribution-url

# 升级wrapper版本号,只是修改gradle.properties中wrapper版本,未实际下载
gradle wrapper --gradle-version=4.4

#:关联源码用
gradle wrapper --gradle-version 5.2.1 --distribution-type all

GradleWrapper 的执行流程:

1.当我们第一次执行./gradlew build 命令的时候,gradlew 会读取gradle-wrapper.properties 文件的配置信息

2.准确的将指定版本的gradle 下载并解压到指定的位置(GRADLE_USER_HOME目录下的wrapper/dists目录中)

3.并构建本地缓存(GRADLE_USER_HOME目录下的caches目录中),后面再使用相同版本的gradle就不用下载了

4.之后执行的./gradlew 所有命令都是使用指定的gradle 版本。

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?新建一个项目时: 使用gradle指令即可。

【2】修改maven 下载源

Gradle 自带的Maven 源地址是国外的,该Maven 源在国内的访问速度是很慢的,除非使用了特别的手段。一般情况下,我们建议使用国内的第三方开放的Maven 源或企业内部自建Maven 源。

我们可以在gradle 的init.d 目录下创建以.gradle 结尾的文件,.gradle 文件可以实现在build 开始之前执行,所以你可以在这个文件配置一些你想预先加载的操作。

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/' }
		}
	}
}

① 启用init.gradle 文件的方法

1.在命令行指定文件,例如:gradle --init-script yourdir/init.gradle -q taskName。你可以多次输入此命令来指定多个init文件

2.把init.gradle文件放到USER_HOME/.gradle/ 目录下

3.把以.gradle结尾的文件放到USER_HOME/.gradle/init.d/ 目录下

4.把以.gradle结尾的文件放到GRADLE_HOME/init.d/ 目录下

如果存在上面的4种方式的2种以上,gradle会按上面的1-4序号依次执行这些文件,如果给定目录下存在多个init脚本,会按拼音a-z顺序执行这些脚本,每个init脚本都存在一个对应的gradle实例,你在这个文件中调用的所有方法和属性,都会委托给这个gradle实例,每个init脚本都实现了Script接口。

② 仓库地址说明

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仓库中存放的方式。

阿里云仓库地址请参考:https://developer.aliyun.com/mvn/guide

Gradle安装部署与基础入门详解

【3】创建工程

① 使用spring脚手架创建

官网地址是:https://start.spring.io/

Gradle安装部署与基础入门详解

得到的工程目录结构如下所示:

Gradle安装部署与基础入门详解

修改idea配置gradle:

Gradle安装部署与基础入门详解

特别提示1

使得在Terminal 中执行以gradlew 开头命令和操作图形化的IDEA 使用Gradle 版本不一定是同一个版本哦。

  • 1.Terminal中以gradlew开头指令用的是Wrapper规定的gradle版本,wrapper中规定版本默认和idea插件中规定的版本一致。
  • 2.而图形化的IDEA使用Gradle是本地安装的哦。

特别提示2

目前只能是在创建项目时重新设置本地gradle,创建新项目需要重新去改。

特别提示3

当我们在gradle.build 文件添加依赖之后, 这些依赖会在下载到GRADLE_USER_HOME/caches/modules-2/files-2.1 目录下面,所以这里GRADLE_USER_HOME 相当于Gradle 的本地仓库,当然也可以如下方式找到jar 包位置。

Gradle安装部署与基础入门详解

② 使用命令创建

在一个空白文件夹下,使用命令gradle init 也可以初始化工程。

Gradle安装部署与基础入门详解

③ 配置依赖

如下所示在工程的build.gradle文件的dependencies可以配置我们需要的依赖。

# 是不是maven中的groupId:artifactId:version?
implementation 'org.springframework:spring-beans:4.1.7.RELEASE'
implementation 'org.springframework:spring-web:4.1.7.RELEASE'
implementation 'org.springframework:spring-webmvc:4.1.7.RELEASE'
implementation 'org.springframework:spring-tx:4.1.7.RELEASE'
implementation 'org.springframework:spring-test:4.0.5.RELEASE'
implementation 'org.springframework:spring-jdbc:4.1.7.RELEASE'

implementation 'org.mybatis:mybatis-spring:1.2.3'
implementation 'org.mybatis:mybatis:3.3.0'

implementation 'mysql:mysql-connector-java:5.1.36'
implementation 'com.alibaba:druid:1.0.15'

implementation "com.fasterxml.jackson.core:jackson-databind:2.2.3"
implementation "com.fasterxml.jackson.core:jackson-annotations:2.2.3"
implementation "com.fasterxml.jackson.core:jackson-core:2.2.3"

implementation 'org.aspectj:aspectjweaver:1.8.6'
implementation 'log4j:log4j:1.2.17'
implementation 'org.slf4j:slf4j-api:1.7.25'
implementation 'jstl:jstl:1.2'
compileOnly 'javax.servlet:servlet-api:2.5'

testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'

Gradle安装部署与基础入门详解

④ 打包

build.gradle文件中plugins可以指定打jar还是war,默认是jar包。

plugins {
    id 'java'
    id 'war'
}

编写外代码后,就可以如maven一样使用进行打包,如下图所示:

Gradle安装部署与基础入门详解

【4】Groovy

在某种程度上,Groovy 可以被视为Java 的一种脚本化改良版,Groovy 也是运行在JVM 上,它可以很好地与Java 代码及其相关库进行交互操作。它是一种成熟的面向对象编程语言,既可以面向对象编程,又可以用作纯粹的脚本语言。大多数有效的Java 代码也可以转换为有效的Groovy 代码,Groovy 和Java 语言的主要区别是:完成同样的任务所需的Groovy 代码比Java 代码更少。其特点为:

  • 功能强大,例如提供了动态类型转换、闭包和元编程(metaprogramming)支持
  • 支持函数式编程,不需要main 函数
  • 默认导入常用的包
  • 类不支持default 作用域,且默认作用域为public。
  • Groovy 中基本类型也是对象,可以直接调用对象的方法。
  • 支持DSL(Domain Specific Languages 领域特定语言)和其它简洁的语法,让代码变得易于阅读和维护。

Groovy 是基于Java 语言的,详细了解请参考:http://www.groovy-lang.org/documentation.html

因为 Gradle是2012 年Google 推出的基于Groovy 语言的全新项目构建工具,所以还是有必要了解一下Groovy语言的。

① 下载并配置

官网地址:https://groovy.apache.org/download.html下载即可。

类似Gradle一样,下载、解压、配置环境变量,添加进path

GROOVY_HOME
D:\softinstall\groovy\groovy-4.0.2

# 如下添加进path
%GROOVY_HOME%\bin

② 创建工程

Gradle安装部署与基础入门详解

【5】Gradle对测试的支持

测试任务自动检测并执行测试源集中的所有单元测试。测试执行完成后会生成一个报告。支持JUnit 和TestNG 测试。

默认测试目录及标准输出

Gradle安装部署与基础入门详解

① Junit的使用

Gradle 对于Junit4.x 支持

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 注解的测试,并生成测试报告。

② 包含和排除特定测试

test {
	enabled true
	useJUnit()
	include 'com/**'
	exclude 'com/abc/**'
}

Gradle安装部署与基础入门详解