本文基于上文Hybrid混合开发知识点(一)的部分示例,阐述下我采用的JsBridge框架协议的思路,期间也对比了市场上的其他JsBridge框架,后续文章会付上源码解析。
JsBridge桥协议
在Hybrid混合开发中,很多场景需要H5与Android交互通信。为避免硬编码造成的臃肿现象,需要统一Android和H5交互的路由协议。
- 为js添加Java映射对象AppBridgeManager.class
//H5调用Android
t.webview.addJavascriptInterface(new AppBridgeManager(t.webview), "app_bridge");
- AppBridgeManager类中统一处理映射对象方法调用
public class AppBridgeManager {
private WebView webView;
private Gson gson = new Gson();
public AppBridgeManager(WebView webview) {
this.webView = webview;
}
@JavascriptInterface
public String appInvoke(String json) {
String string = "";
try {
JsBridgeModel jsBridgeModel = gson.fromJson(json, JsBridgeModel.class);
string = invoke(jsBridgeModel);
} catch (JsonParseException e) {
e.printStackTrace();
}
return string;
}
/**
* 通过反射机制动态调用解析类方法
*
* @param jsBridgeModel
* @return
*/
private String invoke(JsBridgeModel jsBridgeModel) {
if (jsBridgeModel == null) return "";
//H5返回的service要和注册bridgeModelMap的key一致,确保唯一性
Class model = App.bridgeModelMap.get(jsBridgeModel.getService());
if (model == null) return "";
String result = "";
try {
//参数类型格式统一,便于反射动态调用
Method method = model.getMethod(
jsBridgeModel.getMethod(),
String.class,
String.class,
WebView.class);
JSONObject jsonObject = new JSONObject(jsBridgeModel.getData());
if (jsonObject == null) return "";
method.setAccessible(true);//忽略访问权限的限制
result = (String) method.invoke(
model.newInstance(),
jsBridgeModel.getRequestId(),
jsonObject.toString(),
webView);
} catch (NoSuchMethodException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
} catch (InstantiationException e) {
e.printStackTrace();
}
return result;
}
}
采用Method.invoke()反射机制,在运行时动态调用具体业务的类方法,可实现在此统一处理H5与Android的交互协议。
需要满足一下几点:
- H5调用Android的映射方法参数里格式统一,推荐json结构体形式,如示例JsBridgeModel.class:
//json结构体
{
"requestId":"1231313",
"service":"forward",
"method":"H5Page",
"data":{
//data内部结构体根据业务灵活选择
"url":"http://baidu.com",
"newPage":false
}
}
//json实体类
public class JsBridgeModel {
private String requestId;
private String service;
private String method;
private Map data;
}
service代表的模块,比如"service":"forward"代表跳转动作。method代表方法名称,比如"method":"H5Page"代表跳转H5页面,若json回传值为"method":"nativePage",表示跳转原生页面。这里"method":"H5Page"的value就是Method.invoke()映射调用的方法。
- 在Application类中的Map集合中注册具体业务映射类。
public static HashMap> bridgeModelMap = new HashMap<>();
/**
* 注册jsBridge协议类
*/
private void registerBridgeModel() {
bridgeModelMap.put("forward", ForwardPageModule.class);
}
- 实现具体映射类业务。
public class ForwardPageModule {
public void H5Page(String requsetId, String data, WebView webView) {
// {
// "url":"http://baidu.com",
// "newPage":false
// }
}
public void nativePage(String requsetId, String data, WebView webView) {
}
}
如上注释中的数据,通过Gson解析参数data获得对应值,结合ActivityLifecycleCallbacks获取当前activity,实现页面跳转逻辑。其他非页面跳转的业务同理。
Java的反射机制
- 支持运行时判断任意对象所属的类;
- 支持运行时构造任意类的对象实例;
- 支持运行时判断任意类的成员变量和方法;
- 支持运行时调用任意对象的方法;
- 支持动态代理;
Method的getMethod()可根据方法名称和相关参数,定位到需要查找的Method对象。
@CallerSensitive
public Method getMethod(String name, Class... parameterTypes)
throws NoSuchMethodException, SecurityException {
return getMethod(name, parameterTypes, true);
}
根据源码可知,参数类型须对象类型,如int->Integer.class。在上述示例中,
Method method = model.getMethod(
jsBridgeModel.getMethod(),
String.class,
String.class,
WebView.class);
对应的解析类中的方法参数格式要统一,否则会抛出NoSuchMethodException。
public void H5Page(String requsetId, String data, WebView webView) {}
根据定位到的Method对象,可通过invoke()动态调用包装在Method对象中的公开方法,如上例。
资源文件预加载
每加载一个H5页面,会产生很多网络请求。因此对于变动较少的页面可存储在assets文件目录中,提升了H5页面加载效率,降低了网络环境对此的影响。
- shouldInterceptRequest中拦截资源文件并加载本地文件(适用于大容量、重复使用的资源文件)
@Override
public WebResourceResponse shouldInterceptRequest(WebView view, WebResourceRequest request) {
//非UI线程,若return null 则自行请求网络加载资源
WebResourceResponse webResourceResponse = null;
if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.LOLLIPOP) {
String url = request.getUrl().toString();
if (url.contains("baidu")) {
try {
InputStream inputStream = getAssets().open("lauch.png");
webResourceResponse =
new WebResourceResponse("image/png", "UTF-8", inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
}
//return super.shouldInterceptRequest(view, request);
return webResourceResponse;
}
如上,shouldInterceptRequest方法是在非UI线程中执行的,若return null,则默认加载网上资源。另外注意版本兼容。
加载URL中的资源文件如图片时,可将图片资源存放在assets文件目录中,并在WebViewClient#shouldInterceptRequest()方法拦截URL时,判断所加载资源URL并替换为加载本地资源文件。此方案可大幅度提高H5页面资源加载效率,省电省流量且用户无感知。
- assets文件目录加载资源
res目录下的资源文件是参与编译的,assets目录下的资源文件是原生资源文件不参与编译。但两者都绑定在apk文件中,不会解压到/data/data/包名目录下。
webView.loadUrl("file:///android_asset/web/index.html");
后续会继续针对开源Hybrid混合框架源码解析,敬请期待。