happydog-intj /JsBridge
android java and javascript bridge, inspired by wechat webview jsbridge
★ 9,908⑂ 1,997👁 250⑃ 41● 239▤ 0
-1
Daily
9,908
stars
1,997
forks
250
watchers
41
prs
239
issues
0
releases
README
JsBridge
Android WebView 与 JavaScript 双向通信桥接库。
A bridge between Java and JavaScript for Android WebView, providing safe bidirectional communication.
English | 中文文档
Architecture
!JsBridge Architecture
Demo
!JsBridge Demo
---
Installation
groovy
// settings.gradle or build.gradle (project level)
repositories {
maven { url "https://jitpack.io" }
}
// build.gradle (module level)
dependencies {
implementation 'com.github.happydog-intj:JsBridge:v2.1.0'
}
Quick Start (BridgeWebView)
Add BridgeWebView to your layout:
xml
Initialize in your Activity:
java
BridgeWebView webView = findViewById(R.id.webView);
webView.setGson(new Gson());
// Register @JavascriptInterface handler
webView.addJavascriptInterface(
new MainJavascriptInterface(
webView.getCallbacks(),
webView.getPersistentCallbacks(),
webView),
"WebViewJavascriptBridge");
webView.loadUrl("file:///android_asset/demo.html");
Java → JavaScript
Register a JS handler, then call it from Java:
javascript
// JavaScript: register a handler
WebViewJavascriptBridge.registerHandler("functionInJs", function(data, responseCallback) {
document.getElementById("show").innerHTML = "data from Java: = " + data;
responseCallback("Javascript Says Right back aka!");
});
java
// Java: call the JS handler
webView.callHandler("functionInJs", new Gson().toJson(user), new OnBridgeCallback() {
@Override
public void onCallBack(String data) {
Log.d(TAG, "response from JS: " + data);
}
});
JavaScript → Java
Register a @JavascriptInterface method, then call it from JS:
java
// Java: create a JavascriptInterface class
public class MainJavascriptInterface extends BridgeWebView.BaseJavascriptInterface {
private WebViewJavascriptBridge mWebView;
public MainJavascriptInterface(Map callbacks,
Map persistentCallbacks,
WebViewJavascriptBridge webView) {
super(callbacks, persistentCallbacks);
mWebView = webView;
}
@Override
public String send(String data) {
return "default response";
}
@JavascriptInterface
public void submitFromWeb(String data, String callbackId) {
Log.d("JSInterface", "data from web: " + data);
mWebView.responseFromWeb("response from Java", callbackId);
}
}
javascript
// JavaScript: call the Java handler
WebViewJavascriptBridge.callHandler(
'submitFromWeb',
{'param': 'value'},
function(responseData) {
document.getElementById("show").innerHTML = "response: " + responseData;
}
);
Persistent Callbacks
By default, callbacks are removed after first invocation. Use persistent callbacks for multi-response scenarios (real-time updates, event streams):
java
// Java: callback survives multiple invocations
webView.callHandlerPersistent("functionInJs", data, new OnBridgeCallback() {
@Override
public void onCallBack(String data) {
Log.d(TTop issues
#160registerHandler方法中,可以收到JS传参,但是通过oncallBack方法,js收不到21 comments · 2018-11-07#3BridgeUtil.SPLIT_MARK使用 “/”是个糟糕的决定11 comments · 2015-06-02#137多次调用registerHandler方法失效,去掉setWebViewClient方法就好了 10 comments · 2018-07-16#196基于该库及集成腾讯x5的封装提供,能解决很多问题...7 comments · 2019-10-15#119存在多个致命bug!7 comments · 2018-01-23#81js调用java中的callback回调不成功,js收不到消息7 comments · 2017-04-03#17iframe 无法创建6 comments · 2015-11-17#2can not choose file in android 4.4 and upper version6 comments · 2015-05-27