Gradle的学习总结
chg668
8年前
<p>前言：</p> <p>之前写了一篇关于Gradle渠道定制，虽然说按照官方API可以实现我们的相关的定制化需求，但是对于里面的一些Gradle一些知识并没有特别了解，比如为什么Gradle可以帮我们完成我们定制化的需求，我们在Gradle中Android{ }括号内为什么可以填写buildTypes、productFlavor等等，这些都是让我感到很困惑的地方，经过前一段时间对Gradle的学习，在此做个学习总结，同时也希望能帮助到大家。</p> <p>目录</p> <p>1.什么是Gradle</p> <p>2.Grovvy初探</p> <p>（1）基本数据类型和容器</p> <p>（2）基本语法</p> <p>（3）闭包</p> <p>（4）Grovvy的建构者模式（Grovvy实现建构的方式）</p> <p>3.Gradle建构</p> <p>（1）Gradle工作流程</p> <p>（2）Gradle三种重要的对象</p> <p>（3）Gradle Task</p> <p>（4）三个例子</p> <h2>什么是Gradle？</h2> <p>一个建构工具，同时它也是一个编程框架。</p> <p>什么是建构？</p> <p>简单来说就是输入信息，执行命令，得到产物。在项目中建构就是告诉我们的项目，哪些是源码，哪些是资源，编译文件，如何打包......完成这一系列工作，得到最后的产物。Gradle是一个新型的建构的工具，它所使用Grovvy比传统的XML更具优势，可以实现if{某条件成立，编译某文件}/else{编译其他文件}这样有不同条件的任务。Gradle另外一个特点就是它是一种DSL，即Domain Specific Language，领域相关语言。什么是DSL，说白了它是某个行业中的行话。所以我们需要明白的一点是，我们编写脚本是离不开API文档的。</p> <p>构建工具和编程框架</p> <p>对我们是用来说，熟悉API，通过API写建构脚本，那么就是一个工具，比如说我们的使用Android gradle plugin对我们来说就是工具。</p> <p>我们项目中比如使用了微信的AndResGuard（资源混淆压缩），是使用gradle编写的插件，对于他们来说Gradle就是编程框架。</p> <p>在这里，对我们项目需求来看，我们只需将其作为工具看待，了解API，完成我们的项目构建即可。但是只知其燃不知其所以燃显然不是我们程序员的风格，了解一些必要的原理，可以帮助我们更好地理解Gradle。</p> <p>Gradle 是使用Grovvy语言来进行构建的，理解gradle就有必要了解Grovvy语言。</p> <h2>Grovvy初探</h2> <p>API文档： <a href="/misc/goto?guid=4959729858233154262" rel="nofollow,noindex">http://docs.groovy-lang.org/latest/html/groovy-jdk/</a></p> <p>Grovvy语言是一种JVM的动态语言。Groovy语言内部会将其编译成Java class然后启动虚拟机来执行。作为动态语言，Grovvy世界中的所有事物都是对象。</p> <h3>1.基本数据类型和容器</h3> <p>跟java基本数据类型相同</p> <p>Grovvy中容器（三种）</p> <p>List：链表，其底层对应Java中的List接口，一般用ArrayList作为真正的实现类。</p> <p>Map：键-值表，其底层对应Java中的LinkedHashMap。</p> <p>Range：范围，它其实是List的一种拓展</p> <h3>2.基本语法</h3> <p>定义变量</p> <pre> <code class="language-groovy">def variable1 = 1 // 定义一个变量，可不用指定类型，结尾换行不用分号 def int x = 1 //变量定义时，也可以直接指定类型 def aList = [5,'string',true] // 定义数组 def aMap = ['key1':'value1','key2':true] // 定义Map def aRange = 1..5 //Range类型的变量 由begin值+两个点+end值表示 左边这个aRange包含1,2,3,4,5这5个值 println aRange.from //1 println aRange.to //5</code></pre> <p>方法定义</p> <pre> <code class="language-groovy">def nonReturnTypeFunc(){ last_line //最后一行代码的执行结果就是本函数的返回值 } String testFunction(arg1,arg2){ //无需指定参数类型 ... }</code></pre> <p>注意：根据Groovy的原则，如果一个类中有名为xxyyzz这样的属性（其实就是成员变量），Groovy会自动为它添加getXxyyzz和setXxyyzz两个函数，用于获取和设置xxyyzz属性值。</p> <p>例如：上面例子aRange.from 和aRange.to</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/a1744178d297986b365dcdc6e6eec165.png"></p> <p>其实Range类中存在这个两个参数</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/15bb1ddac2816944c9c9ef38f92cd86f.png"></p> <p>但是有没有发现，这两个变量是private的，而aRang.to和aRange.from其实是执行了getTo和getFrom的方法！</p> <h3>3.闭包</h3> <p>闭包，是一种 <strong>数据类型</strong> ，它代表了一段可执行的代码。从C/C++语言的角度看，闭包和函数指针很像</p> <p>闭包的定义：</p> <pre> <code class="language-groovy">def aClosure = { //闭包是一段代码，所以需要用花括号括起来.. String param1, int param2 -> //箭头很关键。箭头前面是参数定义，箭头后面是代码 println "this is code" //这是代码，最后一句是返回值， //也可以使用return，和Groovy中普通函数一样 }</code></pre> <p>使用：</p> <p>aClosure.call("this is string",100) 或者</p> <p>aClosure("this is string", 100)</p> <p>更多时候，闭包将以一个方法的参数使用。</p> <p>类似我们的回调。</p> <p>回调回调！！</p> <p><img src="https://simg.open-open.com/show/92c9376369cb14542b7b98c7f7e76c28.png"></p> <p>闭包作为参数</p> <p>当这个方法有个闭包的参数作为最后一个参数时有个特点： <strong>省略圆括号</strong></p> <p>比如定义一个数组：</p> <pre> <code class="language-groovy">def aList = [1,2,3,4,5]</code></pre> <p>一般我们可能这样去执行each方法：</p> <pre> <code class="language-groovy">aList.each({ item->println(item) })</code></pre> <p>更多的是使用省略圆括号的方式：</p> <pre> <code class="language-groovy">aList.each{ //这行这个数组的each函数，这个each函数传入一个闭包 item->println item //item是闭包的参数 }</code></pre> <p>关于上面的这个例子，这里需要理解两个点：</p> <p>1.each(Closure closure)这个方法需要传入一个为闭包数据类型的参数</p> <p>2.这个closure参数它也会接受一个参数，这个参数是调用者调用这个each方法的时候传入的，上面的item就是这个closure接收的参数，然后把item打印出来</p> <p>问题：这个传入闭包的item参数是哪里来的呢？</p> <p>我们先查看API文档，查看方法名</p> <p><img src="https://simg.open-open.com/show/14f4a42eb9c7b4b7d79f1d5fa0c77409.png"></p> <p>each方法</p> <p>方法解释，遍历这个List，把 <strong>每一个元素</strong> 传递给这个闭包！</p> <p>所以上面的方法是遍历的了这个aList，打印了每一个元素。</p> <p>所以Closure的使用依赖于你对API的熟悉程度，但是还有一个约定俗成方式去判断传入闭包的参数，就是看方法名，一般我们可以通过方法名去判断传入闭包的参数，例如上面的each就是把每一个元素传递闭包。</p> <h3>4.Grovvy的建构者模式（Grovvy实现建构的方式）</h3> <p>这里主要介绍为什么在闭包里面的填写的参数可以设置成自己定义的参数，有兴趣可以去查看一下上面的链接，这里节选了建构者这一章节。</p> <p>Groovy 是构建 DSL 的一种选择平台。使用闭包可以非常轻松地创建自定义控制结构，创建构建者也非常方便，我们很常可以看到这样的定义：</p> <pre> <code class="language-groovy">email { from 'dsl-guru@mycompany.com' to 'john.doe@waitaminute.com' subject 'The pope has resigned!' body { p 'Really, the pope has resigned!' } }</code></pre> <p>使用构建者策略可实现，利用一个参数为闭包的名为 email 的方法，它会将随后的调用委托给一个对象，该对象实现了 from、to、subject 及 body 各方法。body 方法使用闭包做参数，使用的是构建者策略。</p> <p>实现这样的构建者往往要通过下面的方式：</p> <pre> <code class="language-groovy">def email(Closure cl) { def email = new EmailSpec() def code = cl.rehydrate(email, this, this) code.resolveStrategy = Closure.DELEGATE_ONLY code() }</code></pre> <p>EmailSpec 类实现了 from、to 等方法，通过调用 rehydrate，创建了一个闭包副本，用于为该副本设置 delegate、owner 及 thisObject 等值。设置 owner 和 thisObject 并不十分重要，因为将使用 DELEGATE_ONLY 策略，解决方法调用只针对的是闭包委托。</p> <pre> <code class="language-groovy">class EmailSpec { void from(String from) { println "From: $from"} void to(String... to) { println "To: $to"} void subject(String subject) { println "Subject: $subject"} void body(Closure body) { def bodySpec = new BodySpec() def code = body.rehydrate(bodySpec, this, this) code.resolveStrategy = Closure.DELEGATE_ONLY code() } }</code></pre> <p>The EmailSpec 类自身的 body 方法将接受一个复制并执行的闭包，这就是 Groovy 构建者模式的原理。</p> <p>代码中的一个问题在于，email 方法的用户并不知道他能在闭包内调用的方法。唯一的了解途径大概就是方法文档。</p> <p>还有一个方式是，编译时解释委托策略@DelegatesTo。</p> <pre> <code class="language-groovy">def email(@DelegatesTo(EmailSpec) Closure cl) { def email = new EmailSpec() def code = cl.rehydrate(email, this, this) code.resolveStrategy = Closure.DELEGATE_ONLY code() }</code></pre> <p>大致的作用就是通过这个@DelegatesTo 让编译器知道这和Closure代理给谁，可以更智能显示填写哪些参数，方便编程，在这里就不扩展了。</p> <p>通过上面我们了解了，Grovvy的基本语法和闭包的基本使用，了解Grovvy建构的基本概念是通过代理来完成，那么在Gradle是怎么使用Grovvy来完成我们的构建呢？</p> <h2>Gradle建构</h2> <p>Gradle是一个框架，它定义一套自己的游戏规则，必须要遵守它设计的规则。</p> <p>Gradle中，每一个待编译的工程都叫一个Project。每一个Project在构建的时候都包含一系列的Task。比如一个Android APK的编译可能包含：Java源码编译Task、资源编译Task、JNI编译Task、lint检查Task、打包生成APK的Task、签名Task等。一个具体的编译过程是由一个一个的Task来定义和执行的。</p> <p>我们首先通过项目工程目录，来理解Gradle设计的规则</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/1ffe80ae43f4afe70957981927bd52cf.png"></p> <p>settings.gradle表示导入的哪些项目，具体来说就是gradle需要编译哪些项目。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/1d30c1958f122be45811d3afea8bc0d8.png"></p> <p>如图，导入了app这个工程。</p> <p>在主目录MyApplication工程目录下有个build.gradle</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/43a61c39e81f081469b6e806e6e592e9.png"></p> <p>我们看到最上面的注释，这个文件是level最高级的配置文件，这里配置Android gradle plugin版本，这里我的是2.2.0的版本，allprojects配置所有Project的需要的配置。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/f74d774a852b4ce646cb35de37a24433.png"></p> <p>为了解决Gradle版本不断升级，不同时期的项目编译不同版本的Gradle，Google推出了gradle wrapper，这个就放置在gradle文件夹中。</p> <p>注意：这里dependencies配置的是Android-gradle-plugin版本而不是Gradle的版本。</p> <p>扩展: 导入开源项目的正确姿势</p> <p>在我们导入GitHub项目的时候经常会遇到一直在下载Gradle，打不开项目的问题。原因就是要导入的项目Android-gradle-plugin和Gradle版本本地不存在，所以导入项目是会先去下载，但是下载又因为墙的原因就会导致在载入界面卡主。导入项目正确的姿势是：</p> <p>1.打开本地可以编译的项目，</p> <p>2.将这个项目中的依赖的Android-gradle-plugin版本和gradle目录拷贝替换到需要导入的项目中就可以打开这个项目了。</p> <p>继续查看项目目录</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/d8213b2967e10986a7f89a8bec795ef1.png"></p> <p>在app目录中也存在一个build.gradle文件，内容后面再讲解。其实每一个setting.gradle 中include进来的Project都需要配置build.gradle文件。</p> <p>之前我们提到导入的每一个项目都是一个Project，每个Project又包含了许多Task。查看Task，可以在终端执行gradlew tasks，或者通过studio提供可视化工具操作。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/40a62cd4a62198a96434d8dd7f517b48.png"></p> <p>之前说到的这些Task包含Java源码编译Task、资源编译Task、JNI编译Task、lint检查Task、打包生成APK的Task、签名Task等等。</p> <p>了解了Gradle的每个Project包含了Task，那么编译的过程是怎么把Task联系起来呢？</p> <h3>1.Gradle工作流程</h3> <p style="text-align:center"><img src="https://simg.open-open.com/show/cf622551d2f57a9299470aa9276764b9.png"></p> <p>1.（Initiliazation phase）首先是初始化阶段。就是执行settings.gradle Initiliazation phase的下一个阶段是Configration阶段。</p> <p>2.（Configration phase）Configration阶段的目标是解析每个project中的build.gradle。比如上面例子中，解析每个子目录中的build.gradle。在这两个阶段之间，我们可以加一些定制化的Hook（钩子）。这当然是通过API来添加的。</p> <p>3.（Execution phase）Configuration阶段完了后，整个build的project以及内部的Task关系就确定了。前面说过，一个Project包含很多Task，每个Task之间有依赖关系。Configuration会建立一个 <strong>有向图来描述Task之间的依赖关系</strong> 。所以，我们可以添加一个HOOK，即当Task关系图建立好后，执行一些操作。</p> <p>关于Gradle的工作流程，我们需要记住：</p> <p>Gradle有一个初始化流程，这个时候settings.gradle会执行。</p> <p>在配置阶段，每个Project都会被解析，其内部的任务也会被添加到一个有向图里，用于解决执行过程中的依赖关系。</p> <p>然后才是执行阶段。你在gradlew xxx中指定什么任务，gradle就会将这个xxx任务链上的所有任务全部按依赖顺序执行一遍！</p> <h3>2.Gradle三种重要的对象</h3> <p>Gradle对象：当我们执行gradlew xxx或者什么的时候，gradle会从默认的配置脚本中构造出一个Gradle对象。在整个执行过程中，只有这么一个对象。Gradle对象的数据类型就是Gradle。我们一般很少去定制这个默认的配置脚本。</p> <p>Project对象：每一个build.gradle会转换成一个Project对象。加载插件，设置不同的配置，比如Application plugin插件和Library plugin插件gradle配置是不太一样的。</p> <p>Settings对象：显然，每一个settings.gradle都会转换成一个Settings对象。</p> <p>Project对象：</p> <p>文档： <a href="/misc/goto?guid=4959729858494098998" rel="nofollow,noindex">https://docs.gradle.org/current/dsl/org.gradle.api.Project.html</a></p> <p>我们知道每一个项目在build.gradle脚本解析成一个Project对象，在build.gradle我们可以查看这个Project的变量，Project包含了许多Task，tasks就是任务的集合</p> <p><img src="https://simg.open-open.com/show/e6b4e8154027089b8b4bca66b2eb56c1.png"></p> <h3>3.Gradle Task</h3> <p>Gradle Task是Gradle非常重要的概念，Task是Gradle中的一种数据类型。它代表了一些要执行或者要干的工作。不同的插件可以添加不同的Task。每一个Task都需要和一个Project关联。</p> <p>（Task的API文档位于 <a href="/misc/goto?guid=4959729858570717127" rel="nofollow,noindex">https://docs.gradle.org/current/dsl/org.gradle.api.Task.html）</a></p> <p>Task 定义（这个是在Project中定义的，Project文档！）</p> <pre> <code class="language-groovy">task helloworld { //调用的是Project中的方法task(name, configureClosure) println('hello world!') doFirst{ println('do first') } do Last{ println('do last') } }</code></pre> <p>上面代码的意思就是定义了一个Task，Task的名字为helloworld</p> <p>doFirst和doLast都给这个Task添加了Action。</p> <p>注意：上面println('hello world')会在配置阶段就会执行，doFirst和doLast不会执行，通过执行gradlew helloworld才会顺序执行doFirst和doLast。</p> <p><<符号代表 do last</p> <pre> <code class="language-groovy">task helloworld << { println('do last') }</code></pre> <p>Task 依赖</p> <pre> <code class="language-groovy">testTask0.dependsOn testTask1 //执行testTask0将会先执行testTask1</code></pre> <h3>4.三个例子：</h3> <p style="text-align:center"><img src="https://simg.open-open.com/show/5251636fe574a128ba8af6c58950d2e0.png"></p> <p style="text-align:center"><img src="https://simg.open-open.com/show/73d7752553757e9192cbd18da065eeaa.png"></p> <p style="text-align:center"><img src="https://simg.open-open.com/show/32ac22a5feb83aea38b6a3d61e5e107e.png"></p> <p>这三个都是直接是写在app工程下gradle中，project.afterEvalute意思是创建了任务有向图之后。写一下上面的代码，编译并运行gradlew assmbleDebug，查看输出。深入理解上面例子的执行过程。</p> <p>解析</p> <p>第一个，编译报错。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/f2404f648478352289abb8929d7b7adf.png"></p> <p>上面说这个任务在app这个project中找不到，我们之前说过gradle是有生命周期的，我们在配置阶段完成之后才会添加project中形成有向图，这段代码是在配置之前就执行了，有向图没有形成，自然找不到这个任务，从而报错。</p> <p>第二个，编译时输出。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/f64011a8efec3b7df8d7b9d9edde85d9.png"></p> <p>我们看到在编译过程就输出了这个代码，而且确实是在配置（Configuration）生命周期之后，因为我们并没有给这个任务添加Action，所以println会在getByName方法中一并输出。</p> <p>第三个，编译不输出，执行gradlew assmbleDebug输出</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/80a09e3405bf33edd036b9b04699e4fb.png"></p> <p>这是因为我们在这个Task添加doLast的Action，说明println的动作会在这个Task的最后执行，也就是我们执行这个assembleDebug任务的时候最后执行。</p> <p> </p> <p> </p> <p> </p> <p>来自：http://www.jianshu.com/p/5671ecfdf115</p> <p> </p>