|
1 |
| -## Android与JS通信桥接框架 |
2 |
| -可以与[IOS版WebViewJavascriptBridge](https://github.com/marcuswestin/WebViewJavascriptBridge)公用一套前端JS代码 |
| 1 | +WebViewJavascriptBridge |
| 2 | +========================== |
| 3 | +根据[IOS marcuswestin/WebViewJavascriptBridge](https://github.com/marcuswestin/WebViewJavascriptBridge) 编写而来的JavascriptBridge,这样一来前端可以公用一套JS代码。使用方法和 marcuswestin/WebViewJavascriptBridge 也是基本一样。 |
| 4 | + |
| 5 | +同时也在此之上做了加强,根据Cordova的源码,将每一种消息封装成一个插件(RequestHandler),并统一管理起来(HandlerManager)。 |
| 6 | + |
| 7 | +An Android bridge for sending messages between Java and JavaScript in WebViews. Based on [IOS marcuswestin/WebViewJavascriptBridge](https://github.com/marcuswestin/WebViewJavascriptBridge). |
| 8 | + |
| 9 | + |
| 10 | +### Gradle |
| 11 | + |
| 12 | + |
| 13 | +```groovy |
| 14 | +repositories { |
| 15 | + jcenter() |
| 16 | +} |
| 17 | +
|
| 18 | +compile 'com.luffyjet:webviewjavascriptbridge:1.0' |
| 19 | +``` |
| 20 | + |
| 21 | + |
| 22 | + |
| 23 | +Examples |
| 24 | +-------- |
| 25 | + |
| 26 | +See the `app/` folder. |
| 27 | + |
| 28 | + |
| 29 | + |
| 30 | +Usage |
| 31 | +----- |
| 32 | + |
| 33 | +1) |
| 34 | + |
| 35 | +```java |
| 36 | +WebSettings settings = webView.getSettings(); |
| 37 | +settings.setJavaScriptEnabled(true);//很关键 |
| 38 | +WebViewJavaScriptBridge mBridge = WebViewJavaScriptBridge.bridgeForWebView(this, webView); |
| 39 | +mBridge.setWebViewDelegate(new MyWebViewClient());//设置WebViewClient |
| 40 | +webView.setWebChromeClient(new MyChromeClient());//设置ChromeClient |
| 41 | +``` |
| 42 | + |
| 43 | +2) Register a handler in Java, and call a JS handler: |
| 44 | + |
| 45 | +```java |
| 46 | + //注册一个 处理 js端发来消息的 handler |
| 47 | +mBridge.registerHandler("abs", new WebViewJavaScriptBridgeBase.WVJBHandler() { |
| 48 | + @Override |
| 49 | + public void handle(JSONObject data, WebViewJavaScriptBridgeBase.WVJBResponseCallback responseCallback) { |
| 50 | + Log.d(TAG, "from JS req: " + data.toString()); |
| 51 | + responseCallback.callback(new JSResult("i like milk from native").toJson()); |
| 52 | + } |
| 53 | +}); |
| 54 | + |
| 55 | +mBridge.callHandler("NativeCallJS", model.toJSON(), new WebViewJavaScriptBridgeBase.WVJBResponseCallback() { |
| 56 | + @Override |
| 57 | + public void callback(String responseData) { |
| 58 | + Log.d(TAG, "JS responded:" + responseData); |
| 59 | + Toast.makeText(MainActivity.this, "JS responded:" + responseData , Toast.LENGTH_SHORT).show(); |
| 60 | + } |
| 61 | +}); |
| 62 | + |
| 63 | +``` |
| 64 | + |
| 65 | +3) Copy and paste `setupWebViewJavascriptBridge` into your JS: |
| 66 | + |
| 67 | +```javascript |
| 68 | +function setupWebViewJavascriptBridge(callback) { |
| 69 | + if(window.WebViewJavascriptBridge) { |
| 70 | + return callback(WebViewJavascriptBridge); |
| 71 | + } |
| 72 | + if(window.WVJBCallbacks) { |
| 73 | + return window.WVJBCallbacks.push(callback); |
| 74 | + } |
| 75 | + window.WVJBCallbacks = [callback]; |
| 76 | + var WVJBIframe = document.createElement('iframe'); |
| 77 | + WVJBIframe.style.display = 'none'; |
| 78 | + WVJBIframe.src = 'wvjbscheme://__BRIDGE_LOADED__'; |
| 79 | + document.documentElement.appendChild(WVJBIframe); |
| 80 | + setTimeout(function() { |
| 81 | + document.documentElement.removeChild(WVJBIframe) |
| 82 | + }, 0); |
| 83 | +} |
| 84 | +``` |
| 85 | + |
| 86 | +5) Finally, call `setupWebViewJavascriptBridge` and then use the bridge to register handlers and call Java handlers: |
| 87 | + |
| 88 | +```javascript |
| 89 | +setupWebViewJavascriptBridge(function(bridge) { |
| 90 | + /* Initialize your app here */ |
| 91 | + |
| 92 | + bridge.registerHandler('NativeCallJS', function(data, responseCallback) { |
| 93 | + var responseData = { |
| 94 | + 'Javascript Says': 'Right back atcha!' |
| 95 | + }; |
| 96 | + |
| 97 | + log('Native call JS with ', data); |
| 98 | + responseCallback(responseData); |
| 99 | + }); |
| 100 | + |
| 101 | + var doc = document; |
| 102 | + var readyEvent = doc.createEvent('Events'); |
| 103 | + readyEvent.initEvent('WebViewJavascriptBridgeReady'); |
| 104 | + readyEvent.bridge = WebViewJavascriptBridge; |
| 105 | + doc.dispatchEvent(readyEvent); |
| 106 | + }); |
| 107 | +``` |
| 108 | + |
| 109 | + |
| 110 | +## 插件管理功能 |
| 111 | +可以和Cordova一样进行插件管理,每一种类型的消息都由一个插件管理。 |
| 112 | +插件类继承至 RequestHandler ,包含WebView的Activity要实现 BridgeInterface 接口。插件类由XML文件进行配置,请新建 res/xml/wjbconfig.xml 文件。 |
| 113 | + |
| 114 | +``` |
| 115 | +<?xml version="1.0" encoding="utf-8"?> |
| 116 | +<widget> |
| 117 | + <feature name="chooseImage"> |
| 118 | + <param |
| 119 | + name="android-package" |
| 120 | + value="com.luffyjet.jsbridgeexample.handlers.ImageChooseHandler"/> |
| 121 | + <param |
| 122 | + name="onload" |
| 123 | + value="true"/> |
| 124 | + </feature> |
| 125 | +
|
| 126 | + <feature name="deviceInfo"> |
| 127 | + <param |
| 128 | + name="android-package" |
| 129 | + value="com.luffyjet.jsbridgeexample.handlers.DeviceInfoHandler"/> |
| 130 | + <param |
| 131 | + name="onload" |
| 132 | + value="true"/> |
| 133 | + </feature> |
| 134 | +
|
| 135 | +</widget> |
| 136 | +``` |
| 137 | + |
| 138 | +一个插件对应一个feature,feature name就是handle name。 onload属性为true代表插件会在webview初始化时一同初始化,false则是在需要该插件的时候通过反射加载。 |
| 139 | + |
| 140 | +具体使用方法请查看 ``app/`` 目录下的示例代码。 |
| 141 | + |
| 142 | + |
| 143 | +## Thanks |
| 144 | +[marcuswestin/WebViewJavascriptBridge](https://github.com/marcuswestin/WebViewJavascriptBridge) |
| 145 | +& [cordova-android](https://github.com/apache/cordova-android) |
| 146 | + |
| 147 | + |
| 148 | + |
| 149 | +License |
| 150 | +-------- |
| 151 | + |
| 152 | + Copyright 2017 luffyjet. |
| 153 | + |
| 154 | + Licensed under the Apache License, Version 2.0 (the "License"); |
| 155 | + you may not use this file except in compliance with the License. |
| 156 | + You may obtain a copy of the License at |
| 157 | + |
| 158 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 159 | + |
| 160 | + Unless required by applicable law or agreed to in writing, software |
| 161 | + distributed under the License is distributed on an "AS IS" BASIS, |
| 162 | + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 163 | + See the License for the specific language governing permissions and |
| 164 | + limitations under the License. |
0 commit comments