解决exagear内置容器，必须点开一次环境设置才能启动环境的问题

2022-07-23 15:02技术 exagearandroid dex exagear SharePreference

解决exagear内置容器，必须点开一次环境设置才能启动环境的问题

TIP

本文前半部分为原理，篇幅较长，可以略过，直接看解决实操部分即可

问题描述

为模拟器添加内置容器，即安装解压后，环境那一页会自动出现一个环境，可以用来制作自定义环境（比如很早之前有人就有人做过的三个内置环境分别对应三个d3d版本。但是这样做会有一个问题，就是直接点环境或者快捷方式启动会闪退，必须要进入一次环境设置（也不需要修改什么选项）。
点击添加环境手动创建的环境就没有这个问题。

出现原因

推测是在点击创建环境的时，调用了某个函数，而内置环境无需操作所以没有触发这个函数。
经hostei吧主提示，有可能是缺配置文件shared_prefs/com.eltechs.ed.CONTAINER_CONFIG_1.xml

先使用android studio查看debug状态下的报错。如图，screenInfo这个对象没有初始化，导致读取其属性的时候出错了。关键代码在StartGuest类中的413行，使用jadx反编译即可查看。
进入jadx，找到其所属的函数为private static String getWineOptions(ScreenInfo screenInfo, boolean z),说明这个screenInfo是外部传来的，再溯源到public void execute()，发现传入的screenInfo是自身的成员变量，往上翻几行，发现
```
if (this.mScreenInfo != null) {
    this.mCont.mConfig.setScreenInfo(this.mScreenInfo);
} else {
    this.mScreenInfo = this.mCont.mConfig.getScreenInfo();
}
```

getScreenInfo()所属类为com.eltechs.ed.guestContainers，进入这个类查看，发现其成员变量有一个sharepreference，正如hostei吧主所说。类内部的函数loadDefaults()则在新建容器时被调用。（新建容器调用的方法为com.eltechs.ed.guestContainers.GuestContainerConfig类下的createContainer()）

//新建容器时，创建sharePreference文件的函数
public void loadDefaults() {
    setName("Container_" + this.mCont.mId);
    setScreenInfoDefault();
    setLocaleName(Locales.getLocaleByDevice(this.mContext));
    setRunArguments("");
    setControls(Controls.getDefault());
    setHideTaskbarOnShortcut(false);
    setDefaultControlsNotShortcut(true);
    setDefaultResolutionNotShortcut(true);
    setStartupActions("");
    setRunGuide("");
    setRunGuideShown(false);
}

对比sharePreference，发现loadDefaults()就是内置环境没有调用的函数。而createContainer()中调用它之后也没什么其他的操作了。所以推测闪退原因就是缺少sharePreference文件。

<!-- SharePreference文件内部结构 -->
<?xml version='1.0' encoding='utf-8' standalone='yes' ?>
<map>
    <string name="SCREEN_SIZE">1024,768</string>
    <string name="RUN_ARGUMENTS"></string>
    <boolean name="DEFAULT_CONTROLS_NOT_SHORTCUT" value="false" />
    <boolean name="DEFAULT_RESOLUTION_NOT_SHORTCUT" value="false" />
    <string name="RUN_GUIDE"></string>
    <string name="STARTUP_ACTIONS"></string>
    <string name="CONTROLS">yuhan</string>
    <string name="SCREEN_COLOR_DEPTH">32</string>
    <string name="NAME">预设容器</string>
    <boolean name="HIDE_TASKBAR_SHORTCUT" value="false" />
    <boolean name="RUN_GUIDE_SHOWN" value="false" />
</map>

解决原理

缺失的函数为loadDefaults()，其作用为创建SharePreference文件，记录当前容器的设置信息，在创建容器时被调用。所以有两种解决方法:
- 在初次启动时调用创建环境的代码，创建环境，这样函数就会被执行。
- 自己写一个sharePref
这里选择后者。又有两种选择：
- 在代码中调用原生方法写入sharepref，
- 也可以提前写好xml文件放入apk，然后再代码中移动文件到对应目录。
~~我这里选择前者。其实感觉后者更方便修改一点，因为有时候需要自定义按键和分辨率。~~ 已经换成后者了。想看前者的解决方案请点这里。

整体思路
整体思路
- 编写java代码，测试通过后再转为smali，加入dex中
- 新建一个类，其包含一个静态方法用于移动sharePref文件，从apk中移动到对应目录，需要传入参数context。
- 在exagear主Activity里调用该方法，确保程序启动时即可执行。
- 为什么要在Activity中，而不是随便一个类中调用？因为要获取SharePref文件，所以需要用到context，而context需要从activity中获得。

使用AndroidStudio编写代码，创建类ExagearPrefs。添加setSP方法，通过传入的context，获取apk内assets/containerConfig目录下的全部sharePref文件，并将其移动到应用能识别的位置/包名/shared_prefs目录下。

点击查看代码

static public void setSP(Context ctx) {

    try {
        String[] configs = ctx.getAssets().list("containerConfig");

        if (configs.length == 0)
            throw new Exception("没有环境配置文件");

        //创建share_prefs文件夹
        File dir = new File(ctx.getApplicationInfo().dataDir + "/shared_prefs");
        if (!dir.exists()) {
            boolean b = dir.mkdir();
            assert b;
        }
        ;
        //将文件写入到存档路径中
        for (String datName : configs) {
            Log.i("getAssets().list", datName);

            InputStream is = ctx.getAssets().open("containerConfig/" + datName);      //源文件输入流
            File newFile = new File(dir.getAbsolutePath() + "/" + datName); //创建新文件

            //如果没有，创建该文件
            if (newFile.createNewFile()) {
                FileOutputStream fos = new FileOutputStream(newFile);                   //新文件输出流
                int len = -1;
                byte[] buffer = new byte[4096];
                while ((len = is.read(buffer)) != -1) {
                    fos.write(buffer, 0, len);
                }
                fos.close();
            }
            is.close();
            //Log.i("dataDirectory",getFilesDir().getAbsolutePath()); ///data/user/0/com.example.datainsert/files
        }
        Log.d("ExagearPrefs", "setSP: 现在的sp文件夹：" + Arrays.toString(dir.list()));
    } catch (Exception e) {
        e.printStackTrace();
        Log.d("Exagear", "setSP: 出错：" + e.getMessage());
    }
}

获取xml并放入apk。
获取xml：从/data/data/包名/shared_prefs目录下获取容器设置xml。命名格式应为包名.CONTAINER_CONFIG_序号.xml。包名一般对应模拟器包名，序号从1开始。
放入apk：路径为/apk/assets/containerConfig/xxx.xml。可以参考gif演示或视频演示：

解决实操

本节和解决原理后半部分大致相同，省略了解释原理的部分。

整体思路

在apk文件的/assets/containerConfig/目录下，放入内置容器的设置文件（xml格式）。只要模拟器能读取到这个文件，初次启动就不会闪退。
自己写一个函数，用于将apk里的容器设置信息xml文件移动到对应位置以供模拟器识别。直接用我写好的函数即可：传送门open in new window
在主Activity中调用这个函数

后两条需要修改dex。

总结

解决办法就是手动添加SharePreference文件。
在测试过程中，发现只要生成sharePref文件并启动一次之后，就算把sharePref删掉也一样能启动。这说明exagear读取sharePref之后又生成了其他文件，第二次往后启动都依靠这个其他文件来启动了。

更新历史

发现sharePref的文件名前半部分的包名不是固定的，需要从GuestContainerConfig那看一下
发现自定义的sharePref文件设置项好像不够全面，导致依旧闪退。
干脆重写代码，改成移动现有xml文件到对应目录下。原方法的说明移入分支页面下
想插入视频但是失败了，还是换回gif演示

解决exagear内置容器，必须点开一次环境设置才能启动环境的问题

解决exagear内置容器，必须点开一次环境设置才能启动环境的问题

问题描述

出现原因

解决原理

解决实操

总结

更新历史

ON THIS PAGE