使用Gradle自定义任务task

本文转自这里，感谢原作者的知识贡献。

任务是 Gradle 构建中的两个基本概念之一，而任务的定义和使用有多种形式，以下就给大家介绍几个task 的定义和使用。

1 定义任务基本语法

// 使用task 后带任务名称 加上执行闭包{}
task t1 {
  println 't1'
}
// 任务名称后加上圆括号
task t2() {
  println 't2'
}
// IDEA 刷新 Task 点击 build 或 左下 Terminal 输入 gradle build 即可看到结果
t1
t2

以上是任务的基本定义，结果得知会在配置 project 阶段时被执行。除了任务依赖，任何涉及到需要配置 project 对象的操作都会被执行。如果需要在任务调用时才执行动作代码需要定义在 doFirst 或者 doLast 方法中。

2 任务的常见定义方式

task t1{
    // 任务调用前执行动作
   doFirst{
       println 't1'
   }
}
// 任务调用后执行动作
task t2(){
    doLast{
       println 't2'
    }
}
// << 是 doLast 的简写，任务调用后执行动作
task t3 << {
    println 't3'
}
// 可给任务名带 ' '

测试：gradle t1 t2 t3

> Task :t1
t1

> Task :t2
t2

> Task :t3
t3

以上为任务的最常见的定义方式，配置project 时不会调用 doFirst 和 doLast 中的方法。只有在直接调用任务或被其他任务依赖时才会被执行。那这里说的依赖到底怎么依赖呢？ 以下就来看下任务的依赖配置。
任务的依赖配置 dependsOn
任务的依赖需要使用一个关键字 dependsOn 来做依赖配置，配置有多种形式，以下就来给大家演示下常见的用法

task t1 {
    doFirst {
        println 't1'
    }
}
// 定义任务时指明依赖
task t2(dependsOn : t1) {
    doLast {
        println 't2'
    }
}
task t3 << {
    println 't3'
}

task t4 {
    dependsOn t3          // 任务内写依赖
    doLast{
        println 't4'
    }
}
// 外部添加依赖 t1 依赖 t3
t1.dependsOn t4

// 外部增加任务动作达到依赖
t3.doFirst{
    println '给 t3 增加增加动作1'
}
t3 << {
    println '给 t3 增加增加动作2'
}

执行任务 t2 gradle t2 ,结果如下：

Task :t3
给 t3 增加增加动作1
t3
给 t3 增加增加动作2
Task :t4
t4
Task :t1
t1
Task :t2
t2

以上就是 task 常见的几种依赖的书写方式，那 task 还有没有什么高级点的语法特性呢？
其实有的，借助 Groovy 的强大不仅可以定义简单任务还能做更多的事。例如，可以动态定义任务。
动态任务

4.times {
    val ->
    task "tk${val}" << {
        println "The task is task${val}"
    }
}

以上就动态定义了4个任务tk0,tk1,tk2,tk3,那除了动态任务还有哪些高级牛逼的操作呢？其实还可以给任务自定义属性。

3 给任务自定义属性

这里使用 ext 来给任务添加额外属性，用 ext.属性名 = 值 来自定义。

// 给任务添加属性
task tk5{
    ext.myProperty = "The property value"
}
// 获取自定义属性
task printTaskProperty << {
    println tk5.myProperty
}
// ============== 结果 ===================
> Task : printTaskProperty
The property value

还有木有？
其实任务这里只是介绍了一些常用的操作而已，想了解更深入的知识点，请期待任务 task 详讲，这里是带大家先入门的。
接下来用一个例子来巩固下任务。

4 例子

需求：自定义任务来自动生成项目目录。

// 定义创建目录的普通方法
def createDir(fileName){
    File f = new File(fileName);
    f.mkdirs()
}

// 定义生成Java 项目目录的任务
task createJavaProjectDir << {
    def dirList = ['src/main/java','src/main/resources','src/test/java','src/test/resources']
    dirList.each {fileName  ->  createDir(fileName)}
}

// 定义生成 Web 项目目录的任务
task createWebProjectDir (dependsOn: createJavaProjectDir) << {
    def fileName = 'src/main/webapp'
    createDir(fileName)
}

其实 Java 组件中已经事先定义好了，咱们只需要直接调用就行了。

task createDirs << {
    sourceSets*.java.srcDirs*.each{
        it.mkdirs()
    }
    sourceSets*.resources.srcDirs*.each{
        it.mkdirs()
    }
}

以上就是Gradle 中任务的介绍和任务的实践。