BridgeHelper.java
10.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
package com.github.lzyzsd.jsbridge;
import android.os.Looper;
import android.os.SystemClock;
import android.text.TextUtils;
import android.util.Log;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* JsBridge辅助类,帮助集成JsBridge功能.
*
* @author ZhengAn
* @date 2019-06-30
*/
public class BridgeHelper implements WebViewJavascriptBridge {
private static final String TAG = "BridgeHelper";
private static final String BRIDGE_JS = "WebViewJavascriptBridge.js";
private Map<String, OnBridgeCallback> responseCallbacks = new HashMap<>();
private Map<String, BridgeHandler> messageHandlers = new HashMap<>();
private BridgeHandler defaultHandler = new DefaultHandler();
private List<Message> startupMessage = new ArrayList<>();
private List<Message> getStartupMessage() {
return startupMessage;
}
private void setStartupMessage(List<Message> startupMessage) {
this.startupMessage = startupMessage;
}
private long uniqueId = 0;
private IWebView webView;
public BridgeHelper(IWebView webView) {
this.webView = webView;
}
/**
* @param handler default handler,handle messages send by js without assigned handler name,
* if js message has handler name, it will be handled by named handlers registered by native
*/
public void setDefaultHandler(BridgeHandler handler) {
this.defaultHandler = handler;
}
/**
* 获取到CallBackFunction data执行调用并且从数据集移除
*
* @param url
*/
private void handlerReturnData(String url) {
String functionName = BridgeUtil.getFunctionFromReturnUrl(url);
OnBridgeCallback f = responseCallbacks.get(functionName);
String data = BridgeUtil.getDataFromReturnUrl(url);
if (f != null) {
f.onCallBack(data);
responseCallbacks.remove(functionName);
}
}
/**
* 保存message到消息队列
*
* @param handlerName handlerName
* @param data data
* @param responseCallback CallBackFunction
*/
private void doSend(String handlerName, String data, OnBridgeCallback responseCallback) {
Message m = new Message();
if (!TextUtils.isEmpty(data)) {
m.setData(data);
}
if (responseCallback != null) {
String callbackStr = String.format(BridgeUtil.CALLBACK_ID_FORMAT, ++uniqueId + (BridgeUtil.UNDERLINE_STR + SystemClock.currentThreadTimeMillis()));
responseCallbacks.put(callbackStr, responseCallback);
m.setCallbackId(callbackStr);
}
if (!TextUtils.isEmpty(handlerName)) {
m.setHandlerName(handlerName);
}
queueMessage(m);
}
/**
* list<message> != null 添加到消息集合否则分发消息
*
* @param m Message
*/
private void queueMessage(Message m) {
if (startupMessage != null) {
startupMessage.add(m);
} else {
dispatchMessage(m);
}
}
/**
* 分发message 必须在主线程才分发成功
*
* @param m Message
*/
private void dispatchMessage(Message m) {
String messageJson = m.toJson();
//escape special characters for json string 为json字符串转义特殊字符
messageJson = messageJson.replaceAll("(\\\\)([^utrn])", "\\\\\\\\$1$2");
messageJson = messageJson.replaceAll("(?<=[^\\\\])(\")", "\\\\\"");
messageJson = messageJson.replaceAll("(?<=[^\\\\])(\')", "\\\\\'");
messageJson = messageJson.replaceAll("%7B", URLEncoder.encode("%7B"));
messageJson = messageJson.replaceAll("%7D", URLEncoder.encode("%7D"));
messageJson = messageJson.replaceAll("%22", URLEncoder.encode("%22"));
String javascriptCommand = String.format(BridgeUtil.JS_HANDLE_MESSAGE_FROM_JAVA, messageJson);
// 必须要找主线程才会将数据传递出去 --- 划重点
if (Thread.currentThread() == Looper.getMainLooper().getThread()) {
this.loadUrl(javascriptCommand);
}
}
/**
* 刷新消息队列
*/
private void flushMessageQueue() {
if (Thread.currentThread() == Looper.getMainLooper().getThread()) {
loadUrl(BridgeUtil.JS_FETCH_QUEUE_FROM_JAVA, new OnBridgeCallback() {
@Override
public void onCallBack(String data) {
// deserializeMessage 反序列化消息
List<Message> list = null;
try {
list = Message.toArrayList(data);
} catch (Exception e) {
Log.w(TAG, e);
return;
}
if (list == null || list.isEmpty()) {
return;
}
for (int i = 0; i < list.size(); i++) {
Message m = list.get(i);
String responseId = m.getResponseId();
// 是否是response CallBackFunction
if (!TextUtils.isEmpty(responseId)) {
OnBridgeCallback function = responseCallbacks.get(responseId);
String responseData = m.getResponseData();
function.onCallBack(responseData);
responseCallbacks.remove(responseId);
} else {
OnBridgeCallback responseFunction = null;
// if had callbackId 如果有回调Id
final String callbackId = m.getCallbackId();
if (!TextUtils.isEmpty(callbackId)) {
responseFunction = new OnBridgeCallback() {
@Override
public void onCallBack(String data) {
Message responseMsg = new Message();
responseMsg.setResponseId(callbackId);
responseMsg.setResponseData(data);
queueMessage(responseMsg);
}
};
} else {
responseFunction = new OnBridgeCallback() {
@Override
public void onCallBack(String data) {
// do nothing
}
};
}
// BridgeHandler执行
BridgeHandler handler;
if (!TextUtils.isEmpty(m.getHandlerName())) {
handler = messageHandlers.get(m.getHandlerName());
} else {
handler = defaultHandler;
}
if (handler != null) {
handler.handler(m.getData(), responseFunction);
}
}
}
}
});
}
}
private void loadUrl(String jsUrl, OnBridgeCallback returnCallback) {
this.loadUrl(jsUrl);
// 添加至 Map<String, CallBackFunction>
responseCallbacks.put(BridgeUtil.parseFunctionName(jsUrl), returnCallback);
}
private void loadUrl(String jsUrl) {
webView.loadUrl(jsUrl);
}
/**
* register handler,so that javascript can call it
* 注册处理程序,以便javascript调用它
*
* @param handlerName handlerName
* @param handler BridgeHandler
*/
public void registerHandler(String handlerName, BridgeHandler handler) {
if (handler != null) {
// 添加至 Map<String, BridgeHandler>
messageHandlers.put(handlerName, handler);
}
}
/**
* unregister handler
*
* @param handlerName
*/
public void unregisterHandler(String handlerName) {
if (handlerName != null) {
messageHandlers.remove(handlerName);
}
}
/**
* call javascript registered handler
* 调用javascript处理程序注册
*
* @param handlerName handlerName
* @param data data
* @param callBack CallBackFunction
*/
public void callHandler(String handlerName, String data, OnBridgeCallback callBack) {
doSend(handlerName, data, callBack);
}
public void onPageFinished() {
webViewLoadLocalJs();
if (getStartupMessage() != null) {
for (Message m : getStartupMessage()) {
dispatchMessage(m);
}
setStartupMessage(null);
}
}
private void webViewLoadLocalJs() {
String jsContent = BridgeUtil.assetFile2Str(webView.getContext(), BridgeHelper.BRIDGE_JS);
loadUrl("javascript:" + jsContent);
}
public boolean shouldOverrideUrlLoading(String url) {
try {
// decode 之前,处理 % 和 +
String replacedUrl = url.replaceAll("%(?![0-9a-fA-F]{2})", "%25").replaceAll("\\+", "%2B");
url = URLDecoder.decode(replacedUrl, "UTF-8");
} catch (UnsupportedEncodingException e) {
Log.w(TAG, e);
}
if (url.startsWith(BridgeUtil.YY_RETURN_DATA)) { // 如果是返回数据
handlerReturnData(url);
return true;
} else if (url.startsWith(BridgeUtil.YY_OVERRIDE_SCHEMA)) { //
flushMessageQueue();
return true;
}
return false;
}
@Override
public void sendToWeb(String data) {
sendToWeb(data, (OnBridgeCallback) null);
}
@Override
public void sendToWeb(String data, OnBridgeCallback responseCallback) {
doSend(null, data, responseCallback);
}
@Override
public void sendToWeb(String function, Object... values) {
if (Thread.currentThread() == Looper.getMainLooper().getThread()) {
String jsCommand = String.format(function, values);
jsCommand = String.format(BridgeUtil.JAVASCRIPT_STR, jsCommand);
loadUrl(jsCommand);
}
}
}