Android Gradle 插件3.0開(kāi)始Implementation與Api的愛(ài)恨情仇

本文翻譯于 Bedanta Bikash Borah 的文章皮璧,原文鏈接如下:

Implementation Vs Api in Android Gradle plugin 3.0

Android gradle插件

當(dāng)我們?cè)贏ndroid項(xiàng)目中使用 Gradle 3.0 及以上版本的插件,你一定會(huì)注意到 compile 關(guān)鍵字已經(jīng)被棄用來(lái)支持 implementationapi诉稍。讓我們借助一個(gè)例子來(lái)了解它們。

示例應(yīng)用 (Kotlin) 可以在這里找到界睁。

讓我們假設(shè)有一個(gè) Android 項(xiàng)目包含以下四個(gè) library module:

  • LibraryA
  • LibraryB
  • LibraryC
  • LibraryD

它們之間的依賴關(guān)系如下所示:

library依賴關(guān)系圖

每個(gè) Library module 都包含一個(gè)簡(jiǎn)單的類球昨。

LibraryD:

class ClassD {

    fun tellMeAJoke():String{
        return "You are funny :D"
    }
}

LibraryC:

class ClassC {
    fun tellMeAJoke(): String {
        return "You are funny :C"
    }
}

LibraryB:

class ClassB {

    val b = ClassD()

    fun whereIsMyJoke(): String {
        return b.tellMeAJoke()
    }
}

LibraryA:

class ClassA {

    val c = ClassC()

    fun whereIsMyJoke(): String {
        return c.tellMeAJoke()
    }
}

從上面這些類文件中可以看到 LibraryA 和 LibraryB 分別依賴于 LibraryC 和 LibraryD辕近。因此封孙,需要將它們之間的依賴關(guān)系添加到 build.gradle 文件當(dāng)中迹冤。

Compile (2.0) or Api (3.0):

3.0 中新的 api 關(guān)鍵字與之前版本的 compile 關(guān)鍵字意義完全相同。因此虎忌,如果項(xiàng)目中所有 compile 關(guān)鍵字被 api 所取代泡徙,這完全可以正常工作。現(xiàn)在膜蠢,讓我們?cè)?LibraryB 中通過(guò) api 關(guān)鍵字來(lái)依賴 LibraryD

dependencies {
          . . . . 
          api project(path: ':libraryD')
}

同樣地堪藐,將 LibraryB 添加到 app 模塊中:

dependencies {
          . . . . 
          api project(path: ':libraryB')
}

現(xiàn)在,我們可以在 app 模塊中訪問(wèn)到 LibraryBLibraryD挑围。在示例應(yīng)用中礁竞,兩個(gè)庫(kù)的訪問(wèn)形式如下:

app模塊中訪問(wèn)LibraryB和libraryD

Implementation (3.0):

現(xiàn)在是時(shí)候來(lái)找出 implementationapi 之間的不同之處了。再次回到上面這個(gè)例子杉辙,現(xiàn)在讓我們?cè)?LibraryA 中通過(guò) implementation 關(guān)鍵字引入 LibraryC

dependencies {
          . . . . 
          implementation project(path: ':libraryC')
}

App 模塊同理:

dependencies {
          . . . . 
          implementation project(path: ':libraryA')
}

現(xiàn)在模捂,如果我們?cè)?app 模塊訪問(wèn) LibraryC,Android studio 將會(huì)拋出一個(gè)錯(cuò)誤:

訪問(wèn)提示錯(cuò)誤信息

這意味著如果我們使用 implementation 關(guān)鍵字代替 api蜘矢,LibraryC 將無(wú)法在 App 模塊中被訪問(wèn)狂男。那么 implementation 這樣做有什么好處呢?

Implementation vs api:

在第一個(gè)場(chǎng)景中品腹,LibraryD 是通過(guò) api 關(guān)鍵字來(lái)編譯的岖食。一旦 LibraryD 中的實(shí)現(xiàn)做了任何改動(dòng),那么 gradle 都需要重新編譯 LibraryD珍昨,LibraryB 和所有其他引入 LibraryB 的模塊一樣可能使用的是 LibraryD 中的實(shí)現(xiàn)县耽。

api編譯范圍圖

但在第二個(gè)場(chǎng)景中,如果更改了 LibraryC 中的代碼實(shí)現(xiàn)镣典,那么 Gradle 只會(huì)重新編譯 LibraryCLibraryA,因?yàn)槠渌魏螞](méi)有直接依賴 LibraryC 的類都無(wú)法使用其中任何實(shí)現(xiàn)唾琼。

implementation編譯范圍圖

如果你正在開(kāi)發(fā)具有多個(gè)模塊的項(xiàng)目兄春,那么這種策略可以顯著加快構(gòu)建過(guò)程。我在示例程序中進(jìn)行了嘗試锡溯,幾秒鐘后就有了一些改進(jìn)赶舆。以下是所有方案的構(gòu)建報(bào)告。

全量構(gòu)建:

全量編譯構(gòu)建結(jié)果

變更 LibraryD:

libraryD變更后構(gòu)建結(jié)果

變更 libraryC

libraryC變更后構(gòu)建結(jié)果

總結(jié)

Android Gradle 插件版本升級(jí)至3.0之后祭饭,我們只需要將所有 compile 替換為 implementation 關(guān)鍵字并嘗試構(gòu)建項(xiàng)目芜茵。如果可以構(gòu)建成功,那么很好倡蝙。否則九串,請(qǐng)查找任何你可能正在使用的遺漏的依賴庫(kù),并找到宿主 library 換用 api 關(guān)鍵字引入這些 library。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末猪钮,一起剝皮案震驚了整個(gè)濱河市品山,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌烤低,老刑警劉巖肘交,帶你破解...
    沈念sama閱讀 219,039評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異扑馁,居然都是意外死亡涯呻,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,426評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén)腻要,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)魄懂,“玉大人,你說(shuō)我怎么就攤上這事闯第∈欣酰” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 165,417評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵咳短,是天一觀的道長(zhǎng)填帽。 經(jīng)常有香客問(wèn)我,道長(zhǎng)咙好,這世上最難降的妖魔是什么篡腌? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,868評(píng)論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮勾效,結(jié)果婚禮上嘹悼,老公的妹妹穿的比我還像新娘。我一直安慰自己层宫,他們只是感情好杨伙,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,892評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著萌腿,像睡著了一般限匣。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上毁菱,一...
    開(kāi)封第一講書(shū)人閱讀 51,692評(píng)論 1 305
  • 那天米死,我揣著相機(jī)與錄音,去河邊找鬼贮庞。 笑死峦筒,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的窗慎。 我是一名探鬼主播物喷,決...
    沈念sama閱讀 40,416評(píng)論 3 419
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了脯丝?” 一聲冷哼從身側(cè)響起商膊,我...
    開(kāi)封第一講書(shū)人閱讀 39,326評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎宠进,沒(méi)想到半個(gè)月后晕拆,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,782評(píng)論 1 316
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡材蹬,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,957評(píng)論 3 337
  • 正文 我和宋清朗相戀三年实幕,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片堤器。...
    茶點(diǎn)故事閱讀 40,102評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡昆庇,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出闸溃,到底是詐尸還是另有隱情整吆,我是刑警寧澤,帶...
    沈念sama閱讀 35,790評(píng)論 5 346
  • 正文 年R本政府宣布辉川,位于F島的核電站表蝙,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏乓旗。R本人自食惡果不足惜府蛇,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,442評(píng)論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望屿愚。 院中可真熱鬧汇跨,春花似錦、人聲如沸妆距。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,996評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)毅厚。三九已至塞颁,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間吸耿,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,113評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工酷窥, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留咽安,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,332評(píng)論 3 373
  • 正文 我出身青樓蓬推,卻偏偏與公主長(zhǎng)得像妆棒,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,044評(píng)論 2 355