MessageHandler 高級用法一:封裝MessageHandler

在iOS中 JS 和原生APP交互有許多種方法

WebViewJavascriptBridge 是我用的比較多的一個庫,但是 WebViewJavascriptBridge 中在使用時最大的一個缺點就是 WebViewJavascriptBridge 使用了一個中間代理

setWebViewDelegate

必須將 UIWebView、WKWebView 的代理設(shè)置為 WebViewJavascriptBridge 內(nèi)部的處理類

這就造成了對原始的調(diào)用方法有一定的影響

WKWebView

iOS 8 之后,無疑沒有理由不使用 WKWebView

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

在APP端通過 configuration.userContentController.add(_scriptMessageHandler:WKScriptMessageHandler, name:String) 并且實現(xiàn)協(xié)議方法即可

在 APP 端只需要 evaluateJavaScript 既可以調(diào)用 JS 方法

通過上面三種方法便可以實現(xiàn)大多數(shù)的 JS 原生交互

WKUserScript

通過configuration.userContentController.addUserScript 便可以添加一個 WKUserScript 對象饵婆,從而可以插入需要額外加入的 JS 代碼

WKScriptMessageHandler

至于 messageHandler 的具體的使用用法售貌,這里便不做詳細(xì)的說明

下面是對 MessageHandler 的一個封裝,所謂的封裝就是懶人的一個高尚的借口啃憎。
說一下大致思路:

創(chuàng)建一個類 WKJSHandler
此類的初始化方法中會對 webView 有一個弱引用,只有擁有了 webView 才能做任何事情

我們無論是使用 regist 或者 call 和 JS 相關(guān)的方法似炎,一般都是采用 block 的方法
block 一般最直接的表現(xiàn)就是異步

所以我們需要 WKJSHandler 中存在一個屬性 data 對block 進行持有辛萍,從而可以實現(xiàn)異步回調(diào)
所以在 WKScriptMessageHandler 協(xié)議方法執(zhí)行的時候,根據(jù)name 取出來對應(yīng)的block進行回調(diào)

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)
 /// 注冊一個事件叹阔,當(dāng)
        self.jsHandler.regist(name: "kkalert") { [weak self] (data) in
            
            if let title = data as? String {
                self?.alert(title: title)
            }
        }

上面的源碼可以在 https://github.com/TieShanWang/WKJSHandler 上面找到
當(dāng)然也可以直接使用 cocoapod 使用 pod 'WKJSHandler' 安裝

當(dāng)然現(xiàn)在實現(xiàn)了 JS 和 Native 之間的直接方法的調(diào)用,并且實現(xiàn)了參數(shù)的傳遞
但是我們并不會滿足于此传睹,因為在實際的使用中耳幢,我們多數(shù)時候需要從Native 中獲取一些數(shù)據(jù),這個時候使用 postMessage 的方法欧啤,便不能夠滿足我們的需求了
通過 postMessage 只能夠調(diào)用APP的一個方法睛藻,并且傳參,沒有辦法直接回調(diào) JS邢隧。

同樣在我們調(diào)用 JS 方法后也希望 JS 在處理完畢之后會給我們一個回調(diào)

我們的需求是 “回調(diào)“

在下一章 將會解決一下回調(diào)的問題

MessageHandler 高級用法二:原生調(diào)用JS 實現(xiàn)回調(diào)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末店印,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子倒慧,更是在濱河造成了極大的恐慌按摘,老刑警劉巖包券,帶你破解...
    沈念sama閱讀 218,451評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異炫贤,居然都是意外死亡溅固,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,172評論 3 394
  • 文/潘曉璐 我一進店門兰珍,熙熙樓的掌柜王于貴愁眉苦臉地迎上來侍郭,“玉大人,你說我怎么就攤上這事掠河×猎” “怎么了?”我有些...
    開封第一講書人閱讀 164,782評論 0 354
  • 文/不壞的土叔 我叫張陵唠摹,是天一觀的道長爆捞。 經(jīng)常有香客問我,道長勾拉,這世上最難降的妖魔是什么嵌削? 我笑而不...
    開封第一講書人閱讀 58,709評論 1 294
  • 正文 為了忘掉前任,我火速辦了婚禮望艺,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘肌访。我一直安慰自己找默,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,733評論 6 392
  • 文/花漫 我一把揭開白布吼驶。 她就那樣靜靜地躺著惩激,像睡著了一般。 火紅的嫁衣襯著肌膚如雪蟹演。 梳的紋絲不亂的頭發(fā)上风钻,一...
    開封第一講書人閱讀 51,578評論 1 305
  • 那天,我揣著相機與錄音酒请,去河邊找鬼骡技。 笑死,一個胖子當(dāng)著我的面吹牛羞反,可吹牛的內(nèi)容都是我干的布朦。 我是一名探鬼主播,決...
    沈念sama閱讀 40,320評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼昼窗,長吁一口氣:“原來是場噩夢啊……” “哼是趴!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起澄惊,我...
    開封第一講書人閱讀 39,241評論 0 276
  • 序言:老撾萬榮一對情侶失蹤唆途,失蹤者是張志新(化名)和其女友劉穎富雅,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體肛搬,經(jīng)...
    沈念sama閱讀 45,686評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡没佑,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,878評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了滚婉。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片图筹。...
    茶點故事閱讀 39,992評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖让腹,靈堂內(nèi)的尸體忽然破棺而出远剩,到底是詐尸還是另有隱情,我是刑警寧澤骇窍,帶...
    沈念sama閱讀 35,715評論 5 346
  • 正文 年R本政府宣布瓜晤,位于F島的核電站,受9級特大地震影響腹纳,放射性物質(zhì)發(fā)生泄漏痢掠。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,336評論 3 330
  • 文/蒙蒙 一嘲恍、第九天 我趴在偏房一處隱蔽的房頂上張望足画。 院中可真熱鬧,春花似錦佃牛、人聲如沸淹辞。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,912評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽象缀。三九已至,卻和暖如春爷速,著一層夾襖步出監(jiān)牢的瞬間央星,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,040評論 1 270
  • 我被黑心中介騙來泰國打工惫东, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留莉给,地道東北人。 一個月前我還...
    沈念sama閱讀 48,173評論 3 370
  • 正文 我出身青樓凿蒜,卻偏偏與公主長得像禁谦,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子废封,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,947評論 2 355

推薦閱讀更多精彩內(nèi)容