如何设计通用WebAPI之Swift实现(二)

上篇文章说了设计通用api的思路,下面来具体说下怎么融合到WebView中。这里我只对UIWebView做了接入,WKWebView也是类似。

bridge.js

bridge.js是js端调用oc功能函数的集合。

其中定义个SLWebBridge的全局变量,里面定义了GLOBAL_FUNC_INDEX=0(表示callBackId初始为0),如果每次js调用oc有回调,那么callBackId会递增。

在webViewDidFinishLoad的时候注入该js。然后在后续就可以利用其进行通信了。

BaseWebAPI

BaseWebAPI遵循一个协议WebAPIProtocol。

protocol WebAPIProtocol {
 // 所属的module名
    func module() -> String
    // 该方法会动态调用,在BaseWebAPI里面实现
    func callNativeMethod(name: String, parameter: [String: AnyObject]?, callback: SLCallback?)
}
class BaseWebAPI: NSObject, WebAPIProtocol {
    
    func module() -> String {
        return ""
    }
    
    func callNativeMethod(name: String, parameter: [String: AnyObject]?, callback: SLCallback?) {
        let sel = name + ":callback:"
        let seletor = NSSelectorFromString(sel)
        
        guard self.responds(to: seletor) else {
            print("\(self) not responds \(sel)")
            return
        }
        
        let imp = self.method(for: seletor)
        
        if let imp = imp {
            typealias function = @convention(c) (AnyObject, Selector, [String: AnyObject]?, SLCallback?) -> Void
            
            let call = unsafeBitCast(imp, to: function.self)
            
            call(self, seletor, parameter, callback)
        }
        
        if let callback = callback {
            callback(nil)
        }
    }
}

负责各自模块的webAPI会继承于BaseWebAPI。比如UIWebAPI.

class UIWebAPI: BaseWebAPI {
    func test(_ params:[String: AnyObject]?, callback: SLCallback?) {
        print("test UIWebAPI");
        if let params = params {
            print("params:\(params)")
        }
        callback?(["a":22])
    }
}

native端的bridge

WebBridge主要处理了bridge.js的注入,webAPI的注册,js调用oc设定url的解析等。

最主要的就是func handleWebEvent(_ url: URL?, webView: UIWebView) -> Bool方法。

关于各个参数的获取上一篇文章中都讲过,主要说下native端生成callback。
如果有callbackId存在,则会生成callback。callback会带有个dict的参数,以便native传递参数给js。params会序列化成jsonString。最后会调用invokeWebMethod传入callbackId和params。

var callback: SLCallback?
        
        //cb,在js端是个id,根据id找到对应的function
        let callbackId = url.objectForKey("cb")
        if let callbackId = callbackId {
            // 生成callback
            callback = { result in
                guard let result = result else {
                    return
                }
                
                // 将result-->string
                do {
                    let jsonData = try JSONSerialization.data(withJSONObject: result as Any, options: JSONSerialization.WritingOptions.prettyPrinted)
                    
                    var jsonString = String(data: jsonData, encoding: String.Encoding.utf8)
                    
                    jsonString = jsonString ?? "{}"
                    
                    let script = String(format: "SLWebBridge.invokeWebMethod(%@,%@);", callbackId, jsonString!)
                    
                    print("\(jsonString)")
                    
                    print("\(script)")
                    
                    webView.stringByEvaluatingJavaScript(from: script)
                    
                } catch {
                    print("json to string error")
                }
            }
        }
        
        let webApi = webAPI(module)
        if let webApi = webApi {
            webApi.callNativeMethod(name: method, parameter: dict, callback: callback)
        }

自定义webView

SLWebView会持有WebBridge。init的时候会创建webBridge。

webBridge = WebBridge(webView: self, webViewDelegate: nil)

WebBridge中的init函数,将webView.delegate设成WebBridge。

init(webView: UIWebView, webViewDelegate: UIWebViewDelegate?) {
        apiDict = [String:WebAPIProtocol]();

        super.init()
        
        self.webView = webView
        self.webViewDelegate = webViewDelegate
        webView.delegate = self
        
        // 注入js
        injectBridgeScript()
    }

如果外部需要设置webView.delegate,则需要通过webViewDelegate。在所有UIWebViewDelegate函数的地方都会调用webViewDelegate把回调传出去。

if let webViewDelegate = webViewDelegate {
       if webViewDelegate.responds(to: #selector(webViewDidStartLoad(_:))) {
           webViewDelegate.webViewDidStartLoad!(webView)
       }
   }
class SLWebView: UIWebView {
    var webBridge: WebBridge?
    
    override init(frame: CGRect) {
        super.init(frame: frame)
        
        commonInit()
    }
    
    required init?(coder aDecoder: NSCoder) {
        super.init(coder: aDecoder)
        
        commonInit()
    }
    
    deinit {
        webBridge = nil
        self.delegate = nil
    }
    
    private func commonInit() {
        webBridge = WebBridge(webView: self, webViewDelegate: nil)
    }
    
    //MARK: Register API
    func registerWebAPI(_ module: String, _ api: WebAPIProtocol) {
        webBridge?.registerWebAPI(module, api)
    }
    
    func unregisterWebAPI(_ module: String) {
        webBridge?.unregisterWebAPI(module)
    }

测试Demo

<!DOCTYPE html>
<html>
<head>
 <title>test</title>
</head>
<body>
    <p>测试</p>
 <button onclick="test()">click</button>
 // 引用bridge.js
 <script src="bridge.js"></script>
 <script>
  function test() {
            SLWebBridge.invokeClientMethod("ui","test",{a:5}, function(result) {
            alert(result.a);});
  }
 </script>
</body>
</html>

点击button,会触发js调用native,ui模块的test方法,并传入参数。在调用之后,会有回调,alert native传过来的结果。

在ViewController中载入webView。

override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view, typically from a nib.
        let uiApi = UIWebAPI()
        
        // 注册webAPI
        webView.registerWebAPI("ui", uiApi)
        
        let path = Bundle.main.path(forResource: "test", ofType: "html")

        guard let p = path, p.characters.count > 0 else {
            return
        }
        
        do {
           let content = try String(contentsOfFile: p)
            webView.loadHTMLString(content, baseURL: Bundle.main.bundleURL)
        } catch {
            print("error")
        }
    }

github地址:SLWebBridge

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

推荐阅读更多精彩内容