自定義Gradle插件主要有三種形式蜒车，分別是build.gradle中編寫续室、buildSrc工程項(xiàng)目中編寫勃刨、獨(dú)立項(xiàng)目或獨(dú)立module中編寫波材。
1. 在build.gradle中編寫自定義插件
對(duì)象插件是實(shí)現(xiàn)了org.gradle.api.plugins接口的插件，這個(gè)接口中只定義個(gè)一個(gè)簡(jiǎn)單的apply方法身隐，想要實(shí)現(xiàn)自定義插件就需要去實(shí)現(xiàn)org.gradle.api.plugins接口廷区。
Groovy、Java贾铝、Kotlin都可以作為實(shí)現(xiàn)插件的語(yǔ)言隙轻，在本文的示例中，使用Groovy作為實(shí)現(xiàn)語(yǔ)言垢揩。
在實(shí)際工作中我們很少會(huì)在build.gradle中編寫自定義插件玖绿，這里是為了帶大家寫個(gè)最簡(jiǎn)單的例子，可以最快最直接的了解什么是自定義插件叁巨。
1.1 這里使用AS來(lái)編輯斑匪，新建一個(gè)項(xiàng)目，在module中的build.gradle中鍵入以下內(nèi)容：
// Apply the plugin
apply plugin: GreetingPlugin
class GreetingPlugin implements Plugin<Project> {
void apply(Project project) {
project.task('GreetingPluginTask') {
doLast {
println '自定義插件'
}
}
}
}
在build.gradle中自定義了一個(gè)插件GreetingPlugin锋勺，在apply方法中創(chuàng)建一個(gè)名稱為GreetingPluginTask的任務(wù)蚀瘸。在AS的Terminal中輸入gradlew.bat GreetingPluginTask來(lái)執(zhí)行GreetingPluginTask任務(wù)。
D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradle>gradle GreetingPluginTask
> Task :app:GreetingPluginTask
自定義插件
BUILD SUCCESSFUL in 2s
1 actionable task: 1 executed
1.2 自定義插件擴(kuò)展
再舉一個(gè)簡(jiǎn)單的插件拓展例子庶橱，通過(guò)插件拓展來(lái)配置GreetingPluginTask的輸出字符串贮勃，如下所示。
build.gradle
apply plugin: GreetingPlugin
greeting.message="自定義插件拓展"http://2
class GreetingPluginPluginExtension{
String message="from GreetingPlugin"
}
class GreetingPlugin implements Plugin<Project> {
void apply(Project project) {
def extension=project.extensions.create("greeting",GreetingPluginPluginExtension)//1
project.task('GreetingPluginTask') {
doLast {
println extension.message
}
}
}
}
GreetingPluginPluginExtension類中定義了message變量苏章，GreetingPluginPluginExtension是一個(gè)Groovy Bean(類似于JavaBean)寂嘉。注釋1處用于添加拓展插件GreetingPluginPluginExtension到插件列表中，名稱為greeting。注釋2處設(shè)置GreetingPluginPluginExtension的message值垫释。
Terminal中輸入gradlew.bat GreetingPluginTask來(lái)執(zhí)行GreetingPluginTask任務(wù)丝格。
D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradle>gradle GreetingPluginTask
> Task :app:GreetingPluginTask
自定義插件拓展
BUILD SUCCESSFUL in 2s
1 actionable task: 1 executed
2. buildSrc工程項(xiàng)目
除了在build.gradle中編寫的自定義插件，還可以將插件的源代碼放在rootProjectDir/buildSrc/src/main/groovy目錄中棵譬，Gradle會(huì)自動(dòng)識(shí)別來(lái)完成編譯和測(cè)試显蝌。Android Studio會(huì)找rootPrjectDir/buildSrc/src/main/groovy目錄下的代碼。
坑：當(dāng)新建libraray module并命名為buildSrc后會(huì)提示Plugin with id'com.android.library' not found.
這是因?yàn)閎uildSrc是Android的保留名稱订咸，只能作為plugin插件使用曼尊，我們修改buildSrc的build.gradle文件后就不報(bào)錯(cuò)了。
具體流程如下：
2.1. 首先創(chuàng)建一個(gè)名為buildSrc的module脏嚷，注意骆撇，名稱必須為buildSrc
2.2. 然后將其它不需要的文件刪除，新建需要的文件夾和文件父叙，最后的目錄結(jié)構(gòu)如下圖所示：
2.3. 新建對(duì)應(yīng)的文件和文件夾之后神郊，工程開(kāi)始會(huì)不認(rèn)這個(gè)buildSrc，我們修改build.gradle：
apply plugin: 'groovy'
dependencies {
compile gradleApi()
compile localGroovy()
}
點(diǎn)擊Sync Now趾唱，完了之后發(fā)現(xiàn)groovy文件夾變藍(lán)色了
2.4. 在對(duì)應(yīng)的包下面新建YolynPlugin.groovy涌乳，輸入以下內(nèi)容
import org.gradle.api.Plugin
import org.gradle.api.Project
class YolynPlugin implements Plugin<Project> {
@Override
void apply(Project project) {
project.task('yolynplugin') {
doLast {
println("this is YolynPlugin")
}
}
println("welcome to YolynPlugin")
}
}
2.5. 再在com.yolyn.plugin.properties文件中添加以下內(nèi)容（注意這里properties的名稱就是我們之后要引用這個(gè)插件時(shí)apply plugin：''引號(hào)填入的內(nèi)容）
implementation-class=YolynPlugin
這里的YolynPlugin就是我們創(chuàng)建的YolynPlugin.groovy文件，一定要對(duì)應(yīng)上甜癞，否則會(huì)報(bào)找不到的錯(cuò)誤夕晓。
2.6. 在app的gradle中去引用這個(gè)插件
apply plugin: 'com.yolyn.plugin'
com.yolyn.plugin是我們之前創(chuàng)建的properties的名稱
重新build一下
2.7. 在terminal中可以鍵入命令
gradle yolynplugin
或者gradlew yolynplugin
或者gradlew.bat yolynplugin
輸出內(nèi)容：
D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradleDemo1>gradle yolynplugin
> Configure project :app
welcome to YolynPlugin
> Task :app:yolynplugin
this is YolynPlugin
BUILD SUCCESSFUL in 2s
1 actionable task: 1 executed
疑問(wèn)1
這里有一個(gè)疑問(wèn)，為什么先打印出welcome to YolynPlugin,是因?yàn)閐oLast嗎悠咱，怎么解釋蒸辆？
疑問(wèn)2
我們?cè)賱?chuàng)建一個(gè)插件叫OtherPlugin.groovy
import org.gradle.api.Plugin
import org.gradle.api.Project
class OtherPlugin implements Plugin<Project> {
@Override
void apply(Project project) {
project.task('otherplugin') {
doLast {
println("this is OtherPlugin")
}
}
println("Welcome To OtherPlugin")
}
}
然后同樣地在gradle-plugins中創(chuàng)建properties，在app下面的build.gradle引用
在Terminal中輸入gradle otherplugin
D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradleDemo1>gradle otherplugin
> Configure project :app
welcome to YolynPlugin
Welcome To OtherPlugin
> Task :app:otherplugin
this is OtherPlugin
BUILD SUCCESSFUL in 2s
1 actionable task: 1 executed
發(fā)現(xiàn)YolynPlugin中的apply方法也執(zhí)行了
疑問(wèn)3
我們把兩個(gè)Plugin中的doLast去掉
我們?cè)僭赥erminal中輸入gradle otherplugin
D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradleDemo1>gradle otherplugin
> Configure project :app
this is YolynPlugin
welcome to YolynPlugin
this is OtherPlugin
Welcome To OtherPlugin
BUILD SUCCESSFUL in 6s
發(fā)現(xiàn)全部都打印出來(lái)了析既，這是為什么躬贡？
- 對(duì)于疑問(wèn)1:
我們看一下官方對(duì)Projec的task方法的介紹
Creates a Task with the given name and adds it to this project. Calling this method is equivalent to calling task(java.util.Map, String) with an empty options map.
After the task is added to the project, it is made available as a property of the project, so that you can reference the task by name in your build file. See here for more details
If a task with the given name already exists in this project, an exception is thrown.
throws:
InvalidUserDataException If a task with the given name already exists in this project.
Parameters:
name - The name of the task to be created
Returns:
The newly created task object
大致意思是會(huì)創(chuàng)建一個(gè)給定名字的task放到這個(gè)project里面，調(diào)用這個(gè)方法相當(dāng)于調(diào)用這個(gè)task
再看一下Task的doLast方法：
Adds the given closure to the end of this task's action list. The closure is passed this task as a parameter when executed.
這樣就能解釋了眼坏，確實(shí)是因?yàn)閐oLast將任務(wù)添加到project的tasks的list的最后了逗宜，所以才最后執(zhí)行。具體還可以查看官方文檔的Project空骚，文檔在gradle安裝目錄的docs里面可以找到。
==疑問(wèn)二和疑問(wèn)三是為什么擂仍？囤屹？？求解==
日后繼續(xù)研究
再看第三種形式
3. 獨(dú)立項(xiàng)目或獨(dú)立Module
無(wú)論是在build.gradle中編寫自定義插件逢渔，還是buildSrc項(xiàng)目中編寫自定義插件肋坚，都只能在自己的項(xiàng)目中進(jìn)行使用。如果想要分享給其他人或者自己用，可以在一個(gè)獨(dú)立的項(xiàng)目中編寫插件智厌，這個(gè)項(xiàng)目會(huì)生成一個(gè)包含插件類的JAR文件诲泌，有了JAR文件就很容易進(jìn)行分享了。
3.1 創(chuàng)建一個(gè)名為YolynPlugin的module
跟上面創(chuàng)建buildSrc一樣铣鹏，將其它文件刪除敷扫，并創(chuàng)建相應(yīng)的文件和文件夾，最終目錄結(jié)構(gòu)如下：
3.2 修改build.gradle
apply plugin:'groovy'
apply plugin: 'maven'
dependencies {
//gradle sdk
compile gradleApi()
//groovy sdk
compile localGroovy()
}
Sync Now
3.3 在com.example.yolynplugin下創(chuàng)建ModuleYolynPlugin.groovy（為了和上面的YolynPlugin區(qū)分）
import org.gradle.api.Plugin
import org.gradle.api.Project
class ModuleYolynPlugin implements Plugin<Project> {
@Override
void apply(Project project) {
project.task("moduleyolynplugin") {
println("this is module yolynplugin")
}
}
}
3.4 在gradle-plugins文件夾下面創(chuàng)建com.example.yolynplugin.properties
implementation-class=ModuleYolynPlugin
3.5 將代碼上傳到倉(cāng)庫(kù)或者本地诚卸，這里是放到本地
在這個(gè)module的build.gradle追加下面內(nèi)容
group='com.example.yolynplugin'
version='1.0.0'
//group和version在后面會(huì)用到
uploadArchives {
repositories {
mavenDeployer {
//提交到遠(yuǎn)程服務(wù)器：
// repository(url: "http://www.xxx.com/repos") {
// authentication(userName: "admin", password: "admin")
// }
repository(url:uri('../repo'))
}
}
}
上面各個(gè)參數(shù)的邏輯意義參考官方文檔：
https://docs.gradle.org/current/dsl/index.html
這里直接將插件上傳到了本項(xiàng)目的根目錄葵第，點(diǎn)擊Build之后在Gradle窗口會(huì)看到uploadArchives
點(diǎn)擊uploadArchives會(huì)在本地生成插件相關(guān)的文件，比如我的目錄和文件如下圖所示
圖中的YolynPlugin-1.0.0.jar就是我們需要的插件jar包合溺。
3.6 去app下面的module中引用
在build.gradle中追加下面內(nèi)容
apply plugin: 'com.example.yolynplugin'//properties的名字
buildscript {
//repositories這個(gè)模塊的內(nèi)容告訴gradle去什么地址下載第三方的庫(kù)卒密。
repositories{
maven {
url uri('../repo')
}
}
dependencies{
//group:pluginName:version
classpath 'com.example.yolynplugin:YolynPlugin:1.0.0'
}
}
其中com.example.yolynplugin是group，YolynPlugin是自定義插件的名稱棠赛，1.0.0是版本號(hào)
也可以這么寫:
dependencies {
classpath group: 'com.example.yolynplugin', name: 'YolynPlugin',
version: '1.0.0'
}
Sync Now
3.7 clean一下Project哮奇，然后make Project，在Terminal中輸入：gradle moduleyolynplugin
D:\DevelopSoftWare_Location\Android_Studio\DemoWorkSpace\DefinedGradleDemo1>gradle moduleyolynplugin
> Configure project :app
welcome to YolynPlugin
Welcome To OtherPlugin
this is module yolynplugin
BUILD SUCCESSFUL in 8s
三個(gè)插件都成功運(yùn)行
筆記來(lái)源于：
1.https://blog.csdn.net/huachao1001/article/details/51810328
2. http://liuwangshu.cn/application/gradle/6-custonplugin.html
