一个WebView超时事件引发的惨案

前言

安卓客户端套用WebView展示一些用户协议与说明似乎已然变成时代的主流,大部分应用都有类似的页面。在最近一期的业务开发中,我们项目组遇到了一个这样一个奇葩的问题,在网络不稳定的情况下,前端H5页面显示过程中会频繁收到WebViewClient回调TimeOut事件,导致用户体验极差。对于此类问题,对于客户端开发,通常都是甩给Web前端去调查为何会出现TimeOut,但是本着对技术的专研精神,还是要进一步窥探一下其中的原理。

客户端超时处理

我们都知道,如果原生的WebView不做Web错误收集处理,当H5页面加载出错的时候,WebView会显示网页原生的错误信息,因为是系统原生,页面通常会比较丑陋,如图1-1所示。


一个WebView超时事件引发的惨案_第1张图片
图 1-1 WebView原生错误.png

客户端常规的解决方案是监听WebViewClient的onReceivedError回调,当有错误信息的时候将WebView进行隐藏,同时展示自己根据设计稿进行设计的网络错误布局。

            @Override
            public void onReceivedError(WebView view, WebResourceRequest request, WebResourceError error) {
                super.onReceivedError(view, request, error);
                ManualLogUtil.logMessage("onReceivedError: error = " + error);
                ManualLogUtil.logMessage("onReceivedError: " + error.getDescription() +";" + error.getErrorCode());
                manualView.showNetErrorView();

            }

此种处理方案对于常规的网络环境没有任何问题,但是在极端的网络环境下(如弱网,时断时连的网络),如果Web端存在多Tab页同时加载的情况(如图1-2所示),就会发生高频超时问题,即onReceivedError不断回调,不断的返回CODE_TIME_OUT(-8),安卓端频繁收到TimeOut将导致页面正常浏览过程中,突然切换H5页为自定义的网络异常页面。由于本文意在通过安卓端解决问题,所以暂且忽略前端切换Tab为什么会返回超时事件。


一个WebView超时事件引发的惨案_第2张图片
图1-2

主页面加载与Tab加载

我们知道安卓端的WebView其实是相当于一个浏览器,在H5也的主URL加载完成之后,其实后续的操作Web页完全可以自己完成,即H5页的第一个TAB加载后,此时断网,点击第二个TAB页,Web端是完全可以进行自己处理异常静态页面的显示,由此可见,安卓端其实只需要关心第一次主URL加载是否超时即可。

解决方案

翻看WebView的源码发现,WebView并没有提供诸如setTimeOut类的方法,网上普遍的解决方案都是自己写一个Timer进行URL加载监控。
即我们在WebView开始load的时候启动计时器,在WebViewPage第一次加载完成的时候停止并销毁计时器,如果在自定义超时时间内Page依旧没有加载完成,则触发自定义超时。

启动计时器

    /** 初始化事件 **/
    private void initEvent(){
        initWebSettings();
        timeOutPresenter = new TimeOutPresenter(manualView);
        //加载URL 启动Timer
        timeOutPresenter.startTimer();
        webView.loadUrl(ManualConstants.WEB_URL);
        setWebClient();
    }

超时任务

    /** 计时任务 **/
    class TimeOutTimerTask extends TimerTask {
        @Override
        public void run() {
            currentTime++;
            ManualLogUtil.logMessage("currentTime is : " + currentTime);
            if (currentTime > 9) {
                dealWithTimeout();
            }
        }
    }

    /** 处理页面超时事件 **/
    private void dealWithTimeout(){
        ManualLogUtil.logMessage("dealWithTimeout isPageLoaded is : " + isPageLoaded);
        if(!isPageLoaded){
            ManualLogUtil.logMessage("showNetErrorView");
            manuView.showNetErrorView();
        }
        stopTimer();
    }

终止计时器

            public void onReceivedError(WebView view, WebResourceRequest request, WebResourceError error) {
                super.onReceivedError(view, request, error);
                ManualLogUtil.logMessage("onReceivedError: error = " + error);
                ManualLogUtil.logMessage("onReceivedError: " + error.getDescription() +";" + error.getErrorCode());
                if(error.getErrorCode()!=ManualConstants.CODE_TIME_OUT){
                    manualView.showNetErrorView();
                }else {
                    manualView.showLoadingView();
                }
            }

终止计时器这里需要注意,因为我们已经有了自己的超时机制,所以这里不再需要接收onReceivedError的TimeOut事件,通过IF条件过滤即可。

简易流程

一个WebView超时事件引发的惨案_第3张图片
图1-3 简易流程

源码

GitHub 源码链接

你可能感兴趣的:(一个WebView超时事件引发的惨案)