在Android中预加载React Native jsBundle

前段时间在项目中遇到了一个问题:从原生模块跳转到RN模块时会有一段短暂的白屏时间,特别是在低端手机更加明显。在网上搜了一圈,发现这个问题非常常见。

ReactRootView mReactRootView = createRootView();
mReactRootView.startReactApplication(mReactInstanceManager, getMainComponentName(), getLaunchOptions());

这两行代码就是白屏的主要原因。因为这两行代码把jsbundle文件读入到内存中,这个过程肯定是需要耗费一些时间的,当jsbundle文件越大,可以预见加载到内存中需要的时间就越长。
解决办法就是以空间换时间,在app启动时候,就将ReactRootView初始化出来,并缓存起来,在用的时候从缓存获取ReactRootView使用,达到秒开。
目前的React Native版本更新到了0.45.1,而网上大部分的解决方案都偏旧,但是解决思路还是一样的,不过具体的解决方法会做些修改(因为RN源码的变动)。
下面会详细说明。

1. 创建ReactRootView缓存管理器

public class RNCacheViewManager {
    public static final int REQUEST_OVERLAY_PERMISSION_CODE = 1111;
    public static final String REDBOX_PERMISSION_MESSAGE =
            "Overlay permissions needs to be granted in order for react native apps to run in dev mode";
    private static ReactRootView mRootView = null;

    public static ReactRootView getRootView() {
        if (mRootView == null) {
            throw new RuntimeException("缓存view管理器尚未初始化!");
        }
        return mRootView;
    }


    public static ReactNativeHost getReactNativeHost(Activity activity) {
        return ((ReactApplication) activity.getApplication()).getReactNativeHost();
    }

    public static void init(Activity act, String moduleName, Bundle lauchOptions) {
        boolean needsOverlayPermission = false;
        if (mRootView != null) {
            return;
        }
        if (BuildConfig.DEBUG && Build.VERSION.SDK_INT >= Build.VERSION_CODES.M && !Settings.canDrawOverlays(act)) {
            needsOverlayPermission = true;
            Intent serviceIntent = new Intent(Settings.ACTION_MANAGE_OVERLAY_PERMISSION, Uri.parse("package:" + act.getPackageName()));
            FLog.w(ReactConstants.TAG, REDBOX_PERMISSION_MESSAGE);
            Toast.makeText(act, REDBOX_PERMISSION_MESSAGE, Toast.LENGTH_LONG).show();
            act.startActivityForResult(serviceIntent, REQUEST_OVERLAY_PERMISSION_CODE);
        }
        if (!needsOverlayPermission) {
            mRootView = new ReactRootView(act);
            mRootView.startReactApplication(
                    getReactNativeHost(act).getReactInstanceManager(),
                    moduleName,
                    lauchOptions);
        }
    }

    /**
     * 不能再调用原有的销毁方法,否则rn初始化出来的对象会被销毁,同时
     * 在ReactActivity销毁后,我们需要把 view从父视图中移除。
     */
    public static void onDestroy() {
        try {
            ViewParent parent = getRootView().getParent();
            if (parent != null)
                ((android.view.ViewGroup) parent).removeView(getRootView());
        } catch (Throwable e) {
            e.printStackTrace();
        }
    }

}

2. 继承ReactActivity和ReactActivityDelegate做相应修改

第二步就是与之前不太一样的地方,因为现在ReactActivity的主要逻辑基本都由ReactActivityDelegate代理实现,所以所做的修改就有所不同,只需要实现自己的代理并在自己的ReactActivity覆盖createReactActivityDelegate即可。

继承ReactActivityDelegate

这里直接继承ReactActivityDelegate并复写onCreate方法loadApp方法,以及onDestroy方法。

public class CCCReactActivityDelegate extends ReactActivityDelegate {
    private Activity mActivity;

    public CCCReactActivityDelegate(Activity activity, @Nullable String mainComponentName) {
        super(activity, mainComponentName);
        mActivity = activity;
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        Class<ReactActivityDelegate> clazz=ReactActivityDelegate.class;
        try {
            Field field=clazz.getDeclaredField("mDoubleTapReloadRecognizer");
            field.setAccessible(true);
            field.set(this, new DoubleTapReloadRecognizer());
        } catch (Exception e) {
            e.printStackTrace();
        }
        if (BuildConfig.DEBUG && Build.VERSION.SDK_INT >= Build.VERSION_CODES.M&&!Settings.canDrawOverlays(mActivity)) {
            TextView textView=new TextView(mActivity);
            textView.setLayoutParams(new LinearLayout.LayoutParams(LinearLayout.LayoutParams.WRAP_CONTENT,LinearLayout.LayoutParams.WRAP_CONTENT));
            textView.setText(RNCacheViewManager.REDBOX_PERMISSION_MESSAGE+"\nPlease exit the app and grant again");
            textView.setTextColor(Color.rgb(255, 0, 0));
            mActivity.setContentView(textView);
        }else{
            loadApp(null);
        }
    }

    @Override
    protected void onDestroy() {
        RNCacheViewManager.onDestroy();
        super.onDestroy();
    }

    @Override
    protected void loadApp(String appKey) {
        ReactRootView mReactRootView = RNCacheViewManager.getRootView();
        ViewParent viewParent = mReactRootView.getParent();
        if (viewParent != null) {
            ViewGroup vp = (ViewGroup) viewParent;
            vp.removeView(mReactRootView);
        }
        mActivity.setContentView(mReactRootView);
    }
}

重点关注onCreate方法与loadApp以及onDestroy方法。onCreate方法中调用了loadApp方法,因为此时不需要appkey(appkey在缓存管理器初始化的时候就使用了)所以直接传空即可.onDestroy使用RNCacheViewManager.onDestroy()来移除ReactRootView。

继承ReactActivity并覆盖代理创建方法

public  class CCCReactActivity extends ReactActivity  {
    @Override
    protected ReactActivityDelegate createReactActivityDelegate() {
        return new CCCReactActivityDelegate(this,null);
    }
}

重写ReactActivity的地方很少,即是替换掉原来的ReactActivityDelegate。

3. 创建React Native对应的Activity

在这里可以像之前继承ReactActivit那样创建自己的Activity(继承CCCReactActivity),覆盖自己需要的方法,也可以直接使用CCCReactActivity。

4. 在App第一个Activity启动时候初始化ReactRootView缓存管理器

RNCacheViewManager.init(this, "这里填写模块名", null);

需要注意的是:
第三个参数可以设置传递给RN的属性(Bundle封装类型),如有需要才传值,否则传空即可。
如果应用只有一个Activity,加载RN还是比较难避免白屏(因为可能会打开这个Activity立即跳转RN页面,此时JsBundle还未完全加载到内存)。因此最好有个启动界面。

5.对比测试

在三星SM-G3609手机(运存768M)上做了几次测试,打包后的jsBundle大小:522KB
无预加载的情况下,从原生模块打开RN页面平均耗时1769 ms
有预加载的情况下,从原生模块打开RN页面平均耗时160ms
效果非常明显!
从用户体验来说,打开页面如果有1 2秒白屏这简直不能忍,而通过预加载可以达到几乎是秒开的体验,所以为什么不用呢?

6.关于targetSdkVersion 23以上的SYSTEM_ALERT_WINDOW权限问题(7.5更新)

如果工程是在调试模式并且targetSdkVersion在23以上,打开应用就会报如下错误:

 android.view.WindowManager$BadTokenException: Unable to add window android.view.ViewRootImpl$W@dac42 -- permission denied for this window type

在调试模式并且targetSdkVersion在23以上的工程中,如果未授权就去执行startReactApplication就会报BadTokenException错误。因此我们需要对启动React Native加一些必要的条件判断。

        boolean needsOverlayPermission = false;
        if (mRootView != null) {
            return;
        }
        if (BuildConfig.DEBUG && Build.VERSION.SDK_INT >= Build.VERSION_CODES.M && !Settings.canDrawOverlays(act)) {
            needsOverlayPermission = true;
            Intent serviceIntent = new Intent(Settings.ACTION_MANAGE_OVERLAY_PERMISSION, Uri.parse("package:" + act.getPackageName()));
            FLog.w(ReactConstants.TAG, REDBOX_PERMISSION_MESSAGE);
            Toast.makeText(act, REDBOX_PERMISSION_MESSAGE, Toast.LENGTH_LONG).show();
            act.startActivityForResult(serviceIntent, REQUEST_OVERLAY_PERMISSION_CODE);
        }
        if (!needsOverlayPermission) {
            mRootView = new ReactRootView(act);
            mRootView.startReactApplication(
                    getReactNativeHost(act).getReactInstanceManager(),
                    moduleName,
                    lauchOptions);
        }

官方做法是打开React Native承载的Activity才去申请权限以及接收权限是否授予都在同一个Activity中处理,而预加载方法则是在应用可能会在启动时就开始申请权限,因此也建议在申请所在的Activity接收权限是否授予回调,否则即使授予了权限也不会去执行startReactApplication方法了,此时只能杀死应用重新打开才能加载RN了。
如果条件允许则在申请所在的Activity接收权限是否授予回调,即覆盖onActivityResult方法,如果被授权则会开始加载React Native,具体代码如下:

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
        if (requestCode == REQUEST_OVERLAY_PERMISSION_CODE && Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
            if (Settings.canDrawOverlays(this)) {
                RNCacheViewManager.getRootView().startReactApplication(
                        RNCacheViewManager.getReactNativeHost(this).getReactInstanceManager(),
                        MODULE_NAME,
                        null);
            }
        }
    }

而如果是在SplashActivtiy中加载RN,因为SplashActivtiy会自动关闭,等到授权完成了可能Activity已经不在了,此时
onActivityResult也不会起作用了,这时候只能授权并杀死应用重新启动了。

7.局限性

如果在init时没有需要传递的属性(lauchOptions),init方法当然是早一点调用比较好,例如App启动时就调用该方法,
如果需要传递属性(lauchOptions),而lauchOptions需要比较迟才能获取到,就只能在RN页面打开加载之前去init了(强烈不建议这种做法,预加载几乎无作用)。因此建议lauchOptions最好只传递尽可能早明确的属性,例如一些appkey配置等。而如果需要通过传递属性来动态选择RN加载的页面,这种多入口的方式就不合适选择预加载,此时更推荐选择多注册的方式来实现多入口。
此外,以上实现方式只针对Activity中加载RN,如果需要在Fragment中加载则需要选择另外一种实现,下回分解。

项目源码:RNPreloadBundle

运行方法:

  1. 在项目根目录下使用npm i安装node_modules依赖
  2. 在项目根目录下使用react-native start 命令启动react-native服务器
  3. 运行项目安装应用

参考文章:
ReactNative安卓首屏白屏优化

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,816评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,729评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,300评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,780评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,890评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,084评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,151评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,912评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,355评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,666评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,809评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,504评论 4 334
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,150评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,882评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,121评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,628评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,724评论 2 351

推荐阅读更多精彩内容