目錄

• 1. 腳本插件
• 2. 對(duì)象插件
  • 在build.gradle中寫Plugin
  • 創(chuàng)建單獨(dú)的 “buildSrc” Module
  • 上傳遠(yuǎn)端maven倉庫

---

gradle插件分成腳本插件和對(duì)象插件：

• 腳本插件：一個(gè)普通的構(gòu)建腳本，可以導(dǎo)入到其他的構(gòu)建腳本中。
• 對(duì)象插件：實(shí)現(xiàn)了org.gradle.api.Plugin接口。

1. 腳本插件

假設(shè)我們有一個(gè)腳本名為 sayhello.gradle ，它里面有一個(gè)task：

task sayHello << {println 'hello world' }

然后我們?cè)赽uild.gradle中依賴這個(gè)外部腳本，調(diào)用Project的apply方法，apply方法調(diào)用時(shí)傳入from屬性。

apply from: 'sayhello.gradle'

此時(shí)我們運(yùn)行g(shù)radle sayHello 命令，可以看到sayHello 這個(gè)task執(zhí)行了：

:sayHello hello world

2. 對(duì)象插件

有三種形式可以定義對(duì)象插件：

• 直接在build.gradle中編寫Plugin，這種方式這種方法寫的Plugin無法被其他 build.gradle 文件引用。
• 單獨(dú)的一個(gè)Module，這個(gè)Module的名稱必須為buildSrc，同一個(gè)工程中有的構(gòu)建文件夠可以引用這個(gè)插件，但是不能被其他工程引用。
• 在一個(gè)項(xiàng)目中自定義插件，然后上傳到遠(yuǎn)端maven庫等，其他工程通過添加依賴，引用這個(gè)插件。

在build.gradle中寫Plugin

apply plugin:UserPlugin// 實(shí)現(xiàn)Plugin class UserPlugin implements Plugin<Project>{@Overridevoid apply(Project project){println "hello" } }

創(chuàng)建單獨(dú)的 "buildSrc" Module

• 創(chuàng)建一個(gè) Module （Phone&Tablet Module 或 Android Librarty 都可以），Module的名稱必須為 buildSrc。
• 將Module里面的內(nèi)容刪除，只保留build.gradle文件和src/main目錄。
• 我們開發(fā)的 gradle 插件相當(dāng)于一個(gè) groovy 項(xiàng)目。所以需要在 main 目錄下新建 groovy 目錄。
• 然后創(chuàng)建一個(gè) Java 文件一樣的方式創(chuàng)建一個(gè) groovy 文件，比如包名為 com.android.xx 的 TestPlugin.groovy 文件。

因?yàn)間radle插件實(shí)際上就是groovy項(xiàng)目，所以需要groovy和gradle的sdk，需要在buildSrc下面的build.gradle修改成：

apply plugin: 'groovy'dependencies {//gradle sdkcompile gradleApi()//groovy sdkcompile localGroovy() } repositories {jcenter() }

使用這個(gè)插件，需要在app的build.gradle添加

apply plugin: com.android.hq.testplugin.TestPlugin

輸入 ./gradlew tasks，我們可以看到 testPlugin 已經(jīng)在task列表中。

上傳遠(yuǎn)端maven倉庫

創(chuàng)建一個(gè)新的 Project。

同樣創(chuàng)建一個(gè) Module （Phone&Tablet Module 或 Android Librarty 都可以），Module的名稱隨意。

將Module里面的內(nèi)容刪除，只保留build.gradle文件和src/main目錄。

我們開發(fā)的 gradle 插件相當(dāng)于一個(gè)groovy項(xiàng)目。所以需要在main目錄下新建groovy目錄。

然后創(chuàng)建一個(gè) Java 文件一樣的方式創(chuàng)建一個(gè) groovy文件，比如報(bào)名為 com.android.xx 的 TestPlugin.groovy 文件。

現(xiàn)在，我們已經(jīng)定義好了自己的 gradle 插件類，接下來就是告訴 gradle，哪一個(gè)是我們自定義的插件類，因此，需要在 main 目錄下新建 resources 目錄，然后在 resources 目錄里面再新建 META-INF 目錄，再在 META-INF 里面新建 gradle-plugins 目錄。最后在 gradle-plugins 目錄里面新建 properties 文件，注意這個(gè)文件的命名，你可以隨意取名，但是后面使用這個(gè)插件的時(shí)候，會(huì)用到這個(gè)名字。比如，取名為
com.android.xx.properties，而在其他 build.gradle 文件中使用自定義的插件時(shí)候則需寫成：apply plugin: 'com.android.xx'

然后在com.android.hq.testplugin.properties文件里面指明你自定義的類：implementation-class=com.android.hq.testplugin.TestPlugin

修改build.gradle: 因?yàn)槲覀円玫?groovy 以及后面打包要用到 maven ,所以在我們自定義的 Module 下的 build.gradle 需要添加如下代碼：

apply plugin: 'groovy' apply plugin: 'maven'dependencies {//gradle sdkcompile gradleApi()//groovy sdkcompile localGroovy() } repositories {mavenCentral() }

前面我們已經(jīng)自定義好了插件，接下來就是要打包到Maven庫里面去了，你可以選擇打包到本地，或者是遠(yuǎn)程服務(wù)器中。

//group和version在后面使用自定義插件的時(shí)候會(huì)用到 group='com.android.xx' version='1.0.0'uploadArchives {repositories {mavenDeployer {//提交到遠(yuǎn)程服務(wù)器：//repository(url: "http://www.xxx.com/repos") {// authentication(userName: "admin", password: "admin")//}//本地的Maven地址設(shè)置為/mnt/TestRepos/repository(url: uri('/mnt/TestRepos/'))}} }

然后通過gradle的uploadArchives就可以執(zhí)行打包上傳下載了。我們可以在對(duì)應(yīng)的文件目錄下可以看到對(duì)應(yīng)的jar包。

我們可以在Module的build的gradle文件中指定Mavne的地址，自定義插件的名稱和依賴包名。

//com.android.hq.testplugin.TestPlugin為resources/META-INF/gradle-plugins 下的properties文件名稱 apply plugin: 'com.android.xx'buildscript {repositories {maven {//本地Maven倉庫地址url uri('/mnt/TestRepos/')}}dependencies {//格式為-->group:module:versionclasspath 'com.android.hq.testplugin:testplugin:1.0.0'} }

總結(jié)

以上是生活随笔為你收集整理的自定义Gradle插件（十）的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。