iOS端执行包含外部引用的js并相互通信

背景

某些情况下,需要调用js的一些代码来执行一些操作,并且将处理结果回传到OC。

概述

为了执行一段包含外部引用的js,需要使用UIWebView,通过fileURL去加载一个js或者HTML页面,为了方便的在两个语言之间通信,需要借助一个第三方框架WebViewJavascriptBridge,它可以实现跨语言的请求与回调。

实现

本文讨论的是,从OC调用WebView加载的js的某个方法来处理数据,并且回调处理结果。这里有两个关键点,一是加载的js文件能够处理外部引用,二是OC可以调用js并且回传结果。

加载包含外部引用的js

使用webView的loadRequest:方法,加载一个本地的HTML文件可以实现执行包含外部引用的js。为了证明可以引入外部js,我们引入一个jquery,并且在document.ready中执行后续操作,具体步骤如下。

1.将html与js加入到bundle中

将文件加入到bundle

其中index.html中包含的是要执行的js,内容如下:
setupWebViewJavascriptBridge是JSBridge的内容,用于设置桥接。

<body>
    <script type="text/javascript" src="jquery.min.js"></script>
    <script type="text/javascript">
        function setupWebViewJavascriptBridge(callback) {
            if (window.WebViewJavascriptBridge) { return callback(WebViewJavascriptBridge); }
            if (window.WVJBCallbacks) { return window.WVJBCallbacks.push(callback); }
            window.WVJBCallbacks = [callback];
            var WVJBIframe = document.createElement('iframe');
            WVJBIframe.style.display = 'none';
            WVJBIframe.src = 'wvjbscheme://__BRIDGE_LOADED__';
            document.documentElement.appendChild(WVJBIframe);
            setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0)
        }
        $(document).ready(function(){
            alert('document ready');
            setupWebViewJavascriptBridge(function(bridge){
                bridge.registerHandler('js_handler', function(data, callback) {
                   alert('JS Receive: ' + data);
                   callback('<data after calculate>');
                })
            });
        });
    </script>
</body>

2.在控制器中创建一个webView,并且加载index.html

@interface ViewController () <UIWebViewDelegate>

@property (nonatomic, strong) UIWebView *webView;
@property (nonatomic, strong) WebViewJavascriptBridge *bridge;

@end
- (void)viewDidLoad {
    [super viewDidLoad];
    UIWebView *wb = [[UIWebView alloc] initWithFrame:CGRectZero];
    // 设置代理,可以通过拦截请求的方式回调
    wb.delegate = self;
    self.webView = wb;
    // 通过request方式加载本地文件
    NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL fileURLWithPath:[[NSBundle mainBundle] pathForResource:@"index.html" ofType:nil]]];
    [wb loadRequest:request];
    // 通过JSBridge实现调用js方法
    self.bridge = [WebViewJavascriptBridge bridgeForWebView:wb];
    // 调用js代码中注册的名为js_handler的方法,并且传递参数data,当js中处理完后,调用callback会回调到responseCallback:并且传递responseData回来
    [self.bridge callHandler:@"js_handler" data:@"<data from objc>" responseCallback:^(id responseData) {
        NSLog(@"收到来自js的回调数据 %@", responseData);
    }];
}

3.分析调用过程

首先看一下index.html中的js代码

<body>
    <script type="text/javascript" src="jquery.min.js"></script>
    <script type="text/javascript">
        // 配置桥接的代码,来自github的WebViewJavascriptBridge给出的示例
        function setupWebViewJavascriptBridge(callback) {
            if (window.WebViewJavascriptBridge) { return callback(WebViewJavascriptBridge); }
            if (window.WVJBCallbacks) { return window.WVJBCallbacks.push(callback); }
            window.WVJBCallbacks = [callback];
            var WVJBIframe = document.createElement('iframe');
            WVJBIframe.style.display = 'none';
            WVJBIframe.src = 'wvjbscheme://__BRIDGE_LOADED__';
            document.documentElement.appendChild(WVJBIframe);
            setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0)
        }
        // 使用document.ready证明可以处理外部引用
        $(document).ready(function(){
            alert('document ready');
            // 调用上面的方法配置桥接,并且定义一个名为js_handler的方法,接收OC传递来的data,并且通过callback回调。
            setupWebViewJavascriptBridge(function(bridge){
                bridge.registerHandler('js_handler', function(data, callback) {
                   alert('JS Receive: ' + data);
                   callback('<data after calculate>');
                })
            });
        });
    </script>
</body>

在代码开始运行后,首先webView加载了js,js通过alert显示document ready,然后完成桥接的配置。紧接着运行OC中配置桥接的代码,并调用js中的js_handler,传递数据,js_handler收到数据后,通过alert显示收到的数据data,并且将处理后的数据经过callback回调到OC的responseCallback这个block,这时候在控制台可以看到收到js回调的log。

4.另一种js回调到OC的方式

上面的代码设置了webView的代理为当前控制器,webView在每次加载一个请求时都会通过代理询问是否加载该请求,只要在这里拦截特定请求,即可实现通信。

我们可以在js中需要回传数据的时候通过window.location.href="<url>"实现一个请求,注意这里不要直接使用ajax请求,否则会产生跨域的问题。

通过url中带数据的方式即可实现js到OC的通信,为了区分传统的请求,我们可以以app://开头,例如app://result=0x28,代表处理结果为0x28,只需要在拦截时判断是否是app协议,并且通过正则等手段取出url中的参数即可,具体的代理方法如下。

- (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType {
    NSString *urlStr = request.URL.absoluteString;
    // 这里把app协议的请求拦截下来处理
    if ([urlStr hasPrefix:@"app://"]) {
        NSString *content = [urlStr substringFromIndex:6];
        NSLog(@"%@", content);
        return NO;
    }
    return YES;
}

总结

实现js与OC通信的难点主要是OC对js方法的调用,使用WebViewJavascriptBridge可以简单的实现这一功能,该框架可以完美的实现js和OC的相互调用与回调。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350

推荐阅读更多精彩内容