[2/3]gradle脚本运行环境分析（gradle的语义模型）

Love The Way You Lie 2022-04-12 12:46 100阅读 0赞

转自：http://www.cnblogs.com/chenjie0949/p/4757702.html  
  
引言：通过上一篇的论述，我们知道gradle脚本是如假包换的groovy代码，但是这个groovy代码是运行在他的上下文环境里面的，学名叫语义模型。这一篇我们就来看看他的语义模型到底是什么，如何使用。  
  
\[size=large\]\[b\]gradle下载安装\[/b\]\[/size\]  
gradle的下载安装并没有什么出乎意料的东西，进入他的官网（http://gradle.org/），下载gradle压缩包，解压，配置bin路径到Path即可。  
  
我安装在c盘下，进入目录C:\\gradle-2.4\\docs\\userguide，打开userguide.pdf文件，这个就是gradle的向导帮助文档。  
  
  
  
\[size=large\]\[b\]gradle 语义模型\[/b\]\[/size\]  
gradle使用project和task来实现构建的操作，project对应工程，task对应具体的任务，例如编译，压缩，生成帮助文档。我们从userguide.pdf的chap 6中截取一个hello world的Demo来说明，以便有个初步的印象。  
  
创建一个空文件夹Demo，进入，再创建一个build.gradle文件，并写入如下的代码：  
task hello \{  
println "hello world"  
\}  
  
在命令行中输入 gradle -q hello (-q 参数用于删除冗余的输出)，会得到hello world的输出。这一段脚本通过调用project类的task方法，添加了一个新的task在project的task map中，其主键是“hello”，后面跟着一个闭包，里面的代码用于配置这个task的一些属性，相当于初始化这个task，这在下面action的例子中表现最明显。需要注意的是这里的task是关键字，并不是调用某一个方法，在解析的过程中，gradle还需要根据这个关键字进行转化才能生成标准的groovy代码。  
  
在gradle中，project和build.gradle文件是一一对应的，通过这个文件可以配置project的各种属性。project的初始化流程如下：  
  
（1）首先创建一个Settings的实例。(对应 org.gradle.api.initialization 下的 Interface Settings )  
  
（2）如果当前目录有settings.gradle,那么用这个文件来配置Settings实例。  
  
（3）用Settings实例来创建Project的层次关系。  
  
（4）最后，如果项目中存在build.gradle就通过它来执行每个Project。项目中，项目分别依次横向执行，以此子项目一定在父项目之后执行。这个规则可以通过调用evaluationdependsonchildren()或加入一个明确的依赖usingevaluationdependson（String）。  
  
从初始化流程来看，项目之间的层次和依赖关系是通过settings.gradle来配置的，而project的具体任务执行是通过build.gradle来配置的。在build.gradle中可以添加系统提供的task和自定义的task，例如上例就是自定义的task。Project还可以通过添加插件来添加能支持的task。task是由action组成，action可以理解成真正的执行功能的代码块，可以调用doFirst，doLast,leftShift和<<添加action。我们举一个既有配置代码，又有action的例子，看下面的代码：  
  
\[b\]action的例子\[/b\]

task hello {
       
        println "hello world"//初始化
    }<<{
       
        println "hello world action"
    }
    
    task hello1 {
       
        println "hello world1"//初始化
    }<<{
       
        println "hello world1 action"
    }

我们用上一个例子中运行task的方法调用hello1，即输入：gradle hello1,输出为：  
\# gradle hello1  
hello world  
hello world1  
:hello1  
hello world1 action  
  
BUILD SUCCESSFUL  
  
Total time: 2.086 secs  
  
可以看出初始化的代码是一定执行的，而Task hello的Action代码，要用gradle指定task才能执行。  
  
从上面的两个例子，我们有了一个最初的印象，gradle构建从上到下的机构顺序应该是project---》task---》action。  
  
　　每一个Project都通过一个TaskContainer来添加和管理他的task，这是一个task的容器，可以通过调用project的getTasks()方法来获得，不过一般来说大家都通过task关键字来生成task，范例如下：

task myTask1
    
    task myTask2 {
       
        println "myTask2"
    }
    
    task myType3 << {
       
        println "myTask2 -- action"
    }
    task myTask4("dependsOn": myType3)
    
    task myTask5("dependsOn": myType3) {
       
        println "myTask5 -- action" 
    }

当然可以直接用project里面的task()方法,使代码更加groovy一点：

task nTask1
    
    task nTask2,{
       
        println "nTask1"
    }
    
    task nTask3,{
       
        println "nTask3"
    }<<{
       
        println "nTask3 -- action"
    }
    
    task nTask4,{
       
        dependsOn(nTask3)
    }

一旦task被创建，就可以用它的名字来引用它。

task nTask3,{
       
        println "nTask3"
    }<<{
       
        println "nTask3 -- action"
    }
    
    task nTask4,{
       
        dependsOn(nTask3)
    }
    
    nTask4 << {
       
        println "nTask4 -- action"
    }

执行结果：  
nTask3 -- action  
nTask3  
:nTask3 UP-TO-DATE  
:nTask4  
nTask4 -- action  
  
BUILD SUCCESSFUL  
  
Total time: 2.927 secs  
  
上面说Task中具体的执行步骤是通过Action来完成的，Action的结构十分简单，只有一个方法  
  
void execute(T t)  
  
Action在Task中排列成一个队列，依次执行。增加Action有4个方法，上面已经提过，看下面的例子：

task nTask4 {
       
        println "this is config"//配置这个task
    }
    nTask4 << {
       
        println "nTask4 -- add action by <<" //通过 <<来增加action
    }
    nTask4.leftShift {
       
        println "nTask4 -- add action by leftShift "//通过leftShift方法来增加action，等同 <<
    }
    nTask4.doFirst {
       
        println "nTask4 -- doFirst" //在action队列的最前面插入一个Action
    }
    
    nTask4.doLast {
       
        println "nTask4 -- doLast" //在action队列的最最后插入一个Action
    }

输出结果为：  
\# gradle nTask4  
this is config  
:nTask4  
nTask4 -- doFirst  
nTask4 -- add action by <<  
nTask4 -- add action by leftShift  
nTask4 -- doLast  
  
BUILD SUCCESSFUL  
  
Total time: 2.935 secs  
  
  
结果一目了然，doFirst最先执行，<<和leftShift的调用时序决定先后顺序，而doLast在最后。能这样做的数据结构，当然是队列，事实也确实如此，在Task接口中，用的是List，而在抽象类AbstractTask中用ArrayList实现的。  
  
Project和Task的属性设置和依赖关系可以参考这篇博客：http://www.blogjava.net/wldandan/archive/2012/07/05/382246.html。  
  
增加一个例子作说明

//project 自带属性
    println Project.DEFAULT_BUILD_DIR_NAME
    println DEFAULT_BUILD_DIR_NAME
    
    //本地属性
    String msg = "hello world"
    
    //extension 属性
    ext{//用 ext 关键字
        projectProperties = "ext projectProperties-value"
    }
    //直接调用方法
    project.getExtensions().create("mMsg", Msg)
    
    task hello (){
       
        println msg //初始化
    }<<{
       
        println "ext properties :"+projectProperties
        projectProperties = "chang the extension propertise"
        println "ext properties :"+projectProperties
    //  println project.property(projectProperties)  //无法执行
        println project.property("projectProperties")
        println mMsg.des
    }
    
    class Msg {
       
        String des = "this is a msg"
        int id = 10
    }

输出结果为：  
\# gradle hello  
build  
build  
hello world  
:hello  
ext properties :ext projectProperties-value  
ext properties :chang the extension propertise  
chang the extension propertise  
this is a msg  
  
BUILD SUCCESSFUL  
  
Total time: 3.028 secs  
  
通过上面的例子说明了动态增加属性的方式。由此可以见，一个Project增加属性和Task都是可行的。当某一类Task需要集体带入的话（比如整个android的编译过程），一个个通过task方法加入就过于麻烦了，解决方案也很简单，我把Project的实例给这一类Tasks的管理类（比如XXManager，在gradle中叫XXPlugin，或者直接叫 java，android），由这个管理类自己添加需要的task，举个例子：

apply plugin: DateAndTimePlugin
    
    dateAndTime {
       
       timeFormat = 'HH:mm:ss.SSS'
       dateFormat = 'MM/dd/yyyy'
    }
    
    class DateAndTimePlugin implements Plugin<Project> {
       
       void apply(Project project) {
       
           project.extensions.create("dateAndTime", DateAndTimePluginExtension)
           project.task('showTime') << {
       
               println "Current time is " + new Date().format(project.dateAndTime.timeFormat)
           }
           project.tasks.create('showDate') << {
       
               println "Current date is " + new Date().format(project.dateAndTime.dateFormat)
           }
       }
    }
    
    class DateAndTimePluginExtension {
       
       String timeFormat = "MM/dd/yyyyHH:mm:ss.SSS"
       String dateFormat = "yyyy-MM-dd"
    }

Task已经加入，我们直接使用就可以了，输出结果为：  
\# gradle showTime showDate  
:showTime  
Current time is 15:52:15.841  
:showDate  
Current date is 09/01/2015  
  
BUILD SUCCESSFUL  
  
Total time: 2.132 secs  
  
参考：  
  
负责task转换的类：org.gradle.groovy.scripts.internal.TaskDefinitionScriptTransformer.java  
  
http://www.gradle.org/docs/current/javadoc/org/gradle/api/Project.html  
  
http://www.gradle.org/docs/current/javadoc/org/gradle/api/Task.html