Android 开发离不开 Gradle 构建工具，有时为了在构建过程中完成一些额外的工作，我们必须额外添加写一些代码片段，比如说生成 doc，对构建物进行改名等。当需要写的代码比较多时每次重写就得不偿失了，此时使用 Gradle 插件就是一个更好的选择。本文接下来就从头编写一个最简单的 Gradle 插件开始说起。
开发步骤
以下实例锁使用的开发环境为 IDEA，开发语言为 Groovy，尽管也可以用 Java 来开发 Gradle 插件，但是开发时配置繁琐且效率低，并不推荐使用。
建立工程
使用 IDEA 建立一个基于 Gradle 构建的工程 sample-plugin，并建立子工程 plugin。
修改 build.gradle 文件
注意修改的是子项目的 build.gradle 文件，而不是根目录的
apply plugin: 'groovy'
buildscript {
repositories {
mavenCentral()
}
}
repositories {
mavenCentral()
mavenLocal()
}
dependencies {
compile gradleApi()
compile localGroovy()
compile 'org.codehaus.groovy:groovy-all:2.3.11'
}
编写 Plugin 代码
在 plugin 工程下新建包含插件代码的 gradle 文件： greeting.gradle
apply plugin: GreetingPlugin
greeting {
message = 'Hi'
greeter = 'Gradle'
}
class GreetingPlugin implements Plugin<Project> {
void apply(Project project) {
// Add the 'greeting' extension object
project.extensions.create("greeting", GreetingPluginExtension)
// Add a task that uses the configuration
project.task('hello') << {
println "${project.greeting.message} from ${project.greeting.greeter}"
}
}
}
class GreetingPluginExtension {
String message
String greeter
}
以上代码创建了一个名为 GreetingPlugin 的插件，该插件包含一个名为 hello 的 task。此 Task 负责输出工程的 greeting 对象下 greeting.message 和 greeting.greeter。
继续修改 build.gradle，导入以上编写的代码
apply from: "greeting.gradle"
运行代码
在 plugin 工程下执行以下语句
gradle tasks
可以看到控制台有输出语句
Other tasks
-----------
hello
这就是刚才创建的 Gradle Task。接着执行以下语句运行该 Task：
gradle -q hello
成功的话控制台会输出 "Hi from Gradle"。至此一个简单的插件已经开发完毕，接下来为了在其它工程中使用我们可以先将插件发布到本地。
发布插件
编写 Groovy 文件
上节的 greeting.gradle 文件只是用于快速开发时使用，正式开发或发布时我们需要编写单独的 Groovy 文件。
如果需要将上述的代码转换为单独的 Groovy 文件只需要执行以下操作：
新建一个名为 GreetingPlugin.groovy 的文件，将之前的 greeting.build 中的除了 apply 和 greeting() 之外的代码都拷贝到该文件即可。
指定 Short Plugin Id
使用插件时我们需要指定插件的 id，如 apply plugin: "Java"，这表示使用一个名为 Java 的 Gradle 插件。默认的 Gradle 插件 ID 的值为 Plugin 所在的 包名+类名，很显然这个太长了，所以 Gradle 允许我们通过指定一个 Short ID 来作为别名。
建立 Short ID 的步骤如下
在 plugin 工程的 resources 目录下建立 META-INF/gradle-plugins 文件夹，在其中建立名为 <shortId>.properties 的文件
例：
greeting.properties
implementation-class=com.bookislife.example.GreetingPlugin
implementation-class 是插件真正的实现类，该文件名则为对应的 Short ID
发布插件到本地
修改 plugin 下的 build.gradle 文件，追加以下代码
group "com.test"
version "1.0-SNAPSHOT"
以上指定了插件发布的 group 和 version，而插件的 name 则默认为模块名，即 plugin，继续修改 build.gradle 追加 maven 发布插件
apply plugin: 'maven'
uploadArchives {
repositories {
mavenDeployer {
repository(url: uri('../repo'))
}
}
}
运行
gradle -q upload
此时编写好的插件就会被发布到工程根目录下的 repo 文件夹下。
使用插件
在父工程的根目录下建立新的基于 Gradle 的工程 "test"，这个工程用于测试刚才创建的插件是否能正常工作。
修改该工程下的 build.gradle 文件
buildscript {
repositories {
maven {
url uri('../repo')
}
mavenCentral()
}
dependencies {
classpath 'com.test:plugin:1.0-SNAPSHOT'
}
}
apply plugin: 'greeting'
greeting {
message = 'Hello'
greeter = 'a test module'
}
接着定位到 test 工程下，在控制台执行以下语句
gradle -q hello
成功的话可以看到控制台输出 Hello from a test module。
Log 系统
在开发 Gradle 插件时可以使用 Gradle 自身的日志系统来方便调试
使用时只需调用 project.logger.error(msg) 即可，其中 error() 方法指定 Log 级别为 error，除了 error 之外还有以下几个级别，每个级别都可以通过对应名称的方法进行调用：
Log 级别
- quiet
- error
- warn
- lifecycle
- info
- debug
- trace
在运行 Gradle 命令时可以通过加上级别或其缩写来控制只输出某个级别以上的日志
如
gradle -q build
或
gradle --quiet build
以上两句表面只有 quiet 级别以上的 Log 日志才可以被输出。
如果嫌使用 Log 麻烦的话也可以直接使用内置的 println() 方法进行输出，Gradle 内部会将其重定向为 quiet 级别的日志。
Debug
开发插件不可避免需要进行 Debug，此时只需执行以下几个步骤即可：
- 在对应的代码处打上断点
- 执行需要 Debug 的 task
gradle -Dorg.gradle.debug=true hello - 选择 IDEA 的
Run Configurations-> 建立Remote，创建完后点击Debug按钮，程序就会在断点处中断运行了，然后就可以愉快的 Debug 了。
本节完整的 Gradle Plugin 示例可以参见 https://github.com/SidneyXu/templates/tree/master/hello-gradle
