android webview与js实现互调
·序言
随着移动端网络速度的逐步提升,近些年各大主流app基本都通过嵌入浏览器,如聚划算、淘宝、京东等。
·优缺点
优点是:
1.开发的效率高,省时间,跨平台(android和ios可以用一套),节约开发成本。
2.版本更新方便,只需要替换后台网页内容,避免了每次小改动都要升级app,尤其是app store的审核。
3.测试方便,避免了iso和andorid分开开发导致的部分逻辑和实现细节的差异,节约测试成本。
4.后期维护方便,节约维护成本。
缺点是:
1.新技术兼容性差,原生+h5综合人才少。
2.不能直接调用终端硬件,影响性能。
3.用户体验差(个人感受)
混合App开发是未来的趋势,目前混合开发中使用的技术也很多,主要的混合开发技术有jQuery Mobile、React Native、Cordova、APICloud、AppCan等。虽然混合开发能够提高效率节省成本,但也有很多的限制,除了硬件、缓存等的限制,各大平台之间的兼容性也不足。有的也比较消耗资源。耗电
·目录(android调用js代码以及js调用andorid代码,两者之间的桥梁是webview)
对于Android调用JS代码的方法有2种:
- 通过
WebView
的loadUrl()
- 通过
WebView
的evaluateJavascript()
对于JS调用Android代码的方法有3种:
- 通过
WebView
的addJavascriptInterface()
进行对象映射 - 通过
WebViewClient
的shouldOverrideUrlLoading ()
方法回调拦截 url - 通过
WebChromeClient
的onJsAlert()
、onJsConfirm()
、onJsPrompt()
方法回调拦截JS对话框alert()
、confirm()
、prompt()
消息
1.android调用js代码
方法1:通过WebView
的loadUrl()
案例:
第一步:创建html
需要创建一个.html文件放在andorid的src/main/assets文件夹下(小基础补充:android的assets文件夹和raw文件夹的内容不会随着打包而压缩),这里我们命名为js.html。
- html代码
// 文本名:js
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>LeBron James Happy Birthday!</title>
// JS代码
<script>
// Android需要调用的方法
function callJS(){
alert("Android调用了JS的callJS方法");
}
</script>
</head>
</html>
第二步:在androidi中通过webview调用js
mainActivity代码
public class MainActivity extends AppCompatActivity {
private WebView mWebView;
private Button button;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
mWebView =(WebView) findViewById(R.id.webview);
WebSettings webSettings = mWebView.getSettings();
// 设置与Js交互的权限
webSettings.setJavaScriptEnabled(true);
// 设置允许JS弹窗
webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
// 先载入JS代码
// 格式规定为:file:///android_asset/文件名.html
mWebView.loadUrl("file:///android_asset/js.html");
button = (Button) findViewById(R.id.button);
button.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
// 通过Handler发送消息
mWebView.post(new Runnable() {
@Override
public void run() {
// 注意调用的JS方法名要对应上
// 调用javascript的callJS()方法
mWebView.loadUrl("js:callJS()");
}
});
}
});
// 由于设置了弹窗检验调用结果,所以需要支持js对话框
// webview只是载体,内容的渲染需要使用webviewChromClient类去实现
// 通过设置WebChromeClient对象处理JavaScript的对话框
//设置响应js 的Alert()函数
mWebView.setWebChromeClient(new WebChromeClient() {
@Override
public boolean onJsAlert(WebView view, String url, String message, final JsResult result) {
AlertDialog.Builder b = new AlertDialog.Builder(MainActivity.this);
b.setTitle("Alert");
b.setMessage(message);
b.setPositiveButton(android.R.string.ok, new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
result.confirm();
}
});
b.setCancelable(false);
b.create().show();
return true;
}
});
}
}
实现效果:
特别注意:JS代码调用一定要在 onPageFinished()
回调之后才能调用,否则不会调用。
onPageFinished()
属于WebViewClient类的方法,主要在页面加载结束时调用
方法2:通过WebView
的evaluateJavascript()
andorid代码
// 只需要将第一种方法的loadUrl()换成下面该方法即可
mWebView.evaluateJavascript("js:callJS()", new ValueCallback<String>() {
@Override
public void onReceiveValue(String value) {
//此处为 js 返回的结果
}
});
}
loadUrl()与evaluateJavascript()对比
2.js通过webview调用android代码
方法1:通过WebView
的addJavascriptInterface()
进行对象映射
第一步:定义一个和js对象映射的andorid类,AndroidWithJS.java
// 继承自Object类
public class AndroidWithJS extends Object {
// 定义JS需要调用的方法
// 被JS调用的方法必须加入@JavascriptInterface注解
@JavascriptInterface
public void formJs(String msg) {
System.out.println("JS调用了Android的fromJs方法");
}
}
第二步:创建一个.html文件放在andorid的src/main/assets文件夹下,js.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>LeBron Happy Birtinday!</title>
<script>
function callAndroid(){
// 由于对象映射,所以调用test对象等于调用Android映射的对象
test.fromJS("js调用了android中的fromJS方法");
}
</script>
</head>
<body>
//点击按钮则调用callAndroid函数
<button type="button" id="button1" onClick="callAndroid()"></button>
</body>
</html>
第三步:在android代码中通过webView建立Android类和js的映射关系
public class MainActivity extends AppCompatActivity {
private WebView mWebView;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
mWebView = (WebView) findViewById(R.id.webview);
WebSettings webSettings = mWebView.getSettings();
// 设置与Js交互的权限
webSettings.setJavaScriptEnabled(true);
// 通过addJavascriptInterface()将Java对象映射到JS对象
//参数1:Java对象名
//参数2:Javascript对象名
mWebView.addJavascriptInterface(new AndroidtoJs(), "test");//AndroidWithJS类对象映射到js的test对象
// 加载JS代码
// 格式规定为:file:///android_asset/文件名.html
mWebView.loadUrl("file:///android_asset/js.html");
方法2:通过 WebViewClient
的方法shouldOverrideUrlLoading ()
回调拦截 url
第一步:同上 js.html文件放在src/main/assets文件夹下
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>LeBron James Happy Birthday!</title>
<script>
function callAndroid(){
/*约定的url协议为:js://james/12/31
document.location = "js://james/12/31";
}
</script>
</head>
<!-- 点击按钮则调用callAndroid()方法 -->
<body>
<button type="button" id="button1" onclick="callAndroid()">点击调用Android代码</button>
</body>
</html>
第二步:在Android通过WebViewClient复写shouldOverrideUrlLoading ()
public class MainActivity extends AppCompatActivity {
WebView mWebView;
// Button button;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
mWebView = (WebView) findViewById(R.id.webview);
WebSettings webSettings = mWebView.getSettings();
// 设置与Js交互的权限
webSettings.setJavaScriptEnabled(true);
// 设置允许JS弹窗
webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
// 步骤1:加载JS代码
// 格式规定为:file:///android_asset/文件名.html
mWebView.loadUrl("file:///android_asset/js.html");
// 复写WebViewClient类的shouldOverrideUrlLoading方法
mWebView.setWebViewClient(new WebViewClient() {
@Override
public boolean shouldOverrideUrlLoading(WebView view, String url) {
// 步骤2:根据协议的参数,判断是否是所需要的url
// 一般根据scheme(协议格式) & authority(协议名)判断(前两个参数) 注意:authority是url中//后面的字符串,注意约定的格式规范
//假定传入进来的 url = "js://james/12/31"(同时也是约定好的需要拦截的)
Uri uri = Uri.parse(url);
// 如果url的协议 = 预先约定的 js 协议
// 就解析往下解析参数
if (null!=uri&&null!=uri.getScheme()&& uri.getScheme().equals("js")) {
// 如果 authority = 预先约定协议里的 webview,即代表都符合约定的协议
// 所以拦截url,下面JS开始调用Android需要的方法
if (null!=uri.getAuthority()&&uri.getAuthority().equals("james")) {
// 步骤3:
// 执行JS所需要调用的逻辑
System.out.println("js调用了Android的方法");
// 可以在协议上带有参数并传递到Android上
HashMap<String, String> params = new HashMap<>();
Set<String> collection = uri.getQueryParameterNames();
}
return true;
}
return super.shouldOverrideUrlLoading(view, url);
}
}
);
}
}
如果JS想要得到Android方法的返回值,只能通过 WebView 的 loadUrl ()
去执行 JS 方法把返回值传递回去,相关的代码如下:
// Android:MainActivity.java
mWebView.loadUrl("js:returnResult(" + result + ")");
// JS:js.html
function returnResult(result){
alert("result is" + result);
}
方法3:通过 WebChromeClient
的onJsAlert()
、onJsConfirm()
、onJsPrompt()
方法回调拦截JS对话框alert()
、confirm()
、prompt()
消息
在JS中,有三个常用的对话框方法:
下面的例子将用**拦截 JS的输入框(即prompt()
方法)**说明 :
- 常用的拦截是:拦截 JS的输入框(即
prompt()
方法)- 因为只有
prompt()
可以返回任意类型的值,操作最全面方便、更加灵活;而alert()对话框没有返回值;confirm()对话框只能返回两种状态(确定 / 取消)两个值
第一步:以.html格式放到src/main/assets文件夹里
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>LeBron James Happy Birthday!</title>
<script>
function clickprompt(){
// 调用prompt()
var result=prompt("js://demo?arg1=111&arg2=222");
alert("demo " + result);
}
</script>
</head>
<!-- 点击按钮则调用clickprompt() -->
<body>
<button type="button" id="button1" click="clickprompt()">点击调用Android代码</button>
</body>
</html>
当使用mWebView.loadUrl("file:///android_asset/js.html")
加载了上述JS代码后,就会触发回调onJsPrompt()
,具体如下:
- 如果是拦截警告框(即
alert()
),则触发回调onJsAlert()
;- 如果是拦截确认框(即
confirm()
),则触发回调onJsConfirm()
;
第二步:在Android通过WebChromeClient
复写onJsPrompt()
public class MainActivity extends AppCompatActivity {
WebView mWebView;
// Button button;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
mWebView = (WebView) findViewById(R.id.webview);
WebSettings webSettings = mWebView.getSettings();
// 设置与Js交互的权限
webSettings.setJavaScriptEnabled(true);
// 设置允许JS弹窗
webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
// 先加载JS代码
// 格式规定为:file:///android_asset/文件名.html
mWebView.loadUrl("file:///android_asset/js.html");
mWebView.setWebChromeClient(new WebChromeClient() {
// 拦截输入框(原理同方式2)
// 参数message:代表promt()的内容(不是url)
// 参数result:代表输入框的返回值
@Override
public boolean onJsPrompt(WebView view, String url, String message, String defaultValue, JsPromptResult result) {
// 根据协议的参数,判断是否是所需要的url(原理同方式2)
// 一般根据scheme(协议格式) & authority(协议名)判断(前两个参数)
//假定传入进来的 url = "js://webview?arg1=111&arg2=222"(同时也是约定好的需要拦截的)
Uri uri = Uri.parse(message);
// 如果url的协议 = 预先约定的 js 协议
// 就解析往下解析参数
if ( uri.getScheme().equals("js")) {
// 如果 authority = 预先约定协议里的 webview,即代表都符合约定的协议
// 所以拦截url,下面JS开始调用Android需要的方法
if (uri.getAuthority().equals("webview")) {
//
// 执行JS所需要调用的逻辑
System.out.println("js调用了Android的方法");
// 可以在协议上带有参数并传递到Android上
HashMap<String, String> params = new HashMap<>();
Set<String> collection = uri.getQueryParameterNames();
//参数result:代表消息框的返回值(输入值)
result.confirm("js调用了Android的方法成功啦");
}
return true;
}
return super.onJsPrompt(view, url, message, defaultValue, result);
}
// 通过alert()和confirm()拦截的原理相同,此处不作过多讲述
// 拦截JS的警告框
@Override
public boolean onJsAlert(WebView view, String url, String message, JsResult result) {
return super.onJsAlert(view, url, message, result);
}
// 拦截JS的确认框
@Override
public boolean onJsConfirm(WebView view, String url, String message, JsResult result) {
return super.onJsConfirm(view, url, message, result);
}
}
);
}
}
js调用Android三种方法小结
总结: