APP中Web容器的核心實現

 

現在的業務型APP中，採用純原生開發策略的已經很少了，大部分都使用的混合開發。如原生，H5,ReactNative,Flutter,Weex它們之間任意的組合就構成了混合開發。

其中原生+H5是出現最早的，老牌混合方案，即使過來多年，在現在的混合開發方案中H5也是使用率非常高的。在APP中嵌入Web容器，將更新迭代快，用戶交互少的頁面採用H5開發，將交互性強，穩定的部分使用原生開發是Hybird開發常用的策略。

Webview通過WebKit來渲染Web頁面，通過JavaScriptCore執行JS代碼與用戶交互，這篇文章主要講Hybird方案中Web容器的JS與原生交互的部分。

 

JSBridge原生與Web通信

 

爲什麼需要JSBridge雙端通信？

在Hybrid開發模式下，H5頁面經常需要使用到Native的功能，比如打開二維碼掃描、調用本地相冊、獲取用戶信息等，同時Native也需要向Web端發送推送、更新狀態等。

JavaScript運行環境與原生運行環境是隔離的，JavaScript是運行在單獨的JS Context中（Webview容器、JSCore等）。

WebView是一個原生UI控件，可以通過加載url展示一個網頁，它是運行在原生中。所以需要有一種機制實現Native端和Web端的雙向通信。

JSBridge主要做兩件事：

1.將Native端原生接口封裝成JavaScript接口，讓js調用。

2.將Web端JavaScript接口封裝成原生接口，讓原生調用。

JSBridge的實現方案

原生調用JS的方式

原生調用JS比較簡單，直接調用WebView提供的evaluateJavaScript API就可以了。

不過在調用之前要先保證 在H5頁面中 將JS方法保存在window（js的運行context）上，原生是調用的js全局上下文window上的方法

UIWebView調用方式:

NSString *jsStr = @"執行的JS代碼";
[webView stringByEvaluatingJavaScriptFromString:jsStr];

WKWebView調用方式:

[webView evaluateJavaScript:@"執行的JS代碼" completionHandler:^(id _Nullable response, NSError * _Nullable error) {}];

 

JS調用原生的方式

JS調用原生的常見解決方案如下：

一、UIWebView使用JavaScriptCore注入和Scheme攔截方式

二、WKWebView使用WKScriptMessageHandler注入和Scheme攔截方式

三、使用第三方框架WebViewJavascriptBridge調用

 

UIWebView使用JavaScriptCore注入和Scheme攔截方式

JavaScriptCore注入

1.注入API

將Native的相關接口注入到JS的Context（window）的對象中，一般來說這個對象內的方法名與Native相關方法名是相同的，Web端就可以直接在全局window下使用這個暴露的全局JS對象，進而調用原生端的方法。

UIWebView的JavaScriptCore注入方式:

1.原生新建類繼承自NSObject（如AppJSModel）。

2.h文件中聲明一個代理並遵循JSExport，代理內的方法和js定義的方法名一致。

3.m文件中實現代理中對應的方法，可以在方法內處理事件或通知代理。

 

原生類實現：

#import <Foundation/Foundation.h>
#import <JavaScriptCore/JavaScriptCore.h>

@protocol JSNativeProtocol <JSExport>

- (NSDictionary *)QRCodeScan:(NSDictionary *)param;

@end

@interface AppJSModel : NSObject <JSNativeProtocol>

@end


#import "AppJSModel.h"

@implementation AppJSModel
- (NSDictionary *)QRCodeScan:(NSDictionary *)param {
    NSLog(@"param: %@",param);
    return @{@"name":@"jack"};
}
@end

H5端調用：

import './App.css';
import { useState } from 'react';

function OriginalWebViewApp() {
    const[name, setName] = useState('')
 
    // 0.公共
    //原生髮消息給JS，JS的回調
    window.qrResult = (res)=>{
      setName(res)
      return '-------: '+res
    }
    // scheme攔截
    const localPostion = () => {
      window.location.href = 'position://localPosition?name=jack&age=20'
    }

    // 2.UIWebView的交互
    //js發消息給原生
    const qrActionOnAppModel = () => {
      const res = window.appModel.QRCodeScan({"name":"value"})
      alert(res.name)
    }
    const showAlert = () => {
      window.showAlert()
    }
   
   
    return (
      <div className="App">
        <div>------------------公共------------------</div>
          <div><a href='position://abc?name=jack' style={{color:'white'}}>scheme攔截1：定位</a></div>
          <button onClick={localPostion}>scheme攔截2</button>
          <div>
           原生執行代碼的結果：{name}
          </div>
   
          <div>------------------UIWebView------------------</div>
          <button onClick={qrActionOnAppModel}>點擊掃碼</button>
          <button onClick={showAlert}>彈窗</button>
      </div>
    )
}

export default OriginalWebViewApp

原生方法注入到JS上下文中:

- (void)webViewDidFinishLoad:(UIWebView *)webView {
    JSContext *jsContext = [webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];
    
    AppJSModel *jsModel = [AppJSModel new];
    jsContext[@"appModel"] = jsModel;
    jsContext[@"showAlert"] = ^(){
        dispatch_async(dispatch_get_main_queue(), ^{
            UIAlertController* alert = [UIAlertController alertControllerWithTitle:@"請輸入支付信息" message:@"" preferredStyle:UIAlertControllerStyleAlert];
            UIAlertAction* defaultAction = [UIAlertAction actionWithTitle:@"OK" style:UIAlertActionStyleDefault handler:nil];
            [alert addAction:defaultAction];
            UIAlertAction* cancleAction = [UIAlertAction actionWithTitle:@"Cancle" style:UIAlertActionStyleCancel handler:nil];
            [alert addAction:cancleAction];
            
            [alert addTextFieldWithConfigurationHandler:^(UITextField * _Nonnull textField) {
                textField.placeholder=@"請輸入用戶名";
            }];
            [alert addTextFieldWithConfigurationHandler:^(UITextField * _Nonnull textField) {
                textField.placeholder=@"請輸入支付密碼";
                textField.secureTextEntry=YES;
            }];
            
            [self presentViewController:alert animated:YES completion:nil];
        });
    };
}

Scheme攔截

原生方法執行完後，回調給js結果

- (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType {
    if ([request.URL.scheme isEqualToString:@"position"]) {
        //自定義處理定位scheme
        JSContext *jsContext = [webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];
        NSString *jsCode = @"qrResult('杭州，之江')";
        [jsContext evaluateScript:jsCode];
        return NO;
    }
    
    return YES;
}

 

WKWebView使用WKScriptMessageHandler注入和Scheme攔截方式

 

WKScriptMessageHandler注入

1.首先iOS與JS約定好使用相同的方法名進行通信，如 QRCodeScan:

2.然後iOS 使用 WKUserContentController 的 -addScriptMessageHandler:name:方法監聽 name 爲 QRCodeScan 的消息；

3.JS通過 window.webkit.messageHandlers. QRCodeScan.postMessage() 的方式對QRCodeScan 方法發送消息；

4.iOS在-userContentController:didReceiveScriptMessage:方法中讀取 name 爲 QRCodeScan 的消息數據 message.body。

H5頁面中JS與原生設置

下面代碼爲React代碼實現：

import './App.css';
import { useState } from 'react';

function OriginalWebViewApp() {
    const[name, setName] = useState('')
 
    // 0.公共
    //原生髮消息給JS，JS的回調
    window.qrResult = (res)=>{
      setName(res)
      return '-------: '+res
    }
    // scheme攔截
    const localPostion = () => {
      window.location.href = 'position://localPosition?name=jack&age=20'
    }
   
    // 1.WKWebView的交互
    //js發消息給原生
    const qrAction = () => {
      window.webkit.messageHandlers.QRCodeScan.postMessage({"name":"value"})
    }
   
   
    return (
      <div className="App">
        <div>------------------公共------------------</div>
          <div><a href='position://abc?name=jack' style={{color:'white'}}>scheme攔截1：定位</a></div>
          <button onClick={localPostion}>scheme攔截2</button>
          <div>
           原生執行代碼的結果：{name}
          </div>
   
          <div>------------------WKWebView------------------</div>
          <button onClick={qrAction}>點擊掃描</button>
      </div>
    )
}

export default OriginalWebViewApp

iOS原生頁面設置

override func viewDidLoad() {
    super.viewDidLoad()
    
    // WKWebViewConfiguration: 用於配置WKWebView的屬性和行爲, 常見的操作有
    let webViewConfiguration = WKWebViewConfiguration()
    
    //1.配置WKUserContentController,管理WKUserScript(cookie腳本)和WKScriptMessageHandler原生與JS的交互
    let userContentController = WKUserContentController()
    webViewConfiguration.userContentController = userContentController
    //添加WKScriptMessageHandler腳本處理
    userContentController.add(self, name: "QRCodeScan")
    //添加WKUserScript，injectionTime注入時機爲atDocumentStart頁面加載時在，forMainFrameOnly不只在主框架中注入，所有的框架都注入。
    let cookieScript = WKUserScript(source: "document.cookie = 'cookieName=cookieValue; domain=example.com; path=/';", injectionTime: .atDocumentStart, forMainFrameOnly: false)
    userContentController.addUserScript(cookieScript)
    
    //2.自定義處理網絡，處理Scheme爲position的定位網絡操作
    webViewConfiguration.setURLSchemeHandler(self, forURLScheme: "position")
    
    //3.偏好配置WKPreferences,設置網頁縮放，字體
    let preferences = WKPreferences()
    preferences.minimumFontSize = 10
    if #available(iOS 14, *) {
        let webpagePreferences = WKWebpagePreferences()
        webpagePreferences.allowsContentJavaScript = true
        webViewConfiguration.defaultWebpagePreferences = webpagePreferences
    } else {
        preferences.javaScriptEnabled = true
    }
    preferences.javaScriptCanOpenWindowsAutomatically = true
    webViewConfiguration.preferences = preferences
    
    //4.多媒體設置，設置視頻自動播放，畫中畫，逐步渲染
    webViewConfiguration.allowsInlineMediaPlayback = true
    webViewConfiguration.allowsPictureInPictureMediaPlayback = true
    webViewConfiguration.allowsAirPlayForMediaPlayback = true
    webViewConfiguration.suppressesIncrementalRendering = true
    
    
    //5.cookie設置
    //WKWebView中HTTPCookieStorage.shared單例默認管理着所有的cookie，一般無需我們做額外的操作，如果想單獨添加一個cookie,可以把創建的cookie放置到HTTPCookieStorage.shared中即可。
    //創建cookie對象
    let properties = [
        HTTPCookiePropertyKey.name: "cookieName",
        HTTPCookiePropertyKey.value: "cookieValue",
        HTTPCookiePropertyKey.domain: "example.com",
        HTTPCookiePropertyKey.path: "/",
        HTTPCookiePropertyKey.expires: NSDate(timeIntervalSinceNow: 31556926)
    ] as [HTTPCookiePropertyKey : Any]
    let cookie = HTTPCookie(properties: properties)!
    // 將cookie添加到cookie storage中
    HTTPCookieStorage.shared.setCookie(cookie)

    
    webView = WKWebView(frame: .zero, configuration: webViewConfiguration)
    webView.uiDelegate = self
    webView.navigationDelegate = self
    self.view.addSubview(webView)
    
    loadURL(urlString: "http://localhost:3000/")
}

JS與原生交互代理

//WKScriptMessageHandler
extension H5WKWebViewContainerController {
    func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage) {
        if message.name == "QRCodeScan" {
            print(message)
            
            //JS回調，原生處理完後，通知JS結果
            //原生給js的回調事件 會通過”原生調用js“方式放入到js執行環境的messageQueue中
            let script = "qrResult('jack')"
            message.webView?.evaluateJavaScript(script,completionHandler: { res, _ in
                print(res)
            })
            
        }
    }
}

Scheme攔截

// 自定義處理網絡請求Scheme
// WKURLSchemeHandler 的 Delegate
extension H5WKWebViewContainerController {
    func webView(_ webView: WKWebView, start urlSchemeTask: WKURLSchemeTask) {
        if urlSchemeTask.request.url?.scheme == "position" {
            //自定義處理定位scheme
            webView.evaluateJavaScript("qrResult('杭州，之江')")
        }
        print(webView)
    }
    
    func webView(_ webView: WKWebView, stop urlSchemeTask: WKURLSchemeTask) {
        print(webView)
    }
}

 

使用第三方框架WebViewJavascriptBridge調用

WebViewJavascriptBridge是一個原生與JS交互的工具，使用簡單，設計巧妙，是一個進行Hybird開發必不可少的工具。

WebViewJavascriptBridge的使用方式很簡單，首先創建一個WKWebView變量，然後根據WKWebView變量創建WebViewJavascriptBridge屬性。

然後就可以使用WebViewJavascriptBridge屬性提供的API進行與H5的交互了。

在JS上下文中註冊OC原生方法：

- (void)registerHandler:(NSString *)handlerName handler:(WVJBHandler)handler；

調用JS上下文中已經存在的方法：

- (void)callHandler:(NSString *)handlerName data:(id)data

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view.
    
    WKWebView *wkWebView = [[WKWebView alloc] initWithFrame:self.view.frame];
    wkWebView.navigationDelegate = self;
    [self.view addSubview:wkWebView];
    
    [WebViewJavascriptBridge enableLogging];
    self.bridge = [WebViewJavascriptBridge bridgeForWebView:wkWebView];
    
    // 在JS上下文中註冊callOC方法
    [self.bridge registerHandler:@"testObjcCallback" handler:^(id data, WVJBResponseCallback responseCallback) {
        NSLog(@"收到了JS的調用");
        responseCallback(@"Object-C Received");
    }];
    
    // iOS調用JS
    [self.bridge callHandler:@"testJavascriptHandler" data:@{@"state":@"before ready"}];
    
    NSURLRequest *req = [NSURLRequest requestWithURL:[NSURL URLWithString:@"http://localhost:3000/"]];
    [wkWebView loadRequest:req];
}

h5中，在JS上下文中註冊處理方法

import React from "react"

function setupWebViewJavascriptBridge(callback) {
  if (window.WebViewJavascriptBridge) { return callback(window.WebViewJavascriptBridge); }
  if (window.WVJBCallbacks) { return window.WVJBCallbacks.push(callback); }
  window.WVJBCallbacks = [callback];
  var WVJBIframe = document.createElement('iframe');
  WVJBIframe.style.display = 'none';
  WVJBIframe.src = 'https://__bridge_loaded__';
  document.documentElement.appendChild(WVJBIframe);
  setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0)
}


function WebViewJavaScriptBridgeApp() {

    return (
        <div className="WebViewJavaScriptBridgeApp">
          <div>---------WebViewJavaScript---------</div>
          <div id="buttons"></div>
          <div id="log"></div>
          <div>
          {
              setupWebViewJavascriptBridge(function(bridge) {
                var uniqueId = 1
                function log(message, data) {
                  var log = document.getElementById('log')
                  var el = document.createElement('div')
                  el.className = 'logLine'
                  el.innerHTML = uniqueId++ + '. ' + message + ':<br/>' + JSON.stringify(data)
                  if (log.children.length) { log.insertBefore(el, log.children[0]) }
                  else { log.appendChild(el) }
                }
            
                bridge.registerHandler('testJavascriptHandler', function(data, responseCallback) {
                  log('ObjC called testJavascriptHandler with', data)
                  var responseData = { 'Javascript Says':'Right back atcha!' }
                  log('JS responding with', responseData)
                  if (responseCallback !== undefined) {
                     responseCallback(responseData)
                  }
                })
            
                document.body.appendChild(document.createElement('br'))
                if (document.getElementById('buttons') === null) {
                  setTimeout(function() {
                    document.getElementById('buttons').innerHTML = ""
                    var callbackButton = document.getElementById('buttons').appendChild(document.createElement('button'))
                    callbackButton.innerHTML = 'js 調用 OC方法'
                    callbackButton.onclick = function(e) {
                      e.preventDefault()
                      log('JS calling handler "testObjcCallback"')
                      bridge.callHandler('testObjcCallback', {'foo': 'bar'}, function(response) {
                        log('JS got response', response)
                      })
                    }
                  },0)
                }
                
              })  
          }
          </div>
        </div>
      )
}

export default WebViewJavaScriptBridgeApp

 

WKWebViewJavascriptBridge核心知識點分析

WebViewJavascriptBridge對象結構

WebViewJavascriptBridge對象如下：

window.WebViewJavascriptBridge = {
    // 保存js註冊的處理函數：messageHandlers[handlerName] = handler;
    registerHandler: registerHandler,
    //JS調用OC方法
    callHandler: callHandler,
    disableJavscriptAlertBoxSafetyTimeout: disableJavscriptAlertBoxSafetyTimeout,
    //JS調用OC的消息隊列
    _fetchQueue: _fetchQueue,
    //JS處理OC過來的方法調用。
    _handleMessageFromObjC: _handleMessageFromObjC
};

它的內部結構中有一個隊列：JS調用OC的隊列_fetchQueue，不過_fetchQueue是一個函數變量，這個函數的返回值纔是真正的js調用OC的消息隊列。

function _fetchQueue() {
    var messageQueueString = JSON.stringify(sendMessageQueue);
    sendMessageQueue = [];
    return messageQueueString;
}

消息隊列的設計模式是與JS運行機制有關的，JS引擎執行的關鍵是消息隊列和事件循環，詳情可以閱讀文章：

[JS引擎中的線程，事件循環，上下文] https://www.cnblogs.com/zhou--fei/p/17452687.html

消息隊列中保存的message結構

消息隊列中保存的是一組message字典序列化後的字符串，message消息中保存着方法名handlerName，參數data，回調方法callbackId

一個消息的創建方式如下：

NSMutableDictionary* message = [NSMutableDictionary dictionary];
message[@"data"] = data;
    
NSString* callbackId = [NSString stringWithFormat:@"objc_cb_%ld", ++_uniqueId];
self.responseCallbacks[callbackId] = [responseCallback copy];
message[@"callbackId"] = callbackId;
message[@"handlerName"] = handlerName;

在原生與JS的交互中，當發送完消息時只會把對應的回調方法和回調方法ID在各自全局變量中以key,value的方式保存。

原生調用JS時保存如下：

@interface WebViewJavascriptBridgeBase : NSObject
// 在成員變量中定義字段responseCallbacks
@property (strong, nonatomic) NSMutableDictionary* responseCallbacks;
@end


//發送消息時，保存回調ID：回調函數鍵值對。
- (void)sendData:(id)data responseCallback:(WVJBResponseCallback)responseCallback handlerName:(NSString*)handlerName {
    NSMutableDictionary* message = [NSMutableDictionary dictionary];
    
    if (data) {
        message[@"data"] = data;
    }
    
    if (responseCallback) {
        NSString* callbackId = [NSString stringWithFormat:@"objc_cb_%ld", ++_uniqueId];
        self.responseCallbacks[callbackId] = [responseCallback copy];
        message[@"callbackId"] = callbackId;
    }
    
    if (handlerName) {
        message[@"handlerName"] = handlerName;
    }
    [self _queueMessage:message];
}

JS對原生髮送消息時，保存如下：

// 在JS全局上下文中定義對象responseCallbacks
var responseCallbacks = {};
function _doSend(message, responseCallback) {
    if (responseCallback) {
        var callbackId = 'cb_'+(uniqueId++)+'_'+new Date().getTime();
        //保存回調id:回調方法，鍵值對
        responseCallbacks[callbackId] = responseCallback;
        message['callbackId'] = callbackId;
    }
    sendMessageQueue.push(message);
    messagingIframe.src = CUSTOM_PROTOCOL_SCHEME + '://' + QUEUE_HAS_MESSAGE;
}

WebViewJavascriptBridge的Scheme攔截

WebViewJavascriptBridge對象是原生向JS注入的，而WebViewJavascriptBridge對象向JS注入採用的方式是Scheme攔截。

當h5中發送"__bridge_loaded__"Scheme跳轉時，則會在原生觸發WebViewJavascriptBridge對象相關數據的注入[_base injectJavascriptFile]。

- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {
    if (webView != _webView) { return; }
    NSURL *url = navigationAction.request.URL;
    __strong typeof(_webViewDelegate) strongDelegate = _webViewDelegate;

    
    if ([_base isWebViewJavascriptBridgeURL:url]) {
        if ([_base isBridgeLoadedURL:url]) {
            //iOS原生進行js交互環境注入
            [_base injectJavascriptFile];
        } else if ([_base isQueueMessageURL:url]) {
            [self WKFlushMessageQueue];
        } else {
            [_base logUnkownMessage:url];
        }
        decisionHandler(WKNavigationActionPolicyCancel);
        return;
    }
    
    if (strongDelegate && [strongDelegate respondsToSelector:@selector(webView:decidePolicyForNavigationAction:decisionHandler:)]) {
        [_webViewDelegate webView:webView decidePolicyForNavigationAction:navigationAction decisionHandler:decisionHandler];
    } else {
        decisionHandler(WKNavigationActionPolicyAllow);
    }
}

另外其他與消息發送無關的調用也採用的Scheme攔截，如消息隊列的刷新。

 

另外

iOS代碼Demo地址：https://github.com/zhfei/MixContainer

H5代碼Demo地址：https://github.com/zhfei/ReactBasicKnowledge

H5頁面使用的是React框架生成的Demo，下載後執行：

cd h5-demo
npm install
npm start

就可以在線調試了

 

參考文章：

https://juejin.cn/post/7097845525587689486

https://blog.csdn.net/ws1836300/article/details/119182057