# WKWebViewJavascriptBridge

**Repository Path**: isandboy/WKWebViewJavascriptBridge

## Basic Information

- **Project Name**: WKWebViewJavascriptBridge
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-02-17
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![](Rources/WKWebViewJavascriptBridge.jpg)

[![language](https://img.shields.io/badge/Language-Swift-FFA08F.svg)](https://github.com/apple/swift) 
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-FE95AE.svg?style=flat)](https://github.com/Carthage/Carthage) 
[![License MIT](https://img.shields.io/badge/license-MIT-FC89CD.svg?style=flat)](https://raw.githubusercontent.com/Lision/WKWebViewJavascriptBridge/master/LICENSE) 
[![Support](https://img.shields.io/badge/support-iOS%209%2B%20-FB7DEC.svg?style=flat)](https://www.apple.com/nl/ios/) 
[![CocoaPods](https://img.shields.io/cocoapods/p/WKWebViewJavascriptBridge.svg?style=flat)](http://cocoadocs.org/docsets/WKWebViewJavascriptBridge) 
[![Build Status](https://api.travis-ci.org/Lision/WKWebViewJavascriptBridge.svg?branch=master)](https://travis-ci.org/Lision/WKWebViewJavascriptBridge) 
[![CocoaPods](https://img.shields.io/cocoapods/v/WKWebViewJavascriptBridge.svg?style=flat)](http://cocoapods.org/pods/WKWebViewJavascriptBridge)

> 此项目基于 [WebViewJavascriptBridge](https://github.com/marcuswestin/WebViewJavascriptBridge)，在其上仅对 WKWebView 提供支持，由 Swift 实现！

# WKWebViewJavascriptBridge 能为你做什么?

您可以通过使用 WKWebViewJavascriptBridge 书写几行代码实现混合模块，而无需关心底层的消息传递实现。

![](Rources/WKWebViewJavascriptBridgeDemo.gif)

# 为什么仅支持 WKWebView?

### WKWebView 的优势

众所周知，WKWebView 比 UIWebView 加载网页的**速度更快，效率更高，且没有太多的内存开销**。

在当前时间节点，大多数 iOS App 都是基于 iOS 9.0+ 的，**这是一个 WKWebView 的时代。**

### UIWebView 跨域访问漏洞

iOS 平台跨域访问漏洞成因是由于 UIWebView 默认开启了WebKitAllowUniversalAccessFromFileURLs 和 WebKitAllowFileAccessFromFileURLs 选项。

**相比之下，WKWebView 默认 allowFileAccessFromFileURLs 和 allowUniversalAccessFromFileURLs 选项为 false。**

关于更多 UIWebView 跨域访问漏洞，点击 [这里](https://mp.weixin.qq.com/s/aRlxqxGw8etqep62qG4khA) 了解更多。

# 特性

- Swift 的支持：Swift 3.2 ~ 5 的支持。
- 高性能：消息传递性能高于传统实现方式（拦截 Requests）。
- 高速：无需考虑 Alert Box 安全超时。
- 轻量：框架除去自动生成的 `.h` 仅有 3 个文件。
- 非侵入性：无需改写 `webView` 的继承基类（这里假设当前时间节点下大部分 iOS App 已经完成了从 UIWebView 到 WKWebView 的迁徙，反正早晚要做这件事不是吗？）。

# 用法

### 1. 用 WKWebView 实例化 WKWebViewJavascriptBridge ：

``` swift
bridge = WKWebViewJavascriptBridge(webView: webView)
```

### 2. 在 Native 中注册 Handler，调用 JS Handler ：

``` swift
bridge.register(handlerName: "testiOSCallback") { (paramters, callback) in
    print("testiOSCallback called: \(String(describing: paramters))")
    callback?("Response from testiOSCallback")
}

bridge.call(handlerName: "testJavascriptHandler", data: ["foo": "before ready"], callback: nil)
```

### 3. 复制并粘贴 setupWKWebViewJavascriptBridge 到你的 JS 中： 

``` js
function setupWKWebViewJavascriptBridge(callback) {
    if (window.WKWebViewJavascriptBridge) { return callback(WKWebViewJavascriptBridge); }
    if (window.WKWVJBCallbacks) { return window.WKWVJBCallbacks.push(callback); }
    window.WKWVJBCallbacks = [callback];
    window.webkit.messageHandlers.iOS_Native_InjectJavascript.postMessage(null)
}
```

### 4. 最后，调用 setupWKWebViewJavascriptBridge 之后用 Bridge 来注册 Handlers 以及调用 Native Handlers ：

``` js
setupWKWebViewJavascriptBridge(function(bridge) {

	/* Initialize your app here */

	bridge.registerHandler('testJavascriptHandler', function(data, responseCallback) {
		console.log('iOS called testJavascriptHandler with', data)
		responseCallback({ 'Javascript Says':'Right back atcha!' })
	})

	bridge.callHandler('testiOSCallback', {'foo': 'bar'}, function(response) {
		console.log('JS got response', response)
	})
})
```

# 安装

### Cocoapods

1. 在你的 Podfile 中添加 `pod 'WKWebViewJavascriptBridge', '~> 1.2.0'` 。
2. 执行 `pod install` 或 `pod update` 。
3. 添加 `import WKWebViewJavascriptBridge` 。

### Carthage

1. 在你的 Cartfile 中添加 `github "Lision/WKWebViewJavascriptBridge" ~> 1.2.0` 。
2. 执行 `carthage update --platform ios` 。
3. 添加 `WKWebViewJavascriptBridge` Framework 到你的项目中。

### 手动集成

`clone` 这个项目并手动添加 [WKWebViewJavascriptBridge](https://github.com/Lision/WKWebViewJavascriptBridge/tree/master/WKWebViewJavascriptBridge) 目录中的文件。

# 要求

此框架要求 `iOS 9.0+` 以及 `Xcode 9.0+` 。

# 联系

- Email: lisionmail@gmail.com
- Sina: [@Lision](https://weibo.com/5071795354/profile)
- Twitter: [@Lision](https://twitter.com/LisionChat)

# 许可证

[![](https://camo.githubusercontent.com/5e085da09b057cc65da38f334ab63f0c2705f46a/68747470733a2f2f75706c6f61642e77696b696d656469612e6f72672f77696b6970656469612f636f6d6d6f6e732f7468756d622f662f66382f4c6963656e73655f69636f6e2d6d69742d38387833312d322e7376672f31323870782d4c6963656e73655f69636f6e2d6d69742d38387833312d322e7376672e706e67)](https://raw.githubusercontent.com/Lision/WKWebViewJavascriptBridge/master/LICENSE)

WKWebViewJavascriptBridge 基于 MIT 许可证，查看 LICENSE 文件了解更多信息。