美文网首页iOSiOS-VendoriOS
让你在WebView中用JS调Native Object

让你在WebView中用JS调Native Object

作者: 一个大番茄 | 来源:发表于2015-10-16 16:43 被阅读3140次

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

    背景

    之所做这个东西,源于之前项目中需要把一些页面用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上了,欢迎围观,欢迎批评!

    相关文章

      网友评论

      • b70ca44b32f8:我看了这个文章也看了demo,但还是不太明白该怎么开始。
        比如,[self.webView addJavascriptInterfaces:wSelf withName:@"ViewController"]; 这句代码应该放在什么文件里,我放在js里面报错。
        我现在遇到的问题是,移动端h5视频会默认全屏播放,用的手机自带的视频播放器,我现在想把全屏禁止,让视频内嵌在网页里播放。
        我觉得是不是应该让js调用native方法,我没做过ios开发,原理看懂了但是这些代码不知道应该放到哪里,能跟我简单说一下么
        b70ca44b32f8:@yaqing 是不是您这里讲的都是app开发,js也是在app里面用到了,而不是说网站开发里面js和native的互调?
        b70ca44b32f8:@yaqing 我是要用微信打开一个网页播放里面的视频,但是一播放视频就会自动全屏,我想让视频内嵌在网页里播放。webView的属性allowsInlineMediaPlayback是不是也是oc文件里的,如果我在网页的站点里面放了一个c文件能有用吗,如果写的话这个文件的后缀应该是什么呢?还是说oc一定要经过编译才能执行?
        一个大番茄:@Wonkaaaa 这句代码是OC的,明显不能放到JS里。我猜测你是通过iOS 的webview打开一个带视频的网页吧,你可以试试设置webView的属性allowsInlineMediaPlayback
      • MeiganFang:哈哈!再一次利用了 runtime,本文我能理解为JSPatch原理的简单实现么?博主
        一个大番茄:@MeiganFang 适应场景也是不一样的,我这个是正常的业务场景中需要用到的。而JSPatch是主要用来打热补丁的,runtime那一层主要使用方法混写来替代本身native的实现,简单来说和waxlua 干的是一样的,但是wax年久失修,落后太多,以前用wax最蛋疼的时候就是那玩意儿不能支持block,这一点我没细看JSPatch支持没有
        一个大番茄:@MeiganFang 而且JSPatch是构建在JavascriptCode之上,而我这个只是简单的拓展了一下UIWebView,JSCore的能力比UIWebView强太多。
        一个大番茄:@MeiganFang 你可以理解为类似Phonegap的简单实现,我做那会儿还没JSPatch。以前逆向12306客户端看到过它是用cordova做的,看过它的源码,类似
      • 动感超人丶:很不错,学习了
      • HHHHHHHHHHD:好东西
      • e7757bea06e5:github叫啥,去关注你
        e7757bea06e5: @yaqing 竟然没注意是蓝色字体。。。。
        一个大番茄:@Z小花的花小喵 不是最下面有repo的链接么
      • 木木烈少:不知道作者是否了解过WebViewJavascriptBridge,是个不错的第三方桥接方法,实现方法跟作者的差不多,也是通过iframe来实现webview的reload并截取。不管是从JS调用Native还是从Native调用JS用起来都很方便哈
        木木烈少:@yaqing 👍👍👍
        一个大番茄:@林少烈 知道哈,其实原理都那么回事,包括cordova的代码等等。其实我最先做这个是因为安卓有个 addJavascriptInterface的函数,想要达到同样的效果才开始做的
      • 煜寒了:很细致很清晰

      本文标题:让你在WebView中用JS调Native Object

      本文链接:https://www.haomeiwen.com/subject/yjhacttx.html