Gradle 入门:Gradle Wrapper

----《Android Gradle 权威指南》学习笔记

总目录:Gradle 学习系列 -- 目录
上一篇:Gradle 入门:Hello World
下一篇:Gradle 入门:日志

1 Gradle Wrapper 简介

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

1.2 一般在项目开发中,用的都是 wrapper 这种方式,而不是自己下载 gradle 的压缩包,解压后配置 gradle 环境变量的方式。 wrapper 在 Windows 下是一个批处理文件,在 Linux 下是一个 shell 脚本。当使用 wrapper 启动 gradle 的时候,wrapper 会自动检查 gradle 是否被下载关联,如果没有则会从配置的地址进行下载并运行构建。这种方式对开发人员是非常方便的,因为不用再去专门配置 gradle 环境了,只要执行 wrapper 命令即可,wrapper 它会自动搞定一切。 ---- IDE 中就是这种方式。

2 生成 Wrapper

2.1 Gradle 提供了内置的任务 wrapper task 来自动生成 wrapper 所需的目录及文件,在项目的根目录中(一般是 build.gradle 的路径下)输入命令 gradle wrapper 即可生成, 如图所示:
1.5-1.png
1.5-2.png

2.2 各个文件的作用说明如下:

(1) gradlew 和 gradlew.bat 分别 Linux 和 Windows 下的可执行脚本。用法和 Gradle 原生命令是一样的。比如同样执行 taskHello 任务,两种命令的结果是相同的:
1.5-3.png

但是有一点需要注意:
gradle taskHello 是用在系统环境变量中配置的 Gradle 版本来执行任务的,如果找不到 Gradle 则会报错
gradlew taskHello 是用在 ./gradle/wrapper/gradle-wrapper.properties 配置的 Gradle 版本来执行任务的,如果找不到对应的 Gradle 则会去配置的链接中下载,下载的默认路径是 C 盘中的 .gradle 文件夹。

(2) gradle-wrapper.jar 是具体业务逻辑实现的 jar 包 gradlew 最终还是使用 java 执行这个 jar 包来执行 Gradle 的相关操作。
(3) gradle-wrapper.properties 是配置文件,用于配置使用哪个版本的 Gradle。

2.3 生成的这些 wrapper 文件可以随着项目工程一起提交到版本控制系统里面(比如 git),这样后续开发也会按照提交的配置好的 Gradle 版本进行统一构建开发。

3 wrapper 配置

3.1 在执行命令 gradle wrapper 时可以指定一些参数来控制 wrapper 的生成。具体有如下两个配置参数:

--gradle-version  用于指定使用的 Gradle 的版本
--gradle-distribution-url 用于指定下载 Gradle 版本的URL,该值的规则是 http://services.gradle.org/distributions/gradle-${gradleVersion}-bin.zip

3.2 gradle-wrapper.properties 是 gradle 的配置文件。在执行命令 gradle wrapper 时的参数配置会写入该文件中,具体的字段说明如下:

distributionBase    下载 Gradle 压缩包解压后存储的主目录
distributionPath    相对于 distributionBase 的解压后的 Gradle 压缩包的路径 
zipStoreBase        同 distributionBase,区别是存放的是 zip 压缩包
zipStorePath        同 distributionPath,区别是存放的是 zip 压缩包
distributionUrl     Gradle 发行版本压缩包的下载地址  ---- 比较关注的是这个配置字段

3.3 如果运行 ./gradlew 的时候一直卡着不动,可能是因为官方的 Gradle 地址被封闭了,可以把 distributionUrl 换成其他的镜像地址尝试。

4 自定义配置 wrapper task 生成 gradle wrapper

4.1 我们可以对 wrapper task 进行修改,生成自定义配置的 gradle-wrapper.properties

4.2 在 build.gradle 构建脚本中配置以下代码:

task wrapper(type: Wrapper){
     gradleVersion = '7.1'
     archiveBase = 'GRADLE_USER_HOME'
     archivePath = 'wrapper/dists'
     distributionBase = 'GRADLE_USER_HOME"'
     distributionPath = 'wrapper/dists'
     distributionUrl = 'http\://services.gradle.org/distributions/gradle-7.1-all.zip'
}

这样在执行 gradle wrapper 就会生成7.1版本的 wrapper 了,而不用使用 --gradle-version 7.1 这样的命令进行指定了。

相关代码:https://gitee.com/fzq.com/gradle-demos
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,717评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,501评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,311评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,417评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,500评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,538评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,557评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,310评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,759评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,065评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,233评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,909评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,548评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,172评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,420评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,103评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,098评论 2 352

推荐阅读更多精彩内容