Android Studio自定義gradle插件

這是我...第一次寫blog...

總感覺做開發(fā)的還是要寫點(diǎn)這種分享,之前一直沒有付出行動,嗯,因?yàn)閼校际亲约和低得淈c(diǎn)小筆記。年底剛換了個(gè)新環(huán)境,也不能總是搞業(yè)務(wù)吧,還是要有點(diǎn)規(guī)劃和方向的。于是在主管的開導(dǎo)下,開始接觸自定義gradle插件開發(fā)。因?yàn)榻裉焓谴汗?jié)放假前最后一天呀,還是我生日.. 在這么個(gè)特殊的日子的,決定開始我的blog,先劃一波水...


進(jìn)入主題:

首先,插件可以以三種方式存在:

在我們構(gòu)建的app項(xiàng)目下的build.gradle腳本中直接編寫

在我們構(gòu)建項(xiàng)目的rootProjectDir/buildSrc/src/main/groovy目錄下

以單獨(dú)的project存在

這里我采用第三種,單獨(dú)創(chuàng)建Gradle Plugin 工程,這種方式的好處在于可以將插件打包發(fā)布,并很好的分享給使用者。


?創(chuàng)建Gradle Module

1.首先,file? ---> new module創(chuàng)建一個(gè)module, 這里用android library

圖1


2.刪除不必要的包/文件,只保留build.gradle文件和src/main目錄。 圖2 -> 圖3的過程


圖2
圖3


3.由于gradle是基于groovy,因此,我們開發(fā)的gradle插件相當(dāng)于一個(gè)groovy項(xiàng)目。所以需要在main目錄下新建groovy目錄,在groovy目錄下新建包名,在該包下新建groovy文件,通過new->file->JbzPlugin.groovy來新建名為JbzPlugin的groovy文件。

圖4

這里對我來說有個(gè)巨坑,Plugin類的創(chuàng)建一定要是通過new->file->JbzPlugin.groovy來新建名為JbzPlugin的groovy文件,注意:要直接在命名的時(shí)候就輸入后綴.groovy!!!如果通過輸入JbzPlugin再在選擇文件類型的時(shí)候選groovy模版,這樣不行,會一直報(bào)圖5的error

圖5

然后我在網(wǎng)上查了各種資料,什么刪除項(xiàng)目的.gradle和本地的.gradle,各種clean,降低gradle版本(因?yàn)榈谝淮蝿?chuàng)建出來的自定義gradle插件是可行的,但是后來可能看到了選擇類型這種創(chuàng)建方式,忘記第一次怎么創(chuàng)建出來的,正好這兩天發(fā)現(xiàn)自己gradle版本升到了4.1,以為是gradle版本升高了的關(guān)系,(關(guān)于gradle降版本要將gradle包下的整個(gè)wrapper都替換掉,不僅僅是修改gradle-wrapper.properties里面的版本號, gradle-wrapper.jar這個(gè)包也要替換掉)),結(jié)果都不行,郁悶了我好幾天。。

奇怪的是通過new->file->JbzPlugin.groovy這種正確的創(chuàng)建方式創(chuàng)建出來的類底部會有報(bào)錯(cuò)的紅線,提示class xxx(類名) already exites in xxx(包路徑)? 雖然不影響程序的運(yùn)行。。。 最后解決之后我看了下本地的文件,打開文件所在地址,可以看到正確的創(chuàng)建方式文件名是JbzPlugin.groovy,而通過選擇類型創(chuàng)建的文件名是JbzPlugin。 所以雖然在IDE中看不出兩個(gè)類的區(qū)別,但是在本地還是有區(qū)別的。


4.新建JbzPlugin這個(gè)plugin類之后先不要在里面寫class JbzPlugin implements Plugin等等代碼,因?yàn)榇藭r(shí)你還無法導(dǎo)入Plugin類,你要先去配置build.gradle文件,將默認(rèn)的android的build.gradle替換成如下內(nèi)容

圖6

uploadArchives代碼是將已經(jīng)自定義好了插件打包到本地Maven庫里面去了,你也可以選擇打包到遠(yuǎn)程服務(wù)器中。其中,group和version是我們之后配置插件地址時(shí)要用到的。


5.好了,先將build.gradle配置好后我們回到JbzPlugin類中,這時(shí)候你已經(jīng)引用apply plugin:'groovy'了(這個(gè)就是你自定義插件的開發(fā)語言,其中包含了各種功能類)。代碼如下:

圖7


6.現(xiàn)在,我們已經(jīng)定義好了自己的gradle插件的plugin類,接下來就是告訴gradle,哪一個(gè)是我們自定義的plugin插件類,因此,需要在main目錄下新建resources目錄,然后在resources目錄里面再新建META-INF目錄,再在META-INF里面新建gradle-plugins目錄。最后在gradle-plugins目錄里面新建properties文件,注意這個(gè)文件的命名,你可以隨意取名,但是后面使用這個(gè)插件的時(shí)候,會用到這個(gè)名字。比如,你取名為com.jbz.gradle.properties,在里面關(guān)聯(lián)你的插件plugin類。代碼如下:

? ??????????????????????????????????implementation-class=com.jbz.JbzPlugin

其中com.jbz是你的路徑。

至此,你已經(jīng)初步完成了你的自定義gradle插件。


7.點(diǎn)擊AndroidStudio右側(cè)的gradle工具,如下圖所示:

圖8

可以看到有uploadArchives這個(gè)Task,雙擊uploadArchives就會執(zhí)行打包上傳到你的本地倉庫!執(zhí)行完成后,你會發(fā)現(xiàn)root目錄下多了一個(gè)repo文件,這就是你本地的Maven倉庫,其中,com/jbz這幾層目錄是由我們的group指定,gradlelibrary是模塊的名稱,1.0.0是版本號(version指定)。

該圖為所有的文件目錄


8.使用自定義gradle插件

在app 的build.gradle 中添加apply plugin:'com.jbz.gradle', 這里的com.jbz.gradle就是resources包下的那個(gè)文件名前綴(這千萬別寫錯(cuò)了),然后再添加如下buildscript,你只需添加repo, repos是我自己測試時(shí)寫的另一個(gè)maven倉庫,依賴只需要寫你自己的classpath,如:classpath'com.jbz.test:jbzlibrary:1.0.0'

這里先寫buildscript,然后sync now,再添加apply plugin:'com.jbz.gradle',再sync now,否則會報(bào)錯(cuò)。此時(shí)你已經(jīng)完成所以工作了,然后你會在app的other目錄下找到一個(gè)名叫jbzTask的,這個(gè)就是你在plugin類中定義的jbzTask

雙擊jbzTask,你可以在控制臺上看到輸入的內(nèi)容


好了,以上就是基本所有流程了。

寫的時(shí)候自己都覺得亂。。感覺在攪一坨屎。。。知識點(diǎn)都在腦子里,個(gè)人表達(dá)能力實(shí)在有限。 還有就是重點(diǎn)。。。我要放假啦!!! 有緣再見~


其他1:如果因?yàn)樾薷牧瞬寮鴮?dǎo)致app的build.gradle中報(bào)錯(cuò),要先注釋掉

其他1:記住,所有在插件上的更新操作,都要uploadArchives才能跑,如果你在插件中新寫的代碼有問題,而你已經(jīng)uploadArchives導(dǎo)致app的build.gradle中報(bào)錯(cuò),要先注釋掉自定義的apply plugin: 'xxx',否則即使你修改正確,sync now還是無法成功。? ? ?例如一個(gè)gradle插件中已經(jīng)有一個(gè)testTask, 當(dāng)你在另一個(gè)gradle插件中再創(chuàng)建一個(gè)testTask時(shí),第一次uploadArchives可以通過,但你再uploadArchives或者進(jìn)行功能測試時(shí)會提示你testTask在xxxgradle中已經(jīng)存在,此時(shí)如果你直接修改testtask命名再點(diǎn)sync now是無法通過的,因?yàn)榈谝淮蝩ploadArchives已經(jīng)將代碼編譯進(jìn)去了,你要先注釋掉apply plugin: 'com.jbz.boom'(不編譯這個(gè)gradle),再去修改task命名,然后uploadArchives更新編譯,最后把注釋消除,sync now。


其他2:

allprojects {

? ? afterEvaluate { project ->

? ? ? ? project.task('testTask') << {

? ? ? ? ? ? System.out.println("========================")

? ? ? ? ? ? println "Running tests for $project"

? ? ? ? ? ? System.out.println("========================")

? ? ? ? }

? ? }

}

這段代碼寫在rootproject的bulid.gradle中,當(dāng)你執(zhí)行testktask時(shí)就會打印出每個(gè)project的名稱,右側(cè)每個(gè)gradle的other下都會出現(xiàn)一個(gè)testTask表示當(dāng)前的任務(wù);寫在某個(gè)subproject下時(shí)只代表當(dāng)前gradle下的任務(wù)


還有其他一些高級點(diǎn)的比如Extension等東西,因?yàn)榇汗?jié)回家的心情已經(jīng)快要按耐不住了,在此附加幾個(gè)鏈接,我就不再重復(fù)了。。

http://www.lxweimin.com/p/d53399cd507b

http://www.lxweimin.com/p/af2b0a43133f

http://www.lxweimin.com/p/bcaf9a269d96

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,428評論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,024評論 3 413
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,285評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,548評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,328評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 54,878評論 1 321
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,971評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,098評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,616評論 1 331
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,554評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 42,725評論 1 369
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,243評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 43,971評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,361評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,613評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,339評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 47,695評論 2 370

推薦閱讀更多精彩內(nèi)容