Log.i(“CommonWebViewClient”, “shouldOverrideUrlLoading execute------>”)
return true;
}
return super.shouldOverrideUrlLoading(view, url);
}
@JavascriptInterface
在 Android 4.2以下有安全漏洞, 但目前我们的app大部份最小支持版本都已经升到5.0了,这个可以忽略,当然感兴趣可以自己搜索。
在native层面,我们需为要WebView注入一个对象,用来处理两边的数据交互。注入方式如下:
- 首先定义一个类来处理两边的交互:
public class HybridAPI {
public static final String TAG = “HybridAPI”;
@JavascriptInterface
public void sendToNative(final String message) {
Log.i(TAG, “get data from js------------>” + message);
}
}
- 在
WebView
中注入这个类的实例
HybridAPI hybridAPI = new HybridAPI();
webview.addJavascriptInterface(hybridAPI, “HybridAPI”)
在网页中直接用如下代码便可以将数据发送到native端
HybridAPI.sendToNative(‘Hello’);
iframe
我们还可以利用iframe
进行请求伪造向native端发送数据的。思路是向网页中添加一个iframe
控件,通过修改其src
属性,触发native端的shouldOverrideUrlLoading
方法的执行, 同样,native端通过重写该方法,去拿到js端传过来的数据。具体操作方式如下:
var iframe = document.createElement(‘iframe’);
iframe.style.display = ‘none’;
document.documentElement.appendChild(iframe);
iframe.src=“native://getUserInfo?id=1”;
在操作完成后,我们再从当前的dom结构中移除这个组件。
setTimeout(function() {
iframe && iframe.parentNode && iframe.parentNode.removeChild(iframe);
}, 100);
具体实践
在前面总结了WebView和Native交互的几种方案。但距离实际项目使用还有一段距离,在实际项目开发中还有很多问题需要考虑。如:
- 交互的规则如何定义
- 数据如何传递
- 调用之后,如何拿到回调的结果
- 对于Javascript的请求,native端应该如何设计?
- …
native端向JavaScript发送消息只有loadUrl
, evaluateJavascript
这两种方式。Javascript向native端发送信息可以利用onJsPrompt
, @JavascriptInterface
, shouldOverrideUrlLoading
等几种方案,以下 我们通过采用@JavascriptInterface
这种方式(也就是大家通常说的注解方案)为例来看看如何解决实际项目开发中碰到的问题。
交互的规则
首先我们来定义两端的交互规则。
Javascript向native发数据:
我们约定在H5中采用HybridAPI.sendToNative
方法向native端发送数据,于是我们需要在native端做如下支持:
- 定义一个
HybridAPI
类,并向WebView中注册
HybridAPI hybridAPI = new HybridAPI(this);
webview.addJavascriptInterface(hybridAPI, “HybridAPI”);
- 在
HybridAPI
类中定义一个方法sendToNative
, 该方法暴露给Javascript用来给native发送数据
@JavascriptInterface
public void sendToNative(final String message) {
Log.i(TAG, “get data from js------------>” + message);
}
native层向Javascript发数据:
public final String TO_JAVASCRIPT_PREFIX = “javascript:HybridAPI.onReceiveData(‘%s’)”;
public void sendToJavaScript(Map<String, Object> message) {
String str = new Gson().toJson(message);
final String jsCommand = String.format(TO_JAVASCRIPT_PREFIX, escapeString(str));
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
evaluateJavascript(jsCommand, null);
} else {
loadUrl(jsCommand);
}
}
在H5中,我们这样写, 当native向Javascript发送数据时,便会触发Javascript中的Hybrid.onReceiveData
方法, 该方法就能接收到native层传过来的数据
HybridAPI.onReceiveData = function(message) {
console.log(‘[response from native]’ + message);
}
数据结构的定义
在上面我们已经基于@JavascriptInterface
方案完成了native与WebView间通信机制的实现,双方可以交换数据,但开发的时候需要考虑更多问题。比如,如果是Javascript向native发送数据,需要将数据转换成一个字符串,然后再将字符串发给native, native再去解析这个字符串,找到对应的处理方法,提取出相关的业务参数,再进行相应的处理。所以我们需要定义这个字符串的数据结构。
在上面我们已经约定了,H5端可以采用HybridAPI.sendToNative
向native发送数据,该方法只有一个字符串参数, 以获取用户信息
这个业务功能为例,我们的字符串参数是native://getUserInfo?id=1
,这个字符串中的getUserInfo
表示当前通信的目的或行为(为了拿用户信息), ?
后面的id=1
表示的是参数(用户id为1), 如果参数多了,这个字符串会更长,再如果上面涉及到中文的转码,其可读性会大大降低,所以这种交互方式不够直观和友好,我们期望用户采用下面这个方法去与native通信:
HybridAPI.invoke(methodName, params, callbackFun)
methodName
: 当前通信的行为params
: 传递的参数callbackFun
: 接收native端的返回数据
于是,我们在js层面进行一层的封装
var callbackId = 0;
var callbackFunList = {}
HybridAPI.invoke = function(method, params, callbackFun) {
var message = {
method,
params
}
if (callbackFun) {
callbackId = callbackId + 1;
message.id = ‘Hybrid_CB_’ + callbackId;
callbackFunList[callbackId] = callbackFun
}
HybridAPI.sendToNative(JSON.stringify(message));
}
最终还是调用的是sendToNative
与native层进行通信,但是采用HybridAPI.invoke
方法对开发者更加友好。
由于需要在执行成功后调用回调函数。为此在发送消息的时候先把callbackFun
保存起来,在执行成功后再响应。 当Javascript请求发送到native层时,会触发sendToNative
方法,在该方法中, 我们来解析前端的数据:
@JavascriptInterface
public void sendToNative(final String message) {
JSONObject object = DataUtil.str2JSONObject(message);
if (object == null) {
return;
}
final String callbackId = DataUtil.getStrInJSONObject(object, “id”);
final String method = DataUtil.getStrInJSONObject(object, “method”);
final String params = DataUtil.getStrInJSONObject(object, “params”);
handleAPI(method, params, callbackId);
}
private void handleAPI(String method, String params, String callbackId) {
if (“getDeviceInfo”.equals(method)) {
getDeviceInfo();
} else if (“getUserInfo”.equals(method)) {
getUserInfo();
} else if (‘login’.equals(method)) {
login();
}
…
}
native端在处理完成后,再调用evaluateJavascript
或loadUrl
方法,反馈给前端。操作流程示例:
//指定了js端的接收入口
public final String TO_JAVASCRIPT_PREFIX = “javascript:HybridAPI.onReceiveData(‘%s’)”;
public void callJs() {
Map<String, Object> responseData = new HashMap<>();
responseData.put(“error”, error);
responseData.put(“data”, result);
//回调函数的id标识,返回给js,这样才能找到对应的回调函数
responseData.put(“id”, callbackId);
sendToJavaScript(responseData);
}
public void sendToJavaScript(Map<String, Object> message) {
String str = new Gson().toJson(message);
final String jsCommand = String.format(TO_JAVASCRIPT_PREFIX, escapeString(str));
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
evaluateJavascript(jsCommand, null);
} else {
loadUrl(jsCommand);
}
}
// 转义
private String escapeString(String javascript) {
String result;
result = javascript.replace(“\”, “\\”);
result = result.replace(“”“, “\””);
result = result.replace(“'”, “\'”);
result = result.replace(“\n”, “\n”);
result = result.replace(“\r”, “\r”);
result = result.replace(“\f”, “\f”);
return result;
}
在上面的callJs
方法中组织好相关的数据,然后利用Gson
进行序列化,再转进行字符串的转义,最终调用evaluateJavascript
或者loadUrl
来传递给js。于是js端便可以利用HybridAPI.onReceiveData
来接收到。
还记得这段代码中定义的callbackFunList
吗?在上面native给js返回数据的时候,会带上一个id
, 我们可以根据这个id找到本次通信的回调函数,然后将数据回调过去。
var callbackId = 0;
var callbackFunList = {} //看这里
HybridAPI.invoke = function(method, params, callbackFun) {
var message = {
method,
params
}
if (callbackFun) {
callbackId = callbackId + 1;
message.id = ‘Hybrid_CB_’ + callbackId;
callbackFunList[callbackId] = callbackFun
}
HybridAPI.sendToNative(JSON.stringify(message));
}
所以,我们js端接收数据,可能是这样子:
HybridAPI.onReceiveData = function(message) {
var callbackFun = this.callbackFunList[message.id];
if (callbackFun) {
callbackFun(message.error || null, message.data);
}
delete this.callbackFunList[message.id];
}
再回到我们上面的获取用户信息
这个业务功能,我们的写法就会是这样子了:
HybridAPI.invoke(‘getUserInfo’, {“id”: “1”}, function(error, data) {
if (error) {
console.log(‘获取用户信息失败’);
} else {
console.log(‘username:’ + data.username + ‘, age:’ + data.age);
}
});
至此,我们就将一具完整的数据通信流程实现了,由js端用HybridAPI.invoke(method, params, callbackFun)
来向native端来发送数据,native处理完毕后,js端通过callbackFun
来接收数据。
改进
在上面的java代码中,我们可以看到,native层的入口是sendToNative
方法,该方法中解析传入的字符串,再交给handleAPI
方法来处理
@JavascriptInterface
public void sendToNative(final String message) {
总结
技术学到手后,就要开始准备面试了,找工作的时候一定要好好准备简历,毕竟简历是找工作的敲门砖,还有就是要多做面试题,复习巩固。
处理完毕后,js端通过callbackFun
来接收数据。
改进
在上面的java代码中,我们可以看到,native层的入口是sendToNative
方法,该方法中解析传入的字符串,再交给handleAPI
方法来处理
@JavascriptInterface
public void sendToNative(final String message) {
总结
技术学到手后,就要开始准备面试了,找工作的时候一定要好好准备简历,毕竟简历是找工作的敲门砖,还有就是要多做面试题,复习巩固。