Java用 Gradle配置compile及implementation和api的區別

Posted on by

前言：

這個主要看Java項目所使用的Gradle的版本。

Gradle 3.4 新增瞭Java-library插件，java-library插件使用瞭新的依賴配置implementation和api。舊的依賴配置compile被廢棄。

Gradle 3.4 之前的版本

java插件：

apply plugin: 'java'

添加依賴：

dependencies {
compile 'commons-httpclient:commons-httpclient:3.1'
compile 'org.apache.commons:commons-lang3:3.5'
}

Gradle 3.4+

使用java-library插件替換java插件

apply plugin: 'java-library'

新的依賴配置：implementation和api

dependencies {
api 'commons-httpclient:commons-httpclient:3.1'
implementation 'org.apache.commons:commons-lang3:3.5'
}

api和implementation兩種依賴的不同點在於：它們聲明的依賴其他模塊是否能使用。

api：當其他模塊依賴於此模塊時，此模塊使用api聲明的依賴包是可以被其他模塊使用。

implementation：當其他模塊依賴此模塊時，此模塊使用implementation聲明的依賴包隻限於模塊內部使用，不允許其他模塊使用。

api： 跟 2.x 版本的 compile完全相同

implementation：使用瞭該命令編譯的依賴，它僅僅對當前的Module提供接口。例如我們當前項目結構如下

LibraryA 中引用瞭 LibraryC 的庫，如果對 LibraryC 的依賴用的是 implementation 關鍵字。 如下：

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

那麼LibraryC 中的接口，僅僅隻能給 LibraryA 使用，而我們的 App Module 是無法訪問到 LibraryC 提供的接口的，也就是將該依賴隱藏在內部，而不對外部公開。這就是implementation關鍵字的作用。

最佳實踐建議

在Google IO 相關話題的中提到瞭一個建議，就是依賴首先應該設置為implement的，如果沒有錯，那就用implement，如果有錯，那麼使用api指令，這樣會使編譯速度有所增快。

那為什麼要這麼做呢？

答案是： 1. 加快編譯速度。2. 隱藏對外不必要的接口。

為什麼能加快編譯速度呢？

這對於大型項目含有多個Module模塊的， 以上圖為例，比如我們改動 LibraryC 接口的相關代碼，這時候編譯隻需要單獨編譯LibraryA模塊就行， 如果使用的是api或者舊時代的compile，由於App Module 也可以訪問到 LibraryC,所以 App Module部分也需要重新編譯。當然這是在全編的情況下。

版本依賴關鍵字詳解(2.0與3.0所有關鍵字)

compile(api)

這種是我們最常用的方式，使用該方式依賴的庫將會參與編譯和打包。
當我們依賴一些第三方的庫時，可能會遇到com.android.support沖突的問題，就是因為開發者使用的compile依賴的com.android.support包，而他所依賴的包與我們本地所依賴的com.android.support包版本不一樣，所以就會報All com.android.support libraries must use the exact same version specification (mixing versions can lead to runtime crashes這個錯誤。

provided(compileOnly)

隻在編譯時有效，不會參與打包
可以在自己的module中使用該方式依賴一些比如com.android.support，gson這些使用者常用的庫，避免沖突。

apk(runtimeOnly)

隻在生成apk的時候參與打包，編譯時不會參與，很少用。

testCompile(testImplementation)

testCompile 隻在單元測試代碼的編譯以及最終打包測試apk時有效。

debugCompile(debugImplementation)

debugCompile 隻在 debug 模式的編譯和最終的 debug apk 打包時有效

releaseCompile(releaseImplementation)

Release compile僅僅針對 Release 模式的編譯和最終的 Release apk 打包。

到此這篇關於Java用 Gradle配置compile及implementation和api的區別的文章就介紹到這瞭,更多相關Java 配置compile 內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：