Flutter WebView與JS交互

flutter中 webview在iOS中其實是用了原生的wkwebview,所以,flutter與js的交互跟iOS原生的wkwebview與js的交互特別相似,只是叫法不同。

本文采用Flutter官方WebView插件:https://pub.dartlang.org/packages/webview_flutter

另外一個插件:叫做flutter_webview_plugin,需要在"pubspec.yaml"文件中添加“flutter_webview_plugin: ^0.3.5”,并點擊右上部的“packages get”。不過這個插件中好像對這種交互不太友好,Flutter調用JS可以,但是JS怎么調用Flutter還沒找到。

開始之前先簡單了解一下官方WebView所包含的API:

  • onWebViewCreated:在WebView創建完成后調用,只會被調用一次;
  • initialUrl:初始load的url;
  • javascriptMode:JS執行模式(是否允許JS執行);
  • javascriptChannels:JS和Flutter通信的Channel;
  • navigationDelegate:路由委托(可以通過在此處攔截url實現JS調用Flutter部分);
  • gestureRecognizers:手勢監聽;
  • onPageFinished:WebView加載完畢時的回調。

JS調用Flutter

JS調用Flutter有兩種方法:使用javascriptChannels發送消息使用路由委托(navigationDelegate)攔截url

方法1:使用javascriptChannels發送消息

javascriptChannels參數可以傳入一組Channels,我們可以定義一個_alertJavascriptChannel變量,這個channel用來控制JS調用Flutter的toast功能:

JavascriptChannel _alertJavascriptChannel(BuildContext context) {
    return JavascriptChannel(
        name: 'Toast',
        onMessageReceived: (JavascriptMessage message) {
          showToast(message.message);
        });
  }

WebView(
    javascriptChannels: <JavascriptChannel>[
        _alertJavascriptChannel(context),
    ].toSet(),

在上面的代碼中,我們定義了一個_alertJavascriptChannel變量,并給它起了個name叫Toast,這個name屬性接收的是一個字符串,它代表了JS調用Flutter時,雙方共同商定好了的一個協議,JS通過這個name去post對應的信息給Flutter(API為name.postMessage('xxxxxx'))。我們在網頁部分寫一個簡單的button,點擊后開始JS調用Flutter的邏輯:

<button onclick="callFlutter()">callFlutter</button>

function callFlutter(){
   Toast.postMessage("JS調用了Flutter");
}

onMessageReceived為Flutter接收到了JS的消息之后的回調,我們可以通過message.message來獲取JS發給我們的消息內容。JavascriptMessage類暫時只有一個String類型的message成員變量,所以如果需要傳遞復雜數據,可以通過傳遞json字符串來解決。

代碼重點:JavascriptChannel中的name要與JS中的name.postMessage()相對應!!

方法2:使用路由委托navigationDelegate攔截url

navigationDelegate回調在每次網頁路由地址發生變化的時候都會觸發,因此我們可以攔截特定的url來實現JS調用Flutter。
同樣的,我們在網頁部分寫一個簡單的button,點擊后跳轉路由"js://webview?arg1=111&args2=222"。我們可以和客戶端協商好一個scheme,比如這個例子里面就是js://webview,我們可以在query string上帶上我們想要傳遞的參數:

<button onclick="callFlutter()">callFlutter</button>

function callFlutter(){
  /*約定的url協議為:js://webview?arg1=111&arg2=222*/
  document.location = "js://webview?arg1=111&args2=222";
}

在Flutter端,我們就可以在navigationDelegate回調中攔截這個符合js://webviewscheme的路由地址了:

navigationDelegate: (NavigationRequest request) {
            if (request.url.startsWith('js://webview')) {
              showToast('JS調用了Flutter By navigationDelegate');
              print('blocking navigation to $request}');
              return NavigationDecision.prevent;
            }
            print('allowing navigation to $request');
            return NavigationDecision.navigate;
          },

我們通過return不同的值,告訴WebView怎么處理這個路由:

  • NavigationDecision.prevent:阻止路由替換;
  • NavigationDecision.navigate:允許路由替換。

Flutter調用JS

在WebView創建完成之后,我們可以拿到一個WebViewController,通過它的evaluateJavascript()方法,我們可以執行JS語句:

onWebViewCreated: (WebViewController webViewController) {
    _controller = webViewController;
},
······
floatingActionButton: FloatingActionButton(
        onPressed: () {
          _controller
              ?.evaluateJavascript('callJS("visible")')
              ?.then((result) {
                  // You can handle JS result here.
              });
        },
        child: Text('call JS'),
      ),
  <p id="p1" style="visibility:hidden;">
    Flutter 調用了 JS.
    Flutter 調用了 JS.
    Flutter 調用了 JS.
  </p>
  
function callJS(message){
  document.getElementById("p1").style.visibility = message;
}

在上面的例子中,我們點擊floatingActionButton后,就會去執行JS中的callJS()方法了,具體UI體現為:將隱藏的段落重新顯示。evaluateJavascript()返回值是一個Future,因此我們可以接收JS給我們的返回值,返回值格式請閱讀官方API注釋。
這里要注意的是,evaluateJavascript()方法,Flutter建議我們在onPageFinished回調之后去執行,以保證所有的HTML都已經加載完畢了。因此在實際開發中,我這里展示的這種直接將onWebViewCreated中的controller賦值的方法是不可取的,應該是使用FutureBuilder之類的方式去實現比較優雅。

源碼

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,546評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,570評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,505評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,017評論 1 313
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,786評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,219評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,287評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,438評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,971評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,796評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,995評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,540評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,230評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,662評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,918評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,697評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,991評論 2 374

推薦閱讀更多精彩內容

  • 轉載:https://blog.csdn.net/carson_ho/article/details/649046...
    隨心隨性_0a25閱讀 2,201評論 0 10
  • Swift1> Swift和OC的區別1.1> Swift沒有地址/指針的概念1.2> 泛型1.3> 類型嚴謹 對...
    cosWriter閱讀 11,121評論 1 32
  • 一、簡述 目前原生與JS交互的方式有以下幾種 JavaScriptCore WKWebView 攔截URL Web...
    兔先森Amo閱讀 5,273評論 0 4
  • 這段時間準備自己寫一個博客使用react,因此自然也接觸到了很流行的打包工具webpack。寫了一個簡單的reac...
    YingQQQ閱讀 601評論 0 1
  • 少即是多,慢即是快! 為什么學了那么多東西無法落地?因為學習東西太多,太雜,頭腦被塞滿,什么也說不出來,什么也沒學...
    x天空之城閱讀 213評論 0 0