The library of the bridge between Android native and JavaScript
Google native has a set of communication, in fact, it can also complete callback interaction, mainly through interface annotation. But JavaScript needs to define the global method
repositories {
// ...
maven { url "https://jitpack.io" }
}
dependencies {
implementation 'com.github.zorozhao:X5Bridge:0.1'
}add com.x5bridgelibrary.jsbridge.BridgeWebViewto your layout, it is inherited from WebView.
> manifests
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.READ_SETTINGS" />
<uses-permission
android:name="android.permission.WRITE_SETTINGS"
tools:ignore="ProtectedPermissions" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission
android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"
tools:ignore="ProtectedPermissions" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<!-- Hardware acceleration is very important for X5 video playback. -->
<uses-permission android:name="android.permission.GET_TASKS" />
> application
X5bridgeManager.getInstance().preInitX5Core(this);
> activity
MainActivity extends AppCompatActivity implements X5EventListener
@Override
public int obtainLayoutId() {
return R.id.x5webview;
}
@Override
public void onPageStarted(String url, Bitmap favicon) {
Log.d(TAG, "onPageStarted: " + url);
}
@Override
public void onPageFinished(String url) {
Log.d(TAG, "onPageFinished: " + url);
}
public X5HandlerListener initX5HandlerListener() {
x5HandlerListener = X5bridgeManager
.getInstance()
.setX5EventListener(this)
.setActivity(MainActivity.this)
.getX5HandlerListener();
return x5HandlerListener;
} x5HandlerListener.registerHandler("submitFromWeb", new BridgeHandler() {
@Override
public void handler(String data, CallBackFunction function) {
Log.i(TAG, "handler = submitFromWeb, data from web = " + data);
function.onCallBack("submitFromWeb exe, response data from Java");
}
});js can call this Java handler method "submitFromWeb" through:
WebViewJavascriptBridge.callHandler(
'submitFromWeb'
, {'param': str1}
, function(responseData) {
document.getElementById("show").innerHTML = "send get responseData from java, data = " + responseData
}
);You can set a default handler in Java, so that js can send message to Java without assigned handlerName
Already built in the three party Library
// webView.setDefaultHandler(new DefaultHandler()); window.WebViewJavascriptBridge.send(
data
, function(responseData) {
document.getElementById("show").innerHTML = "repsonseData from java, data = " + responseData
}
); WebViewJavascriptBridge.registerHandler("functionInJs", function(data, responseCallback) {
document.getElementById("show").innerHTML = ("data from Java: = " + data);
var responseData = "Javascript Says Right back aka!";
responseCallback(responseData);
});Java can call this js handler function "functionInJs" through:
x5HandlerListener.callHandler("functionInJs", new Gson().toJson(user), new CallBackFunction() {
@Override
public void onCallBack(String data) {
}
});You can also define a default handler use init method, so that Java can send message to js without assigned handlerName
for example:
bridge.init(function(message, responseCallback) {
console.log('JS got a message', message);
var data = {
'Javascript Responds': 'Wee!'
};
console.log('JS responding with', data);
responseCallback(data);
}); x5HandlerListener.send("hello");will print 'JS got a message hello' and 'JS responding with' in webview console.
This lib will inject a WebViewJavascriptBridge Object to window object. So in your js, before use WebViewJavascriptBridge, you must detect if WebViewJavascriptBridge exist. If WebViewJavascriptBridge does not exit, you can listen to WebViewJavascriptBridgeReady event, as the blow code shows:
if (window.WebViewJavascriptBridge) {
//do your work here
} else {
document.addEventListener(
'WebViewJavascriptBridgeReady'
, function() {
//do your work here
},
false
);
}This project is licensed under the terms of the apache 2.0 license.