gradle编译java项目_使用Gradle编译Java工程之自定义Task类型篇

文章目的

本章中我们将会学习到如何自定义任务(Task)的类型，了解Gradle是怎么增强任务的功能的。

需要准备

一个熟悉的IDE开发工具

JDK 7及以上

Gradle 3.2以上

Gradle的两种任务类型

在上一章中(http://www.jianshu.com/p/a41769bf5118)， 我们介绍了任务(Task)的一些高级用法，知道了Gradle对任务的功能增强很多，那么它是具体如何做到的呢？在揭晓答案之前，我们先来看看Gradle都支持哪两种类型的任务吧。

第一种为简单任务类型，就是我们在之前一篇文章中介绍的(http://www.jianshu.com/p/a7b947c86650)， 它的行为是定义在一个动作闭包方法中的， 这种简单类型的任务适合在一个编译脚本中实现一种功能。而第二种为增强的任务类型，它的行为被提前构建在了任务里，只是提供一些配置属性让我们去设置，这种任务可以在不的地方或不同的编译脚本中被重复使用，它正是我们上一章中介绍的任务类型。

这种高级的增强的任务类型是通过定义一个任务类来实现的，在Gradle中我们也可以自定义自己的增强类型类，我们可以使用多种语言来实现，比如java、scala等。不过Gradle本身是使用Groovy语言实现的，所以我在这里选择使用Groovy语言来实现。

实现自定义的任务类型

首先有三种方式来编写我们的任务类

在我们构建项目的build.gradle脚本中直接编写，这种方式的好处是任务类自动被编译加载到我们的classpath中，我们不需要额外做任何的事情，但是它有很明显的局限性，就是除了在包括它的脚本外别的地方无法复用。

在我们构建项目的rootProjectDir/buildSrc/src/main/groovy 目录下编写，Gradle会自动编译到当前项目的classpath中，该项目下所有编译脚本都可以使用，但是除了当前项目之外的都无法复用。

以单独的工程方式编写，这个工程最终编译发布为一个JAR包，它可以在多个项目或不同的团队中共享使用。

然后我们先使用第一种方式编写一个简单的自定义任务类，而该自定义任务类是继承自DefaultTask的，同时为它添加一个行为方法，该方法需要使用TaskAction进行标注，这样Gradle就会在任务执行的时候默认调用它，其build.gradle中代码如下所示：

task hello(type: GreetingTask)

class GreetingTask extends DefaultTask {

@TaskAction

def greet() {

println 'hello from GreetingTask'

}

}

执行命令gradle -q hello结果如下：

> gradle -q hello

hello from GreetingTask

当然我们可以为我们自定义的任务类添加属性，并且在使用的时候设置该属性值，其build.gradle中代码如下：

// 使用默认的属性值

task hello(type: GreetingTask)

// 自定义设置的属性值

task greeting(type: GreetingTask) {

greeting = 'greetings from GreetingTask'

}

class GreetingTask extends DefaultTask {

String greeting = 'hello from GreetingTask'

@TaskAction

def greet() {

println greeting

}

}

执行命令gradle -q hello greeting结果如下：

> gradle -q hello greeting

hello from GreetingTask

greetings from GreetingTask

以单独工程方式实现自定义任务类

我们使用IDEA开发工具创建一个Groovy的工程，然后在它的build.gradle文件中使用Groovy plugin，并且添加相关的依赖，代码如下：

apply plugin: 'groovy'

dependencies {

compile gradleApi()

compile localGroovy()

}

接着创建一个Groovy类，其文件为src/main/groovy/org/gradle/GreetingTask.groovy，相关代码如下：

package org.gradle

import org.gradle.api.DefaultTask

import org.gradle.api.tasks.TaskAction

class GreetingTask extends DefaultTask {

String greeting = 'hello from GreetingTask'

@TaskAction

def greet() {

println greeting

}

}

我们可以使用maven-publish插件先发布到本地，这样我们机器上的其他工程就能在指定目录下找到我们的任务类了，修改build.gradle中代码如下：

apply plugin: 'groovy'

apply plugin: 'maven-publish'

dependencies {

compile gradleApi()

compile localGroovy()

}

publishing{

publications {

mavenJava(MavenPublication) {

from components.java

groupId 'org.gradle'

artifactId 'customPlugin'

version '1.0-SNAPSHOT'

}

}

repositories{

maven {

// change to point to your repo, e.g. http://my.org/repo

url "../repo"

}

}

}

在IDEA工具中直接运行publish任务，就能完成发布工作，并在工程的上一级目录下生成发布包，具体操作和结果如下图所示：

图一 运行publish发布工程

图二 生布后的本地仓库目录

最后在另外一个工程中使用该任务类

使用IDEA开发工具新创建一个Gradle工程，在该工程中将使用我们上面单独定义的任务类，首先我们需要使用buildscript { } 块来使类添加到编译脚本的classpath中，下面build.gradle中的代码展示了如果加载本地仓库的任务类：

buildscript {

repositories {

maven {

url uri('../repo')

}

}

dependencies {

classpath group: 'org.gradle', name: 'customPlugin',

version: '1.0-SNAPSHOT'

}

}

task greeting(type: org.gradle.GreetingTask) {

greeting = 'another project working!'

}

执行命令gradle -q greeting的结果如下：

> gradle -q greeting

another project working!

小结

本章通过实现了一个自定义任务类，让我们了解到了Gradle是如何增强任务功能的，下一节中我将继续介绍如何实现自定义的插件，自定义任务类一般是与自定义插件一起使用的。如果感觉兴趣的同学请关注我，我和朋友的新书《分布式服务架构：原理、设计与实战》也正式登陆京东了，如果有需要的可以直购买，里面有很多平时的工作经验分享。

参加技术分享

《分布式服务架构：原理、设计与实战》

杨彪的简书博客

云时代架构公众号