让你在WebView中用JS调Native Object

一直想写篇文章来总结下,可是一直也很懒,一拖就是几个月。

背景

之所做这个东西,源于之前项目中需要把一些页面用webView来呈现,但是web中需要调用native的方法,比如获取本地存的某些数据、调用摄像头等等,这里也就是说JS要和OC能够互通有无。所以简单来说我要做的事情就是要实现一个bridge,用于两方之间的通信,使其在web中能够像调用一个普通的JS一样去调用OC。

有人可能要说用PhoneGap之类的,可是我觉得我的要求并不多,不想引入这样稍微有点重的东西。
最后花了一段时间做了出来这个bridge,�使得JS可以调OC的方法,传递的参数目前支持String, Array, Dictionary。同时还支持异步调用,只需要在最后加上一个callback就可以了。

注入对象:

首先我需要向JS注入我想要注入的本地对象,像下面这样一句话搞定:

[self.webView addJavascriptInterfaces:wSelf withName:@"ViewController"];

这句话向JS中注入了ViewController这个对象,如何实现的呢?
由于基于UIWebView来做的这个事儿,所以最终我只能通过 -stringByEvaluatingJavaScriptFromString: 来完成。ViewController就相当于是本地对象在JS中存的一个key。通过UIWebView执行JS,向JS中创建了一个名为ViewController的对象,它拥有一系列本地拥有的方法。
要想获得一个对象上所有的方法,可以通过下面这段代码来获得:

NSArray* DumpObjMethods(Class clz){

  Class thisClass = clz;
  NSMutableArray *ret = [[NSMutableArray alloc]init];

  do {
      unsigned int methodCount = 0;
      Method *methods = class_copyMethodList(thisClass, &methodCount);
    
      for (unsigned int i = 0; i < methodCount; i++) {
        
          Method method = methods[i];
        
          NSString *name = @(sel_getName(method_getName(method)));
    
          const char *encoding = method_getTypeEncoding(method);
          NSMethodSignature *signature = [NSMethodSignature signatureWithObjCTypes:encoding];
          NSUInteger allCount = [signature numberOfArguments]; // The parameter count including the self and the _cmd ones
          NSUInteger parameterCount = allCount - 2;

          if (parameterCount < 2) {
              name = [name stringByReplacingOccurrencesOfString:@":" withString:@""];
          }else{
              name = [name substringToIndex:name.length-1];
              name = [name stringByReplacingOccurrencesOfString:@":" withString:@"_"];
          }
          [ret addObject:name];
      }
      free(methods);
      thisClass = class_getSuperclass(thisClass);     
  } while (thisClass);
  return ret;
}

将获取到的方法名写入到JS中对应的对象中就完成了注入。
但是这里有个问题,我通过class_copyMethodList去获得一个Class以及它的父类上的方法,这样子的遍历其实是很耗性能的,尤其是当你需要注入的类特别多的时候。我最开始是想看看在JS中有没有办法实现像forwardinvocation这样的东西,如果有的话我就可以根本不需要提前去注入了,只需要调用的时候去查找就好了。然而我并没有找到一个好的解决方案,看来似乎对JS中调用一个undefined的function是无能为力了,如果哪位有更好的建议欢迎告知。

调用过程:

注入相对来说比较简单,无非就是在JS中创建一个对象,然后将方法名写进去,重点是调用,比如我本地有这样的一个方法- (void)passArrayFromJS:(NSArray*)arr,在JS中调用的时候只需要这样写

ViewController.passArrayFromJS([1,2,"2"]);

然后本地的方法就会被调用,看起来比较神奇,其实一切都因为OC的动态性。
首先JS发起了这个函数调用,会通过以下这段JS传递到本地来:

    var iframe = document.createElement("IFRAME");
    iframe.style.display = "none";
    iframe.setAttribute("src", "hybrid-js-scheme://" + obj + "/" + encodeURIComponent(functionName) + argStr);
    document.documentElement.appendChild(iframe);

通过插入一个iframe来发起一个特殊的请求,这个请求会被- (BOOL)webView: shouldStartLoadWithRequest:navigationType:给拦截到。然后从这个特殊的URL上面取到我要调用的对象的名字,方法名以及参数等等。
取到了方法名字,我可以获得它的Selector,通过Selector获得方法签名,然后在通过NSInvocation完成调用,如果有返回值的话还会把返回值传会JS。

异步调用:

说实话我觉得这部分做的挺丑的,我是通过JS调用的时候,把一个callback作为最后一个参数来进行的。本地如果判断到了最后一个参数是个callback,那么就会异步去调用本地的方法,完成之后再会通过callback把值给回JS中。
那么是如何实现JS向本地传递一个callback的呢?由于我是依赖的UIWebView,没有用JavascriptCore这样高大上的东西,所以答案我的答案是没有办法。
在做这点的时候有点取巧,其实我根本就没有把function传到本地来,它始终是存在于JS中的,只是相当于把这个callback的名字告诉给了OC这边,然后本地完成了工作之后,只需要告诉JS我需要哪个callback,然后把参数给它。JS再去找到这个callback,并把参数传给它,从而完成了异步调用。
当然,如果你有更好的方案欢迎告诉我怎样完善这部分。

结尾

这个项目目前我已经放到Github上了,欢迎围观,欢迎批评!

推荐阅读更多精彩内容