现在移动端 web 应用,很多时候都需要与原生 APP 进行交互、沟通(运行在 webview 中),比如微信的 jssdk,通过 window.wx 对象调用一些原生 APP 的功能。所以,这次就来捋一捋 H5 与原生 APP 交互的原理。
H5 与原生 APP 的交互,本质上说,就是两种调用:

  1. APP 调用 H5 的代码
  2. H5 调用 APP 的代码

    1. APP 调用 H5 的代码

    因为 APP 是宿主,可以直接访问 H5,所以这种调用比较简单,就是在 H5 中曝露一些全局对象(包括方法),然后在原生 APP 中调用这些对象。
    APP与H5通讯 - 图1
    javascript
    1. window.sdk = {
    2. double = value => value * 2,
    3. triple = value => value * 3,
    4. };
    android
    1. webview.evaluateJavascript('window.sdk.double(10)', new ValueCallback<String>() {
    2. @Override
    3. public void onReceiveValue(String s) {
    4. // 20
    5. }
    6. });
    ios
    1. NSString *func = @"window.sdk.double(10)";
    2. NSString *str = [webview stringByEvaluatingJavaScriptFromString:func]; // 20

    2. H5 调用 APP 的代码

    因为 H5 不能直接访问宿主 APP ,所以这种调用就相对复杂一点。

这种调用常用有两种方式:

  1. 由 APP 向 H5 注入一个全局 js 对象,然后在 H5 直接访问这个对象
  2. 由 H5 发起一个自定义协议请求,APP 拦截这个请求后,再由 APP 调用 H5 中的回调函数

2.1 由 APP 向 H5 注入一个全局 js 对象

这种方式沟通机制简单,比较好理解,并且对于 h5 来说,没有新的东西,所以是比较推荐的一种方式。但这种方式可能存在安全隐患,详细查看 你不知道的 Android WebView 使用漏洞
APP与H5通讯 - 图2
android

  1. webview.addJavascriptInterface(new Object() {
  2. @JavascriptInterface
  3. public int double(value) {
  4. return value * 2;
  5. }
  6. @JavascriptInterface
  7. public int triple(value) {
  8. return value * 3;
  9. }
  10. }, "appSdk");

ios

  1. @interface AppSdk : NSObject
  2. {}
  3. - (int) double:(int)value;
  4. - (int) triple:(int)value;
  5. @end
  6. @implementation AppSdk
  7. - (int) double:(int)value {
  8. return value * 2;
  9. }
  10. - (int) triple:(int)value {
  11. return value * 3;
  12. }
  13. @end
  14. JSContext *context=[webview valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];
  15. AppSdk *appSdk = [AppSdk new];
  16. context[@"appSdk"] = appSdk;

javascript

  1. window.appSdk.double(10); // 20

2.2 由 H5 发起一个自定义协议请求

这种方式要稍复杂一点,因为需要自定义协议,这对很多前端开发者来说是比较新的东西。所以一般不推荐这种方式,可以作为第一种方式的补充。

大致需要以下几个步骤:

  1. 由 APP 自定义协议,比如 sdk://action?params
  2. 在 H5 定义好回调函数,比如 window.bridge = {getDouble: value => {}, getTriple: value => {}}
  3. 由 H5 发起一个自定义协议请求,比如 location.href = 'sdk://double?value=10'
  4. APP 拦截这个请求后,进行相应的操作,获取返回值
  5. 由 APP 调用 H5 中的回调函数,比如 window.bridge.getDouble(20);

APP与H5通讯 - 图3
javascript

  1. window.bridge = {
  2. getDouble: value => {
  3. // 20
  4. },
  5. getTriple: value => {
  6. // more
  7. }
  8. };
  9. location.href = 'sdk://double?value=10';

android

  1. webview.setWebViewClient(new WebViewClient() {
  2. @Override
  3. public boolean shouldOverrideUrlLoading(WebView view, String url) {
  4. // 判断如果 url 是 sdk:// 打头的就拦截掉
  5. // 然后从 url sdk://action?params 中取出 action 与params
  6. Uri uri = Uri.parse(url);
  7. if ( uri.getScheme().equals("sdk")) {
  8. // 比如 action = double, params = value=10
  9. webview.evaluateJavascript('window.bridge.getDouble(20)');
  10. return true;
  11. }
  12. return super.shouldOverrideUrlLoading(view, url);
  13. }
  14. });

ios

  1. - (BOOL)webview:(UIWebView *)webview shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType {
  2. // 判断如果 url 是 sdk:// 打头的就拦截掉
  3. // 然后从 url sdk://action?params 中取出 action 与params
  4. NSString *urlStr = request.URL.absoluteString;
  5. if ([urlStr hasPrefix:@"sdk://"]) {
  6. // 比如 action = double, params = value=10
  7. NSString *func = @"window.bridge.getDouble(20)";
  8. [webview stringByEvaluatingJavaScriptFromString:func];
  9. return NO;
  10. }
  11. return YES;
  12. }

附件:

Hybrid开发 - APP与H5通讯.xmind
APP与H5通讯.png