Flutter WebView 总结

目录

  • 前言
  • webview_flutter 官方组件
  • flutter_webview 社区组件
  • JS调用Flutter
  • Flutter调用JS

前言


说到跨平台开发,就不得不提 WebView,WebView 可以说是最廉价的跨平台开发方案。在flutter如果需要使用 WebView,目前有两种优秀的WebView插件。

webview_flutter 官方组件


 它是Flutter团队开发的,在iOS中底层调用的是WKWebView,在Android中底层调用的是WebView。特性是基于原生和 Flutter SDK 封装,继承 StatefulWidget,因此支持内嵌于 flutter Widget 树中,这是比较灵活的。

集成方式很简单,在 pubspec.yaml 文件中:

  # WebView flutter plugin (Official)
  webview_flutter: ^0.3.19+5

在2018年 Flutter 发展初期,官方的 webview_flutter 插件有很多问题,不过好在官方一直没有放弃,现在的插件已经修复了很多 bug 了,基本功能也在不断完善中。

组件的使用

开始之前先简单了解一下官方WebView所包含的API:

  • onWebViewCreated:在WebView创建完成后调用,只会被调用一次;
  • initialUrl:初始load的url;
  • javascriptMode:JS执行模式(是否允许JS执行);
  • javascriptChannels:JS和Flutter通信的Channel;
  • navigationDelegate:路由委托(可以通过在此处拦截url实现JS调用Flutter部分);
  • gestureRecognizers:手势监听;
  • onPageStarted: WebView开始加载时回调。
  • onPageFinished:WebView加载完毕时的回调。

一些坑

  1. 闪黑屏:第一次打开WebView会有时候会出现黑屏,可以使用一个闪屏页面覆盖。
  2. Bug:给Android release包加固后,当改变 App 生命周期时,WebView出现不能正常显示的Bug。该问题的原因不明,可以确定的是加固造成的后果。

flutter_webview 社区组件


当时 flutter 官方是没有 WebView 组件的,不过强大的 flutter-community 论坛考虑到广大开发者的需求,开发了 flutter_webview_plugin 插件,方便在 flutter 中使用使用 WebView。

集成方式很简单,在 pubspec.yaml 文件中:

  # Flutter WebView plugin (Community)
  flutter_webview_plugin: ^0.3.10+1

在实际使用中,由于 flutter_webview_plugin 并不存在于 widget 树中,所以不能在 flutter_webview_plugin 中使用如 snackbars, dialogs...这些通知交互 widget。

组件的使用

开始之前先简单了解一下WebView所包含的API:

  • url:初始load的url;
  • headers:添加请求头;
  • javascriptChannels:JS和Flutter通信的Channel;
  • navigationDelegate:路由委托(可以通过在此处拦截url实现JS调用Flutter部分);
  • withJavascript:允许与JS通信;
  • clearCache:是否清除缓存;
  • clearCookies:是否清除Cookies;
  • mediaPlaybackRequiresUserGesture:媒体播放时用户手势;
  • rect:大小与位置;
  • withZoom: 是否允许缩放。
  • withLocalStorage:是否开启本地缓存。
  • scrollBar:是否显示scrollBar。
  • hidden:初始化时是否隐藏。
  • allowFileURLs:是否允许请求本地的FileURL
//监听URL的改变
  StreamSubscription<String> _onUrlChanged;
//监听WebView的状态改变
  StreamSubscription<WebViewStateChanged> _onStateChanged;
//监听WebView的错误状态  
  StreamSubscription<WebViewHttpError> _onHttpError;

@override
  void dispose() {
    // 最后销毁 webviewReference
    _onUrlChanged.cancel();
    _onStateChanged.cancel();
    _onHttpError.cancel();
    webviewReference.dispose();
    super.dispose();
  }

一些坑

  1. 页面退出:弹出 WebView页面需要先 close() ,再弹出否则会挡住退出动画。
  2. 锚点问题:hidden = true ,在Android会将WebVIew可见性设置为GONE,WebView不能准确计算高度,此时加载URL会遇到锚点位置不准确的问题。
    hidden = false,在WebView绘制结束直接显示出来,由于WebView默认颜色为白色,出现主题颜色不一致问题。
  3. 跳转原生页面:由于不在 widget 树中,从WebView跳转原生页面需要先隐藏。
  4. 反复打开: 出现上一个页面dispose没有执行完,下一个页面initState开始执行出现卡死,维护WebView状态,监听WebView是否正常关闭。
  5. 多次打开:**重复点击WebView会执行两次 initState 出现卡死问题,可以使用延迟加载策略解决问题。

JS调用Flutter

定义一个JavascriptChanne(name, onMessage)。这个name属性接收的是一个字符串,它代表了JS调用Flutter时,双方共同商定好了的一个协议,JS通过这个name去post对应的信息给Flutter(API为name.postMessage('xxxxxx'))。开始JS调用Flutter的逻辑:

  JavascriptChannel buildChannelFromJs({String name, JsMessageCallback onMessage}) {
    return JavascriptChannel(
      name: name,
      onMessageReceived: (JavascriptMessage message) {
        Logger.tagD('JsMessage: ${message.message}');
        onMessage(message.message);
      },
    );
  }

flutter 调用 JS

_webViewController.evalJavascript() 方法来运行JS代码。postMessageToJs() 包装了一层。

  /// Flutter calls JS
  Future<String> postMessageToJs(String channel, String jsCode) {
    if (_webViewController == null) {
      Logger.tagW('_flutterWebViewPlugin is null');
      return Future.value('');
    }
    return _webViewController.evalJavascript('${channel}.postMessage(${jsCode});');
  }

例:获取页面Title

  1. 实现定义好如下JS Code:
pageTitle.postMessage('window.document.title') // JS code
  1. 定义JavascriptChannel(),通过监听 pageTitle 频道去回调 onMessageTitle()
void onMessageTitle(String message) => setState(() => _pageTitle = message);
buildChannelFromJs('pageTitle', onMessage: onMessageTitle)
  1. 添加页面加载完成监听运行JS代码,将得到的页面Title作为参数传给 onMessageTitle()
// WebViewState.finishLoad 页面加载完成时,执行postMessageToJs() 获取页面Title。
 _onStateChanged = _webViewController.onStateChanged.listen((WebViewStateChanged state) {
      switch (state.type) {
        case WebViewState.finishLoad:
          _webViewController.evalJavascript('pageTitle.postMessage('window.document.title')')
          break;
        default:
          break;
      }
    });
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342