Gradle插件编写

Gradle插件本质就是一堆能够被复用的task的集合,就像抽取工具类一样。为了能写出一个可以发布的插件,先一步一步来。按照Gradle官方的文档中插件可以分为三种类型:

  1. Build script,写在build script中的插件。即直接在build.gradle中写的插件,便于理解。先写一个简单的GreetingPlugin插件,作用是增加一个叫hello的task,功能是在hello task执行完成后输出一段'Hello from the GreetingPlugin' 的log,上代码:
class GreetingPlugin implements Plugin<Project> {
    void apply(Project project) {
        project.task('hello') {
            doLast {
                println 'Hello from the GreetingPlugin'
            }
        }
    }
}

// Apply the plugin(应用该插件)
apply plugin: GreetingPlugin

运行结果:

> gradle -q hello
Hello from the GreetingPlugin

有时候还需要根据任务的不通向gradle插件中传入参数,比如是否开启该插件,或者文件路径等等,这个在平时的项目中使用也很多。如何做到呢?大体思路是先定一个包含需要传递信息的类,然后在插件中根据提供的配置生成这个类的对象。比如要在上面的GreetingPlugin插件可以传入自定义的信息,而不是写死的'Hello from the GreetingPlugin' 。可以这么做:

class GreetingPluginExtension {//定义包含需要传递信息的类
    String message = 'Hello from GreetingPlugin'
}

class GreetingPlugin implements Plugin<Project> {
    void apply(Project project) {
        // Add the 'greeting' extension object(获取叫greeting的对象)
        def extension = project.extensions.create('greeting', GreetingPluginExtension)
        // Add a task that uses configuration from the extension object
        project.task('hello') {
            doLast {
                println extension.message//输出GreetingPluginExtension类greeting对象的信息
            }
        }
    }
}

apply plugin: GreetingPlugin

// Configure the extension
greeting.message = 'Hi from Gradle'

那如果不是仅仅传递一个字符串,要传入更多的数据,比如两个字符串或者一个字符串一个boolean值呢?这里以两个字符串举例,思路还是一样的。见代码:

class GreetingPluginExtension {
    String message
    String greeter
}

class GreetingPlugin implements Plugin<Project> {
    void apply(Project project) {
        def extension = project.extensions.create('greeting', GreetingPluginExtension)
        project.task('hello') {
            doLast {
                println "${extension.message} from ${extension.greeter}"
            }
        }
    }
}

apply plugin: GreetingPlugin

// Configure the extension using a DSL block(配置对象)
greeting {
    message = 'Hi'
    greeter = 'Gradle'
}

只不过这里greeting对象的初始化和前面提到的有点不一样,

greeting {
    message = 'Hi'
    greeter = 'Gradle'
}

greeting.message = 'Hi from Gradle'//对比,其实这里也可以写成上面的形式
greeting {
    message = 'Hi from Gradle'
}

这样看起来是不是就熟悉多了?这就是一个插件基本构成,无论是这种简单的形式还是下面更通用的形式,gradle插件的编写都遵循这个最基本的逻辑。你也可以把这个gradle脚本发布到服务器上,使用apply plugin:"<脚本地址>"的方式来多项目远程依赖。
如果把这个插件单独在写build.gradle里面的代码的时候有没有想过一个问题,如果我想在这里使用其他Java库比如Gson怎么办?如果是在

dependencies {
    implementation "com.google.code.gson:gson:2.8.6"
}

这里是给项目里用的,对于build.gradle本身而言并没有效果,因为在dependencies会参与project的编译而不是build.gradle编译。解决问题的方法是在buildScript里面加入需要的库(这里是build.gradle.kts,调用方法和build.gradle有点不一致):

buildscript {
    repositories {
        mavenCentral()
    }

    dependencies.classpath("com.google.code.gson:gson:2.8.6")
}

那么就可以在build.gradle里使用Gson了:


image.png
  1. buildSrc project,写在buildSrc 工程里的插件。即在rootProjectDir/buildSrc/src/main/java directory (或者 rootProjectDir/buildSrc/src/main/groovy 或者 rootProjectDir/buildSrc/src/main/kotlin)文件夹下的插件。为什么是这个文件夹?Gradle里面约定的,仅此而已。
    先来根据上面的路径创建目录:
├── buildSrc
│   ├── build.gradle
│   └── src
│       ├── main
│       │   └── java
│       │       └── com
│       │           └── enterprise
│       │               ├── Deploy.java
│       │               └── DeploymentPlugin.java

插件不仅可以用Groovy写也可以用Java或者Kotlin写,但是要注意,对应的语言要放在对应的文件夹下(Gradle官方推荐这么做,考虑到性能和方便开发者查看):

├── build.gradle
└── src
    └── main
        ├── java
        │   └── HelloWorld.java
        └── kotlin
        │    └── Utils.kt
         └── groovy
            └── Utils.groovy

回到具体插件的编写,如果在java目录下写了一个DeploymentPlugin.java,在具体需要使用的build.gradle中apply plugin:DeploymentPlugin就好。这又是怎么做到的?Gradle是如何将DeploymentPlugin插件依赖过来的?
Gradle发现存在buildSrc目录后会编译该目录,将里面的插件生成一个buildSrc.jar。所有的gradle.build的buildsrcipt{}默认会去加载这个classpath,也就可以查找到编写的插件。好buildSrc就介绍到这里。

  1. Standalone project,独立插件项目,这个就是可以发布给任意项目使用的gradle插件,比如项目中的com.android.application等等。
    如果上面的流程都搞通了,发布插件仅仅是多了一点配置而已。重点是关注插件的编写,需要相关资料可以参考https://docs.gradle.org/current/userguide/custom_plugins.html#sec:custom_plugins_standalone_project
    相关资料,都是机械的配置即可,没有什么特别的技巧。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,014评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,796评论 3 386
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,484评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,830评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,946评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,114评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,182评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,927评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,369评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,678评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,832评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,533评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,166评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,885评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,128评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,659评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,738评论 2 351

推荐阅读更多精彩内容