Android 解决游戏发行切包资源索引冲突的问题

时间：2021-10-21 09:10:49|栏目：Android代码|点击：次

背景

游戏发行切包过程中，经常碰到渠道、研发、发行方，三方资源在合并过程中，资源ID冲突导致程序异常的问题，此类问题通过getIdentifier方式规避或者修改冲突资源ID的方式可以处理，但成本较高，本文旨在提出一种在切包过程中自动化处理资源冲突的解决方案

1、public.xml介绍

1、public.xml这个文件是哪来的？

该文件是apktool在反编译apk时，根据apk包中的resources.arsc文件生成。

没看过resource.arsc? (自己拖个apk到IDE看吧)

2、public.xml有什么作用

publc.xml是aapt在打包资源时用来固定资源id的，如果资源在public.xml中有对应的id了，那么打包资源时就用已经有的id。

3、public.xml中的id的格式

共四个字节32位，第一个字节代表PackgeID，第二个字节代表TypeID，后两个字节代表资源值

通常系统资源PackageID是01，而我们自己的资源PackageID是7f

TypeID，比如attr为01，string为02。但是并不固定，并不一定attr就是01。但是在public.xml中，同类型的该字节一定是一样的，否则回编译会失败。

2、R类介绍

R类这里有个知识点，library模块中生成的R类中的成员的值不是常量，不带final。app模块生成的R类的值是常量值。而常量值在java编译时会被优化，最终代码中输出的就是常量值，而不是R.id.xxx这样。而library的因为是变量，不会被优化，代码中会保留R.id.xxx

R类和public.xml的关系

从本质上讲，其实并没有啥关系。但是由于在代码中我们会使用R.id去查找资源，这就关联上了。如果都用getIdentifier的方式先获取id，那把R类删了也没事。

public.xml打包后对应的就是resources.arsc中的值，而资源值生成Java类，这个类就是R类。也就是说平时使用R类，就是用里面的索引值去到resources.arsc中找到对应资源位置，再去加载。

3、切包融合过程中R类和public.xml的处理

切包过程中，R类属于代码，采用直接覆盖的方式，但是由于我们生成的R类跟母包的R类其实值会是不同的。

下文中的cp指游戏研发方，即我们的SDK的接入方。

而public.xml是用的cp的，为什么用cp的？因为cp建立的是app工程，R类是常量值，如果我们把母包中public.xml中已有的值给改了，万一母包中用了，那就gg了

由于R类在library中使用的时候是个变量，保留了R.id.xxx这种形式，解决方法就有了，纠正R类中的值跟public.xml对应，这样就能继续愉快的使用R.id.xxx了。

我们的切包过程有几个步骤：

反编译母包（指接入我们SDK的乙方）====》合并渠道资源====》合并入新sdk的资源（跳过研发更新我们的sdk的过程哈）

1、在反编译母包的时候解析public.xml的值，存下来。

private void init() {
  List<Element> elements = mDocument.getRootElement().elements();
  for (Element element : elements) {
   String type = element.attribute(TYPE).getStringValue();
   String name = element.attribute(NAME).getStringValue();
   String id = element.attribute(ID).getStringValue();
   Map<String, String> typeMap = mTypeMap.get(type);
   if (typeMap == null) {
    typeMap = new HashMap<>();
    typeMap.put(name, id);
    mTypeMap.put(type, typeMap);
   } else {
    typeMap.put(name, id);
   }
  }
}

2、合并渠道资源的时候，将渠道资源中的public.xml（以channelPublic代指）合并到母包的public.xml(以matrixPublic代指)中

合并策略：

a、channelPublic中有，而matrixPublic中没有，增加到matrixPublic中

比如增加如下数据到matrixPublic中

<public type="attr" name="iconSrc" id="0x7f0200a8" />

如果该type在matrixPublic中已经存在：

首先要获取到attr在matrixPublic中的PackageId+TypeId。在一个public.xml文件中，同类型比如attr对应的PackageId+TypeId是不能变的，否则回编译失败。因此要添加数据时，数据的PackageId+TypeId需要纠正为matrixPublic的值。

其次资源值，不能和已有的资源值重复，正常情况下public.xml中的值是aapt生成的有序的，这里可以扫描matrixPublic中attr类型值的最大值，然后加一作为新加的iconSrc的id值

如果该type在matrixPublic中不存在（假设母包中matrixPublic中不存在attr类型）

首先要获取类型已经被占用的有哪些，即获取到matrixPublic中的TypeId，正常情况也是有序的，获取出最大的TypeId，加一作为新Type的起始值。赋值给iconSrc的id值

b、channelPublic中有，而matrixPublic中也有的，不需要处理，保留matrixPublic中的值不变

3、合并入新sdk的资源，在覆盖完R类，后开始纠正R类的值

扫描R类在PublicAndRHelper中

扫描覆盖完R类的smali代码中所有的R类，R$styleable类除外，因为styleable中保存的是一些数组的值，规则不同。

/**
  * 扫描代码中的R类
  * @return
  */
 private void scannerRClass(String path) {
  File smaliFilePath = new File(path);
  for (File file : smaliFilePath.listFiles()) {
   if (file.isDirectory()) {
    scannerRClass(file.getAbsolutePath());
   } else if(file.isFile()){
    if (file.getName().equals("R.smali") || file.getName().startsWith("R$")) {
     //此处过滤掉styleable文件
     if (!file.getName().endsWith("R$styleable.smali")) {
      mRClassFileList.add(file.getAbsolutePath());
     }
    }
   }
  }
 }

针对每一个R类调用纠正R类中方法，纠正R类值在RValueHelper类中

策略：匹配出要纠正的行，获取到type，name。在public.xml中找出对应的值，纠正。

注意这里的纠正不要用replace（oldValue,newValue）这种方式，要用替换行的方式，因为存在新值在R类中也存在后，后续替换出问题。比如a替换成b，b替换成c的情况最终R类中的a和b都被替换成了c

其次是styleable的处理，当扫描到的R是attr类型的时候，判断是否有styleable类型的存在，如果存在，则缓存下来attr中所做的纠正，用于纠正styleable。

public static void handle(String RFilePath, PublicXmlBean publicXmlBean) {
  File RFile = new File(RFilePath);
  String RStyleFilePath = "";
  Map<String, String> cacheMap = null;
  if (RFile.getName().endsWith("R$attr.smali")) {
   RStyleFilePath = RFilePath.replace("R$attr", "R$styleable");
   File RStyleAbleFile = new File(RStyleFilePath);
   //styleable存在，则把attr文件替换过的值缓存
   if (RStyleAbleFile.exists()) {
    cacheMap = new HashMap<>();
   }
  }
  String rFileContent = FileUtil.read(RFilePath);
  //找到RFile中是属性的每一行
  ArrayList<String> lines = FileUtil.readAllLines(RFilePath, ".field public static final");
  String regex = ".field public static final (.*):(.*) = (.*)";
  for (String line : lines) {
   Pattern pattern = Pattern.compile(regex);
   Matcher matcher = pattern.matcher(line);
   if (matcher.find()) {
    String type = RFile.getName().replace("R$", "").replace(".smali", "");
    String name = matcher.group(1);
    String resetValue = publicXmlBean.getValue(type, name);
    if (StringUtils.isEmpty(resetValue)) {
     resetValue = publicXmlBean.addValue(type, matcher.group(1));
    }
    //替换到文件内容中
    rFileContent = rFileContent.replace(line, ".field public static final " + name + ":" + matcher.group(2) + " = " + resetValue);
    if (cacheMap != null) {
     //换过的值缓存起来
     cacheMap.put(matcher.group(3), resetValue);
    }
   }
  }
  FileUtil.write(RFilePath, rFileContent);
  if (cacheMap != null) {
   //纠正R$styleable的值
   List<String> styleAbleLines = FileUtil.readAllLines(RStyleFilePath);
   BufferedWriter bw = null;
   try {
    bw = new BufferedWriter(new FileWriter(RStyleFilePath));
    for (String styleAbleLine : styleAbleLines) {
     for (String key : cacheMap.keySet()) {
      if (styleAbleLine.contains(key)) {
       styleAbleLine = styleAbleLine.replace(key, cacheMap.get(key));
      }
     }
     bw.write(styleAbleLine);
     bw.newLine();
    }
   } catch (IOException e) {
    e.printStackTrace();
   } finally {
    if (bw != null) {
     try {
      bw.close();
     } catch (IOException e) {
      bw = null;
     }
    }
   }
  }
 }

至此，纠正完了R类和public.xml的值