前言
最近工作需要在項目中集成系統(tǒng)的 framework.jar，以此來調(diào)用系統(tǒng)的定制功能，但是按照之前方案配置之后發(fā)現(xiàn)無法調(diào)用 framework.jar 中的方法，默認使用的還是 Android SDK 里面的方法。
經(jīng)過一系列的排查之后終于找到解決方案，做此分享。
集成 framework.jar 方案
導入 framework.jar
首先將 framework.jar 導入項目中，以一個簡單 Demo 項目舉例，項目中有一個 app 模塊，項目結(jié)構(gòu)如下（只列出了關(guān)鍵文件）
# 項目結(jié)構(gòu)
Demo
|---- .idea
| |---- modules
| | |---- app
| | | |---- Demo.app.main.iml
|---- app
| |---- libs
| |---- src
| |---- build.gradle.kts
|---- build.gradle.kts
|---- settings.gradle.kts
- 將 framework.jar 文件復制到
Demo/app/libs路徑下； - 在
Demo/app/build.gradle.kts文件中添加依賴：
dependencies {
...
// 添加 framework.jar，僅編譯
compileOnly(files("libs/framework.jar"))
}
配置依賴優(yōu)先級
僅僅在項目中導入 framework.jar 是沒有效果的，你會發(fā)現(xiàn)之前被標記為 @hide 的接口現(xiàn)在還是不能使用，導入的 framework.jar 中的定制方法還是不能調(diào)用，與之前不同的是此時你可以調(diào)用 framework.jar 中系統(tǒng)原生不存在的類，這樣的效果當然不能讓我們滿意。
這是由于默認情況下，Android SDK 中的資源優(yōu)先級是高于手動導入的資源的，因此我們需要手動修改這個優(yōu)先級，這部分定義在項目根目錄下 .idea/modules/app/xxxx.iml 中，所以接下來需要在對應模塊的 build.gradle.kts 中添加配置。
在 Demo 項目中，我們要在 Demo/app/build.gradle.kts 中修改：
import groovy.namespace.QName
import groovy.util.Node
import groovy.xml.XmlParser
import groovy.xml.XmlUtil
import java.io.FileOutputStream
...
project.tasks.preBuild.get().doLast {
// 在 preBuild 任務執(zhí)行完之后處理
// 定義修改 .iml 文件中 Android SDK 優(yōu)先級方法
fun changeSdkOrder(path: String) {
runCatching {
val imlFile = File(path)
with(XmlParser().parse(imlFile)) {
// 從 .iml 文件中讀取 NewModuleRootManager 節(jié)點
val rootManagerComponent = getAt(QName.valueOf("component"))
.map { it as Node }
.first { it.attribute("name") == "NewModuleRootManager" }
// 從 NewModuleRootManager 節(jié)點中獲取 Android SDK 配置節(jié)點
val jdkEntry = rootManagerComponent.getAt(QName.valueOf("orderEntry"))
.map { it as Node }
.first { it.attribute("type") == "jdk" }
// 保存節(jié)點參數(shù)
val jdkName = jdkEntry.attribute("jdkName")
val jdkType = jdkEntry.attribute("jdkType")
println("> Task :${project.name}:preBuild:doLast:changedSdkOrder jdkEntry = $jdkEntry")
// 從 NewModuleRootManager 節(jié)點中移除 Android SDK 配置節(jié)點
rootManagerComponent.remove(jdkEntry)
// 重新將 Android SDK 配置節(jié)點添加到 NewModuleRootManager 的最后
rootManagerComponent.appendNode(
"orderEntry", mapOf(
"type" to "jdk",
"jdkName" to jdkName,
"jdkType" to jdkType
)
)
// 將新生成的 .iml 寫入文件
XmlUtil.serialize(this, FileOutputStream(imlFile))
}
}
}
// 修改 .iml 文件
println("> Task :${project.name}:preBuild:doLast:changedSdkOrder")
changeSdkOrder(rootDir.absolutePath + "/.idea/modules/app/Demo.app.main.iml")
}
方法 changeSdkOrder 的參數(shù)為模塊對應的 .iml 配置文件路徑，可按照自己的項目配置，按需修改。
如此一來，在項目中就可以盡情的使用 framework.jar 中的方法了。
配置引導類路徑
經(jīng)歷了上面兩個步驟的配置，在開發(fā)過程中已經(jīng)可以正常使用 framework.jar 中的內(nèi)容的，在本地 Android Studio 中也能正常編譯運行，但是如果你們公司配置在服務器編譯構(gòu)建就還是會報錯，那就需要在項目根目錄的 build.gradle.kts 中添加相關(guān)配置。
在 Demo 項目中，我們要在 Demo/build.gradle.kts 中修改：
...
allprojects {
beforeEvaluate {
// framework.jar 路徑
val path = rootDir.absolutePath + "/app/libs/framework.jar"
tasks.withType<JavaCompile> {
// 低版本 gradle 的方案
options.compilerArgs.add("-Xbootclasspath/p:$path")
// 高版本 gradle 的方案
val newFileList = mutableListOf<File>()
newFileList.add(File(path))
options.bootstrapClasspath?.files?.let { oldFileList ->
newFileList.addAll(oldFileList)
}
options.bootstrapClasspath = files(*newFileList.toTypedArray())
}
}
}
通過上面的配置，我們將 framework.jar 添加到引導類路徑中，無論是在本地還是在服務器構(gòu)建，就都不會出現(xiàn)問題了。
高版本 Android Studio 適配
講了這么多，終于到了我們這篇文章的重點，就是高版本 Android Stuido （這里特指 3.6.3之后的版本）的適配。
作者這邊使用的 Android Studio 版本是 Iguana，按照上面的步驟配置完之后發(fā)現(xiàn)并沒有起作用，具體現(xiàn)象就是導入的 framework.jar 中的定制方法不能調(diào)用，只可以調(diào)用 framework.jar 中系統(tǒng)原生不存在的類，那不就是 依賴優(yōu)先級 的配置失效了嗎，打開 Demo/.idea/modules/app/Demo.app.main.iml 文件，發(fā)現(xiàn)里面只剩簡單的幾行配置，依賴優(yōu)先級 相關(guān)的幾個節(jié)點都沒有了，那該怎么配置？
經(jīng)過多次 Google、百度、Bing 無果，能找到的都是已知的配置，最終找到了 Android Studio 中的一個配置項，路徑在 File -> Settings -> Build, Execution, Deployment -> Build Tools -> Gradle 中，有一個 Generate *.iml files for modules imported from Gradle，把這個選項勾選上，restart Android Studio，.iml 文件中的配置就恢復了。
經(jīng)過多個版本的多次嘗試，最終發(fā)現(xiàn)：在 Android Studio 3.6.3 版本及以前，Generate *.iml files for modules imported from Gradle 選項默認是勾選上的，而在 3.6.3 之后的版本，該選項默認是沒有勾選的。經(jīng)歷了九九八十一難，終于解決了這個奇葩的問題，感謝各位的觀看！
文章作者: WangJie0822
文章鏈接: http://www.wangjie0822.top/posts/d0b7d4e2
版權(quán)聲明: 本博客所有文章除特別聲明外，均采用 CC BY-NC-SA 4.0 許可協(xié)議。轉(zhuǎn)載請注明來自 WangJie0822！
