Gradle学习之创建Task的方法

请通过下面方式下载本系列文章的Github演示样例代码：

git clone https://github.com/davenkin/gradle-learning.git

 

 

Gradle的Project从本质上说仅仅是含有多个Task的容器，一个Task与Ant的Target相似。表示一个逻辑上的运行单元。我们能够通过非常多种方式定义Task，全部的Task都存放在Project的TaskContainer中。

 

（1）调用Project的task()方法创建Task

在使用Gradle时，创建Task最常见的方式便是：

 

task hello1 << {   

  println 'hello1'

}

 

这里的“<<”表示追加的意思，即向hello中增加运行过程。我们还能够使用doLast来达到相同的效果：

 

task hello2 {   

  doLast {      

     println 'hello2'

  }

}

 

 

另外，假设须要向Task的最前面增加运行过程，我们能够使用doFirst：

 

task hello3 {   

  doLast {      

     println 'hello3'

  }

}

 

在上面的3个样例中，Gradle的DSL向我们展示了一种很自然的风格来创建Task。而其实这些都仅仅是一种内部DSL。也即必须符合groovy的语法要求。

上面的taskkeyword实际上是一个方法调用。该方法属于Project。Project中存在多个重载的task()方法。和Ruby等动态语言一样。在调用groovy方法时。我们不用将參数放在括号中面。

以上我们自己定义的3个Task都位于TaskContainer中。Project中的tasks属性即表示该TaskContainer。

为此，我们能够新建一个Task来显示这些信息：

 

task showTasks {   

  println tasks.class   

  println tasks.size()

}

 

将以上4个Task放在同一个build.gradle中，再运行gradle showTasks。命令行输出例如以下：

 

...class org.gradle.api.internal.tasks.DefaultTaskContainer_Decorated4...

 

上面的DefaultTaskContainer_Decorated表示tasks类型，而4表示该TaskContainer中包括有4个自己定义的Task——包括showTasks本身。

 

 

（2）通过TaskContainer的create()方法创建Task





在上文中我们讲到。通过task()方法创建的Task都被存放在了TaskContainer中，而Project又维护了一个TaskContainer类型的属性tasks。那么我们全然能够直接向TaskContainer里面加入Task。查查TaskContainer的API文档能够发现。TaskContainer向我们提供了大量重载的create()方法用于加入Task。

 

tasks.create(name: 'hello4') << {   

   println 'hello4'

}

 

（3）声明Task之间的依赖关系

Task之间是能够存在依赖关系，比方TaskA依赖TaskB。那么在运行TaskA时，Gradle会先运行TaskB。再运行TaskA。我们能够在定义一个Task的同一时候声明它的依赖关系：

 

task hello5(dependsOn:hello4) << {    

  println 'hello5'

}

 

当然，我们也能够在定义Task之后再声明依赖：

 

task hello6 << {   

  println 'hello6'

}

hello6.dependsOn hello5

 





（4）配置Task

一个Task除了运行操作之外。还能够包括多个Property，当中有Gradle为每个Task默认定义的Property。比方description，logger等。

另外。每个特定的Task类型还能够含有特定的Property，比方Copy的from和to等。

当然。我们还能够动态地向Task中增加额外的Property。在运行一个Task之前。我们通常都须要先设定Property的值，Gradle提供了多种方法设置Task的Property值。





首先，我们能够在定义Task的时候对Property进行配置：

 

task hello7 << {   

  description = "this is hello7"    

  println description

}

 

我们还能够通过闭包的方式来配置一个已有的Task：

 

task hello7 << {   

  description = "this is hello7"    

  println description

}

 

须要注意的是，对hello8的description设置发生在创建该Task之后，在运行“gradle hello8”时，命令行依旧能够打印出正确的“this is hello8”。这是由于Gradle在运行Task时分为两个阶段，首先是配置阶段。然后才是实际运行阶段。所以在运行hello8之前，Gradle会扫描整个build.gradle文档。将hello8的description设置为“this is hello8”，然后运行hello8，此时hello8的description已经包括了设置后的值。

我们还能够通过调用Task的configure()方法完毕Property的设置：

 

task hello9 << {   

  println description

}

hello9.configure {   

  description = "this is hello9"

}

 

实际上，通过闭包的方式配置Task在内部也是通过调用Task的configure()方法完毕的，对此我们将在兴许的文章中具体地讲到。