MessageHandler 高级用法一:封装MessageHandler

在iOS中 JS 和原生APP交互有许多种方法

WebViewJavascriptBridge 是我用的比较多的一个库,但是 WebViewJavascriptBridge 中在使用时最大的一个缺点就是 WebViewJavascriptBridge 使用了一个中间代理

setWebViewDelegate

必须将 UIWebView、WKWebView 的代理设置为 WebViewJavascriptBridge 内部的处理类

这就造成了对原始的调用方法有一定的影响

WKWebView

iOS 8 之后,无疑没有理由不使用 WKWebView

在 JS 端只需要 window.webkit.messageHandler.<method>.postMessage(<body>)即可

在APP端通过 configuration.userContentController.add(_scriptMessageHandler:WKScriptMessageHandler, name:String) 并且实现协议方法即可

在 APP 端只需要 evaluateJavaScript 既可以调用 JS 方法

通过上面三种方法便可以实现大多数的 JS 原生交互

WKUserScript

通过configuration.userContentController.addUserScript 便可以添加一个 WKUserScript 对象,从而可以插入需要额外加入的 JS 代码

WKScriptMessageHandler

至于 messageHandler 的具体的使用用法,这里便不做详细的说明

下面是对 MessageHandler 的一个封装,所谓的封装就是懒人的一个高尚的借口。
说一下大致思路:

创建一个类 WKJSHandler
此类的初始化方法中会对 webView 有一个弱引用,只有拥有了 webView 才能做任何事情

我们无论是使用 regist 或者 call 和 JS 相关的方法,一般都是采用 block 的方法
block 一般最直接的表现就是异步

所以我们需要 WKJSHandler 中存在一个属性 data 对block 进行持有,从而可以实现异步回调
所以在 WKScriptMessageHandler 协议方法执行的时候,根据name 取出来对应的block进行回调

import UIKit

import WebKit

open class WKJSHandler: NSObject, WKScriptMessageHandler {
    
    public typealias Handler = (Any?) -> Void
    
    open weak var webView: WKWebView?
    
    public init(webView: WKWebView) {
        
        super.init()
        
        self.webView = webView
        
        let bundle = Bundle.init(for: WKJSHandler.classForCoder())
        
        guard let path = bundle.path(forResource: "injectjs", ofType: nil) else {
            return
        }
        
        guard let content = try? String.init(contentsOfFile: path) else {
            return
        }
        
        self.inject(javascript: content, begin: true, main: true)
    }
    
    open var data = [String: Handler]()
    
    /// regist a new hander for name
    ///
    /// - Parameters:
    ///   - name: handler name
    ///   - handler: callBack
    open func regist(name: String, handler: @escaping Handler) {
        
        self.data[name] = handler
        
        self.webView?.configuration.userContentController.removeScriptMessageHandler(forName: name)
        
        self.webView?.configuration.userContentController.add(self, name: name)
    }
    
    
    /// remove message handler
    ///
    /// - Parameter name: handler name
    open func remove(name: String) {
        
        self.data[name] = nil
        
        self.webView?.configuration.userContentController.removeScriptMessageHandler(forName: name)
    }
    
    
    /// evaluateJavaScript a javascript
    ///
    /// - Parameters:
    ///   - javascript: javascript code
    ///   - callBack: result of evalueteJavaScript
    open func runJS(javascript: String, result: ((Any?, Error?) -> Void)?) {
        
        self.webView?.evaluateJavaScript(javascript, completionHandler: result)
    }
    
    
    /// inject javascript code
    ///
    /// - Parameters:
    ///   - javascript: javascript code
    ///   - begin: When the script should be injected.
    ///   - main: forMainFrameOnly Whether the script should be injected into all frames or just the main frame.
    open func inject(javascript: String, begin: Bool, main: Bool) {
        
        let newScript = WKUserScript.init(source: javascript, injectionTime: begin ? .atDocumentStart : .atDocumentEnd, forMainFrameOnly: main)
        
        self.webView?.configuration.userContentController.addUserScript(newScript)
    }

    
    /// delegate method
    public func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage) {
        
        let name = message.name
        
        guard let handler = self.data[name] else {
            return
        }
        
        handler(message.body)
    }
    
    deinit {
        for t in self.data {
            self.remove(name: t.key)
        }
        self.data = [String: Handler]()
        self.webView?.configuration.userContentController.removeAllUserScripts()
    }

有了此层的封装,在使用的时候就会显得非常的方便

 self.webView = WKWebView.init(frame: self.view.bounds)
        
        self.jsHandler = WKJSHandler.init(webView: self.webView)
 /// 注册一个事件,当
        self.jsHandler.regist(name: "kkalert") { [weak self] (data) in
            
            if let title = data as? String {
                self?.alert(title: title)
            }
        }

上面的源码可以在 https://github.com/TieShanWang/WKJSHandler 上面找到
当然也可以直接使用 cocoapod 使用 pod 'WKJSHandler' 安装

当然现在实现了 JS 和 Native 之间的直接方法的调用,并且实现了参数的传递
但是我们并不会满足于此,因为在实际的使用中,我们多数时候需要从Native 中获取一些数据,这个时候使用 postMessage 的方法,便不能够满足我们的需求了
通过 postMessage 只能够调用APP的一个方法,并且传参,没有办法直接回调 JS。

同样在我们调用 JS 方法后也希望 JS 在处理完毕之后会给我们一个回调

我们的需求是 “回调“

在下一章 将会解决一下回调的问题

MessageHandler 高级用法二:原生调用JS 实现回调

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

推荐阅读更多精彩内容