Gradle之Wrapper详解

转自：Gradle之Wrapper详解 - 简书

介绍

Wrapper，看到这个单词大家应该都不陌生，它就是位于Android项目根目录下的gradle文件夹中的gradle-wrapper.properties脚本文件。其实它就是对Gradle的一层包装，我们都知道一个Android的项目需要使用Gradle来构建，但是不同版本的项目需要不同版本的Gradle，而Wrapper简化了Gradle的部署，手动去部署的话就比较麻烦了，这里说得项目的版本指的是开发此项目所使用的Android Studio Gradle插件的版本，也就是我们通常所说的编译器的版本，而Android Studio Gradle插件和Gradle的版本对应关系如下：

所以，我们在导入别人的项目之前，要先根据自己的编译器版本去修改Gradle的版本，如果版本不对应会出现以下错误：

我的编译器版本为2.3.3，它所对应的Gradle版本最低为3.3，而当前我的项目的Gradle版本为2.14.1，那么显而易见项目就会构建失败，解决它很简单，只需要修改gradle-wrapper.properties文件中的distributionUrl字段即可，将2.14.1改为3.3，如图：

最后再重新build，这样Wrapper就会检查Gradle有没有被下载关联，如果没有就会从配置的地址(Gradle的官方地址)进行下载并运行构建。

生成Wrapper

我们创建一个新的项目，Gradle会自动为我们生成Wrapper所需的目录文件，其实在Gradle中内置了一个Wrapper task，如果我们要手动去生成Wrapper，只需要在项目的根目录下输入gradle wrapper即可，

生成的文件如下：

Wrapper 配置

我们在终端执行gradle wrapper生成相关文件时，可以为其指定一些参数，来控制Wrapper的生成，比如依赖的版本等，如下：

参数名	说明
--gradle-version	用于指定使用的Gradle版本
--gradle-distribution-url	用于指定下载Gradle发行版的url地址

使用方法为gradle wrapper --gradle-version 3.3，这样我们所配置的Wrapper就会使用3.3版本的Gradle，它会影响gradle-wrapper.properties中的distributionUrl的值，该值的规则是http\://services.gradle.org/distributions/gradle-${gradleVersion}-bin.zip
如果我们在执行gradle wrapper的时候不添加任何参数，那么就会使用你当前Gradle的版本作为生成的Wrapper的gradle version。例如，你当前安装的Gradle是3.3版本的，那么生成的Wrapper也是3.3版本的。

gradle-wrapper.properties

该文件是wrapper的配置文件，我们上面执行任务的配置都会被写进此文件中。该文件的配置字段如下：

字段名	说明
distributionBase	下载的Gradle压缩包解压后存储的主目录
distributionPath	相对于distributionBase的解压后的Gradle压缩包的路径
zipStoreBase	同distributionBase，只不过是存放zip压缩包的
zipStorePath	同distributionPath，只不过是存放zip压缩包的
distributionUrl	Gradle发行版压缩包的下载地址

而distributionUrl就是我们gradle wrapper所依赖的Gradle版本。一般生成的都是这样的https://services.gradle.org/distributions/gradle-3.3-bin.zip，通常都会把bin改成all，这样在开发过程中，就可以看到Gradle的源代码了。

自定义Wrapper Task

gradle-wrapper.properties是由Wrapper Task生成的，那么我们当然也可以自己来配置该Wrapper Task来达到我们配置gradle-wrapper.properties的目的，在build.gradle构建文件中录入如下脚本：

//构建wrapper
task wrapper(type: Wrapper){
   gradleVersion = '3.3'
}

然后我们执行gradle wrapper的时候，就会默认生成3.3版本的wrapper了，而不用使用--gradle-version 3.3进行了指定了。同样的你也可以配置其它参数，例如：

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