為Android Studio編寫自定義Gradle插件的教程
Google已經(jīng)建議Android開發(fā)全部轉(zhuǎn)向Android Studio開發(fā),Android Studio 是使用gradle編譯、打包的,那么問題來了,gradle可是有一堆東西...,為了徹底了解gradle,今天就來學習下如何寫自己的gradle插件(當然插件源碼是使用groovy寫的),先看如下代碼目錄:

如上圖所示,plugin目錄是插件源碼目錄,sample是用來測試插件的。
1、在目錄plugin/src/main/groovy/com/micky/gradle/下新建插件類MyCustomPlugin.groovy
package com.micky.gradle;
import org.gradle.api.*;
class MyCustomPlugin implements Plugin<Project> {
void apply(Project project) {
project.task('myTask') << {
println "Hi this is micky's plugin"
}
}
}
看看Plugin的源碼,其實就是一接口
public interface Plugin<T> {
/**
* Apply this plugin to the given target object.
*
* @param target The target object
*/
void apply(T target);
}
2、在目錄plugin/src/main/resources/META-INF/gradle-plugins/下創(chuàng)建文件com.micky.mycustom.properties用來指定插件實現(xiàn)類
implementation-class=com.micky.gradle.MyCustomPlugin
特別注意下:文件名“com.micky.mycustom”即是以后我們在使用插件時的apply plugin 'java' 的java,這里我也是折騰了半天才得出的結(jié)果,坑啊。
3、一般情況下,我們還需要指定插件項目名稱,在plugin目錄下新建settings.gradle
rootProject.name='gradle-micky'
4、萬事具備,就差編譯了,編譯需要在plugin目錄下新建build.gradle
apply plugin: 'groovy'
apply plugin: 'maven'
dependencies {
compile gradleApi()
compile localGroovy()
}
repositories {
mavenCentral()
}
group='com.micky'
version='1.0.0'
uploadArchives {
repositories {
mavenDeployer {
repository(url: uri('../repo'))
}
}
}
在這個腳本里使用groovy插件編譯groovy源碼,聲明gradleAPI作為即時編譯依賴,apply plugin: 'maven' 是用來創(chuàng)建一個插件jar文件并且存儲在本地maven庫里,本地maven庫即我們在腳本里創(chuàng)建的"../repo"目錄
執(zhí)行命令:
gradle uploadArchives

5、以上4個步驟已經(jīng)編譯插件并上傳到了本地庫中,接下來就看看怎么使用插件,在sample目錄下,新建build.gradle
buildscript {
repositories {
maven {
url uri('../repo')
}
}
dependencies {
classpath group: 'com.micky',
name: 'gradle-micky',
version: '1.0.0'
}
}
apply plugin: 'com.micky.mycustom'
6、執(zhí)行命令

myTask即我們在MyCustomPlugin.groovy代碼中創(chuàng)建的任務。
7、自定義Task
(1)copy一份改名CustomPluginTask
在plugin\src\main\groovy\com\micky\gradle目錄創(chuàng)建源文件 MyCustomTask.groovy
package com.micky.gradle;
import org.gradle.api.DefaultTask
import org.gradle.api.tasks.TaskAction
class MyCustomTask extends DefaultTask {
@TaskAction
void output() {
println "Hello this is my custom task output"
}
}
(2)修改MyCustomPlugin.groovy
package com.micky.gradle;
import org.gradle.api.*;
class MyCustomPlugin implements Plugin<Project> {
void apply(Project project) {
project.task('customTask', type: MyCustomTask)
}
}
(3)修改plugin目錄下的build.gradle,修改版本號
apply plugin: 'groovy'
apply plugin: 'maven'
dependencies {
compile gradleApi()
compile localGroovy()
}
repositories {
mavenCentral()
}
group='com.micky'
version='1.0.1'
uploadArchives {
repositories {
mavenDeployer {
repository(url: uri('../repo'))
}
}
}
執(zhí)行g(shù)radle uploadArchives 編譯插件包
(4)sample目錄下的build.gradle
buildscript {
repositories {
maven {
url uri('../repo')
}
}
dependencies {
classpath group: 'com.micky',
name: 'gradle-micky',
version: '1.0.1'
}
}
apply plugin: 'com.micky.mycustom'
執(zhí)行g(shù)radle customTask 結(jié)果如下:

8、向Plugin Task 傳遞參數(shù)
(1)拷貝一份上面的代碼,改名為CustomPluginTaskWithParam,修改plugin\src\main\groovy\com\micky\gradle\MyCustomPlugin.groovy
package com.micky.gradle;
import org.gradle.api.*;
class MyCustomPluginExtension {
def message = "From MyCustomPluginExtention"
def sender = "MyCustomPluin"
}
class MyCustomPlugin implements Plugin<Project> {
void apply(Project project) {
project.extensions.create('myArgs', MyCustomPluginExtension)
project.task('customTask', type: MyCustomTask)
}
}
(2)修改plugin\src\main\groovy\com\micky\gradle\MyCustomTask.groovy
package com.micky.gradle;
import org.gradle.api.DefaultTask
import org.gradle.api.tasks.TaskAction
class MyCustomTask extends DefaultTask {
@TaskAction
void output() {
println "Sender is ${project.myArgs.sender},\nmessage: ${project.myArgs.message}"
}
}
(3)修改plugin/build.gradle
apply plugin: 'groovy'
apply plugin: 'maven'
dependencies {
compile gradleApi()
compile localGroovy()
}
repositories {
mavenCentral()
}
group='com.micky'
version='1.0.2'
uploadArchives {
repositories {
mavenDeployer {
repository(url: uri('../repo'))
}
}
}
執(zhí)行g(shù)radle uploadArchives 編譯插件包
(4)修改sample/build.gradle
buildscript {
repositories {
maven {
url uri('../repo')
}
}
dependencies {
classpath group: 'com.micky',
name: 'gradle-micky',
version: '1.0.2'
}
}
apply plugin: 'com.micky.mycustom'
(5)執(zhí)行g(shù)radle customTask,結(jié)果如下:

(6)在gradle文件配置參數(shù)
buildscript {
repositories {
maven {
url uri('../repo')
}
}
dependencies {
classpath group: 'com.micky',
name: 'gradle-micky',
version: '1.0.2'
}
}
apply plugin: 'com.micky.mycustom'
myArgs {
sender='Micky Liu'
message='Gradle is so simple.'
}
(7)執(zhí)行g(shù)radle customTask,結(jié)果如下:

8、向Plugin Task 傳遞嵌套試復雜參數(shù)
(1)拷貝一份上面的代碼,改名為CustomPluginTaskWithNestParam,修改plugin\src\main\groovy\com\micky\gradle\MyCustomPlugin.groovy
package com.micky.gradle;
import org.gradle.api.*;
class MyNestPluginExtension {
def receiver = "Kate Zhou"
def email = "KateZhou@gmail.com"
}
class MyCustomPluginExtension {
def message = "From MyCustomPluginExtention"
def sender = "MyCustomPluin"
}
class MyCustomPlugin implements Plugin<Project> {
void apply(Project project) {
project.extensions.create('myArgs', MyCustomPluginExtension)
project.myArgs.extensions.create('nestArgs', MyNestPluginExtension)
project.task('customTask', type: MyCustomTask)
}
}
(2)修改MyCustomPlugin.groovy
package com.micky.gradle;
import org.gradle.api.DefaultTask
import org.gradle.api.tasks.TaskAction
class MyCustomTask extends DefaultTask {
@TaskAction
void output() {
println "Sender is ${project.myArgs.sender} \nmessage: ${project.myArgs.message}"
println "Receiver is ${project.myArgs.nestArgs.receiver} \nemail: ${project.myArgs.nestArgs.email}"
}
}
(3)修改plugin/build.gradle
apply plugin: 'groovy'
apply plugin: 'maven'
dependencies {
compile gradleApi()
compile localGroovy()
}
repositories {
mavenCentral()
}
group='com.micky'
version='1.0.3'
uploadArchives {
repositories {
mavenDeployer {
repository(url: uri('../repo'))
}
}
}
(4)執(zhí)行g(shù)radle uploadArchives 編譯插件包
(5)修改sample/build.gradle
buildscript {
repositories {
maven {
url uri('../repo')
}
}
dependencies {
classpath group: 'com.micky',
name: 'gradle-micky',
version: '1.0.3'
}
}
apply plugin: 'com.micky.mycustom'
myArgs {
sender='Micky Liu'
message='Gradle is so simple.'
}
(6)執(zhí)行執(zhí)行g(shù)radle customTask,結(jié)果如下:

(7)在gradle文件配置參數(shù)
buildscript {
repositories {
maven {
url uri('../repo')
}
}
dependencies {
classpath group: 'com.micky',
name: 'gradle-micky',
version: '1.0.3'
}
}
apply plugin: 'com.micky.mycustom'
myArgs {
sender='Micky Liu'
message='Gradle is so simple.'
nestArgs {
receiver='David Chen'
email='David@126.com'
}
}
(8)執(zhí)行g(shù)radle customTask,結(jié)果如下:

源碼地址:https://github.com/mickyliu945/GradleCustomPlugin
- 詳解如何使用Android Studio開發(fā)Gradle插件
- 詳解Android Gradle插件3.0挖坑日記
- Android gradle插件打印時間戳的方法詳解
- Android Studio Gradle插件版本與Gradle版本之間的對應關系
- AndroidStudio升級4.1坑(無法啟動、插件plugin不好用、代碼不高亮)
- AndroidStudio升級4.1后啟動失敗Plugin問題解決
- 解決Android Studio4.1沒有Gsonfomat插件,Plugin “GsonFormat” is incompatible的問題
- Android自定義Gradle插件的詳細過程
- Android?Studio?中Gradle配置sonarqube插件(推薦)
- Android?Gradle?插件自定義Plugin實現(xiàn)注意事項
相關文章
android自定義View實現(xiàn)圓環(huán)顏色選擇器
這篇文章主要介紹了android自定義View實現(xiàn)圓環(huán)顏色選擇器,具有一定的參考價值,感興趣的小伙伴們可以參考一下2018-06-06
Android查看電池電量的方法(基于BroadcastReceiver)
這篇文章主要介紹了Android查看電池電量的方法,結(jié)合實例分析了Android使用BroadcastReceiver實現(xiàn)針對電池電量的查詢技巧,需要的朋友可以參考下2016-01-01
完美解決Android Studio集成crashlytics后無法編譯的問題
下面小編就為大家?guī)硪黄昝澜鉀QAndroid Studio集成crashlytics后無法編譯的問題。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-05-05
Android 8.1 Launcher3實現(xiàn)動態(tài)指針時鐘功能
這篇文章主要介紹了Android 8.1 Launcher3實現(xiàn)動態(tài)指針時鐘功能,本文通過實例代碼給大家介紹的非常詳細,具有一定的參考借鑒價值,需要的朋友可以參考下2018-07-07

