插件化-解决插件资源ID与宿主资源ID冲突的问题
为何会冲突？为何要解决资源id冲突？
首先宿主apk和插件apk是两个不一样的apk，他们在编译时都会产生本身的resources.arsc。即他们是两个独立的编译过程。那么它们的resources.arsc中的资源id一定是有相同的状况。这就会出现问题了:java
咱们前面已经了解过，宿主在加载插件的资源的时候实际上是新new了一个Resources，这个新的Resources是包含宿主和插件的资源的。因此一个Resources中就出现了资源id重复的状况，这样在运行的时候使用资源id来获取资源就会报错。android
怎么解决呢？
目前一共有两种思路:git
- 修改aapt源码，定制aapt工具，编译期间修改PP段。(PP字段是资源id的第一个字节，表示包空间)
DynamicAPK的作法就是如此，定制aapt，替换google的原始aapt，在编译的时候能够传入参数修改PP段：例如传入0x05编译获得的资源的PP段就是0x05。对于具体实现能够参考这篇博客Android中如何修改编译的资源ID值github
- 修改aapt的产物，即，编译后期从新整理插件Apk的资源，编排ID。
VirtualApk采用的就是这个方案。本文就大体看一下这个方案的实现。app
VirtualApk的解决方案
大致实现思路:自定义gradle transform 插件，在apk资源编译任务完成后，从新设置插件的resources.arsc文件中的资源id,并更新R.java文件工具
好比，你在编译插件apk时设置了:学习
apply plugin: 'com.didi.virtualapk.plugin'
virtualApk {
packageId = 0x6f //插件资源ID的PP字段
targetHost = '../VirtualApk/app' // 宿主的目录
applyHostMapping = true
}
在运行编译插件apk的任务后，产生的插件的资源id的PP字段都是0x6f。gradle
VirtualApkhook了ProcessAndroidResourcestask。这个task是用来编译Android资源的。VirtualApk拿到这个task的输出结果，作了如下处理:ui
-
根据编译产生的
R.txt文件收集插件中全部的资源google -
根据编译产生的
R.txt文件收集宿主apk中的全部资源 -
过滤插件资源:过滤掉在宿主中已经存在的资源
-
从新设置插件资源的资源ID
-
删除掉插件资源目录下前面已经被过滤掉的资源
-
从新编排插件
resources.arsc文件中插件资源ID为新设置的资源ID -
从新产生R.java文件
下面呢咱们就来看下具体代码。这块水很深。因此下面的代码就当伪代码看一下就好，咱们的主要目的是理解大体的实现思路。
粗略浏览具体实现代码
根据R.txt文件收集插件中全部的资源
R.txt文件是在编译资源过程当中产生的资源ID记录文件，在build/intermediates/symbols/xx/xx/R.txt能够找到这个问题，它的格式以下:
int anim abc_fade_in 0x7f010000 int anim abc_fade_out 0x7f010001 .....
看一下具体代码:
private void parseResEntries(File RSymbolFile, ListMultimap allResources, List styleableList) {
RSymbolFile.eachLine { line ->
/**
* Line Content:
* Common Res: int string abc_action_bar_home_description 0x7f090000
* Styleable: int[] styleable TagLayout { 0x010100af, 0x7f0102b5, 0x7f0102b6 }
* or int styleable TagLayout_android_gravity 0
*/
if (!line.empty) {
def tokenizer = new StringTokenizer(line)
def valueType = tokenizer.nextToken() // value type (int or int[])
def resType = tokenizer.nextToken() // resource type (attr/string/color etc.)
def resName = tokenizer.nextToken()
def resId = tokenizer.nextToken('\r\n').trim()
if (resType == 'styleable') {
styleableList.add(new StyleableEntry(resName, resId, valueType))
} else {
allResources.put(resType, new ResourceEntry(resType, resName, Integer.decode(resId)))
}
}
}
}
即收集全部资源:资源名称、资源ID、资源类型等。而后保存在集合中:allResources和styleableList
根据编译产生的R.txt文件收集宿主apk中的全部资源
和第一步相同
过滤插件资源:过滤掉在宿主中已经存在的资源
private void filterPluginResources() {
allResources.values().each { // allResources 就是前面解析出来的插件的全部资源
def index = hostResources.get(it.resourceType).indexOf(it)
if(index >= 0){ //插件的资源在宿主中存在
it.newResourceId = hostResources.get(it.resourceType).get(index).resourceId //把这个同样的插件资源的id设置成宿主的id
hostResources.get(it.resourceType).set(index, it) //在宿主中更新这个资源
} else { //插件的资源在宿主中不存在
pluginResources.put(it.resourceType, it)
}
}
allStyleables.each {
def index = hostStyleables.indexOf(it)
if(index >= 0) {
it.value = hostStyleables.get(index).value
hostStyleables.set(index, it)
} else {
pluginStyleables.add(it)
}
}
}
即通过上面的操做，pluginResources只含有插件的资源。这份资源和宿主的资源集合没有交集，即没有相同的资源。
从新设置插件的资源ID
这一步就是核心了，逻辑很简单，即基于自定义的PP字段的值，修改上面已经收集好的pluginResources中资源的资源ID:
private void reassignPluginResourceId() {
//先根据 typeId 把前面收集到的资源排序
def resourceIdList = []
pluginResources.keySet().each { String resType ->
List<ResourceEntry> entryList = pluginResources.get(resType)
resourceIdList.add([resType: resType, typeId: entryList.empty ? -100 : parseTypeIdFromResId(entryList.first().resourceId)])
}
resourceIdList.sort { t1, t2 ->
t1.typeId - t2.typeId
}
//从新设置插件的资源id
int lastType = 1
resourceIdList.each {
if (it.typeId < 0) {
return
}
def typeId = 0
def entryId = 0
typeId = lastType++
pluginResources.get(it.resType).each {
it.setNewResourceId(virtualApk.packageId, typeId, entryId++) // virtualApk.packageId 即咱们在gradle中自定义的 packageId
}
}
List<ResourceEntry> attrEntries = allResources.get('attr')
pluginStyleables.findAll { it.valueType == 'int[]'}.each { StyleableEntry styleableEntry->
List<String> values = styleableEntry.valueAsList
values.eachWithIndex { hexResId, idx ->
ResourceEntry resEntry = attrEntries.find { it.hexResourceId == hexResId }
if (resEntry != null) {
values[idx] = resEntry.hexNewResourceId
}
}
styleableEntry.value = values
}
}
ok，通过上面的处理，pluginResources中的资源的资源id都是从新设置的新的资源Id。
删除掉插件资源目录下前面已经被过滤掉的资源
咱们前面通过和宿主的资源对比后，可能已经删除了插件中的一些资源id，可是对应的文件尚未删除，所以须要把文件也删除掉:
void filterResources(final List<?> retainedTypes, final Set<String> outFilteredResources) {
def resDir = new File(assetDir, 'res') //遍历插件的资源目录
resDir.listFiles().each { typeDir ->
def type = retainedTypes.find { typeDir.name.startsWith(it.name) }
if (type == null) { //插件过滤后的资源已经不含有这个目录了，直接删除掉
typeDir.listFiles().each {
outFilteredResources.add("res/$typeDir.name/$it.name")
}
typeDir.deleteDir()
return //这个return 是跳过此次循环
}
def entryFiles = typeDir.listFiles()
def retainedEntryCount = entryFiles.size()
entryFiles.each { entryFile ->
def entry = type.entries.find { entryFile.name.startsWith("${it.name}.") }
if (entry == null) { //逻辑同上
outFilteredResources.add("res/$typeDir.name/$entryFile.name")
entryFile.delete()
retainedEntryCount--
}
}
if (retainedEntryCount == 0) {
typeDir.deleteDir()
}
}
}
从新编排插件resources.arsc文件中插件资源ID为新设置的资源ID
这个代码就不列了，感兴趣能够查看VirtualApk源代码 : ArscEditor.slice()
从新产生R.java文件
public static void generateRJava(File dest, String pkg, ListMultimap<String, ResourceEntry> resources, List<StyleableEntry> styleables) {
if (!dest.parentFile.exists()) {
dest.parentFile.mkdirs()
}
if (!dest.exists()) {
dest.createNewFile()
}
dest.withPrintWriter { pw ->
pw.println "package ${pkg};"
pw.println "public final class R {"
resources.keySet().each { type ->
pw.println " public static final class ${type} {"
resources.get(type).each { entry ->
pw.println " public static final int ${entry.resourceName} = ${entry.hexNewResourceId};"
}
pw.println " }"
}
pw.println " public static final class styleable {"
styleables.each { styleable ->
pw.println " public static final ${styleable.valueType} ${styleable.name} = ${styleable.value};"
}
pw.println " }"
pw.println "}"
}
}
