【译】The Gradle Wrapper

一.  The Gradle Wrapper(这是Gradle Wrapper的总览,部分翻译)

大多数工具在使用前要求先安装到你的电脑上。如果安装过程很简单,你会觉得可以接受,但这有可能在build时对用户造成不必要的麻烦。另外,同样重要的一点是,当我们在build时,对于这些工具,用户是否安装的了正确的版本?假设他们build了一个老版本的软件会怎样呢?

作为Gradle build的推荐方式,The Gradle Wrapper(此后简称Wrapper)解决了如上两个问题。

1. 使用Wrapper执行build

如果一个Gradle工程已经设置过了Wrapper(我们推荐所有的工程这样做),你可以在项目的根目录下使用如下命令行之一执行build操作

  • /gradlew <task> (on Unix-like platforms such as Linux and Mac OS X)
  • /gradlew <task> (on Windows using the gradlew.bat batch file)
    每个Wrapper都与一个Gradle相关联。所以指定一个Gradle版本执行如上指令,都会去下载相应的Gradle distribution,并且使用它去执行build

这不仅意味着你不需要去人为的安装Gradle,还意味着那你能确保所使用的Gradle版本是这个build所指定的。这使得你历史的build都更加可靠。无论何时,无论你是在使用说明,Stack Obverflow,文章还是哪里,当你看到一行命令是以gradle...开头的,你都可以使用如上恰当指令。

在一个Gradle工程中,为了保证Wrapper的完整性,并且为了确保你不会删除Wrapper中任何重要的文件,这里列出了组成Wrapper的文件和目录:

  • gradlew (Unix Shell script)
  • gradlew.bat (Windows batch file)
  • gradle/wrapper/gradle-wrapper.jar (Wrapper JAR)
  • gradle/wrapper/gradle-wrapper.properties (Wrapper properties

如果你想知道Gradle distributions存放在哪,你可以在你的用户根目录下的$USER_HOME/.gradle/wrapper/dists下找到。

2. 将Wrapper添加到工程汇中

Wrapper是必须纳入版本控制的。当将wrapper配置到你的工程后,每个人都可以直接使用而不用事先安装。更牛的是,每个使用者都可以确保使用是build可支持的版本。当然,这对于CI(Continuous Integration 持续集成 )的服务器(比如:常规build你项目的服务器)也是非常有帮助的,因为不需要再server上进行配置。

通过执行Wrapper task(这条task永远是有效的,即使你没有把它加入你的build中),你可以安装Wrapper到你的工程中。在命令行中使用--gradle-version用于指定一个Gradle的版本。默认情况下,Wrapper会使用bin distribution(因为这是最小体积的Gralde distribution)。一些IDEAAndroid StudioIntellij IDEA提供了可选的环境信息,当使用all distribution时。你可以通过使用--distribution-type选择不同的Gradle distribution类型。你同样可以使用--gradle-distribution-url,通过设置distribution URL直接去下载相应的Gradle。如果没有明确版本号或者distribution URL,the Wrapper will be configured to use the gradle version the wrapper task is executed with. 所以当你使用Gradle 2.4run Warapper taskWrapper configuration就会被默认为2.4版本。

其实上面教的如何在工程中添加Wrapper,我们是不用管的。

因为AS工程建立时默认就把第1节的4个文件包含进来了,不需要自己搭环境去拉取。

二.  Wrapper(与上面完全不同,这个Wrapper只表示Gradle的一个Task,只翻译第一段)

这个Task的作用是:生成一些脚本(Linux/Unix 和 windows),可以让你使用Gradlebuild你的工程,而无需事先安装Gradle

当用户执行第一次执行wrapper脚本时,脚本会下载相应的Gradle distribution并且使用下载后的distribution去执行build操作。当使用wrapper脚本时,任何已经安装的Gradle distribution将会被忽略。

通过该Task生成的的脚本,应该被包含到版本控制系统中。该Task生成的名为gradle-wrapper.jar的小的引导JAR和属性文件,同样需要包含到版本控制系统中。这些脚本就是JAR的代理。

这个文档是Gradle的官方文档,讲述Wrapper这个Task的作用:
由该Task生成gradlew/gradlew.bat脚本以及gradle-wrapper.jargradle-wrapper.properties文件。

而我们在AS的实际使用中,并不会去run这个task去生成上面的文件,新建一个项目时这些文件默认都会被创建。我要使用这些文件去下载相应的Gradle,以及去build。而不是从头开始造车轮。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 前言 从2013年Google推出Android Studio(后面以AS简称)开始,到现在已经历经3年,版本也发...
    dfqin阅读 5,853评论 1 3
  • 本文Demo的完整工程代码, 参考这里的StudyPackage 目录 什么是Gradle 为什么是Gradle ...
    诺之林阅读 7,591评论 0 18
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 47,084评论 6 342
  • Gradle是一款非常优秀的构建系统工具,它的DSL基于Groovy实现,可以让你很方便的通过代码控制这些DSL来...
    飞雪无情flysnow_org阅读 8,870评论 0 35
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,534评论 19 139