前言
- 現在很多App裡都內建了Web網頁（Hyprid App），比如說很多電商平臺，淘寶、京東、聚划算等等，如下圖
- 上述功能是由Android的WebView實現的，其中涉及到Android客戶端與Web網頁互動的實現
- 今天我將全面介紹Android通過WebView與JS互動的全面方式
閱讀本文前請先閱讀：Android開發：最全面、最易懂的Webview詳解
目錄
1. 互動方式總結
Android與JS通過WebView互相呼叫方法，實際上是：
- Android去呼叫JS的程式碼
- JS去呼叫Android的程式碼
二者溝通的橋樑是WebView
對於Android呼叫JS程式碼的方法有2種：
- 通過
WebView的loadUrl（） - 通過
WebView的evaluateJavascript（）
對於JS呼叫Android程式碼的方法有3種：
- 通過
WebView的addJavascriptInterface（）進行物件對映 - 通過
WebViewClient的shouldOverrideUrlLoading ()方法回撥攔截 url - 通過
WebChromeClient的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回撥攔截JS對話方塊alert()、confirm()、prompt（）訊息
2. 具體分析
2.1 Android通過WebView呼叫 JS 程式碼
對於Android呼叫JS程式碼的方法有2種：
- 通過
WebView的loadUrl（） - 通過
WebView的evaluateJavascript（）
方式1：通過WebView的loadUrl（）
- 例項介紹：點選Android按鈕，即呼叫WebView JS（文字名為
javascript）中callJS（） - 具體使用：
步驟1：將需要呼叫的JS程式碼以.html格式放到src/main/assets資料夾裡
- 為了方便展示，本文是採用Andorid呼叫本地JS程式碼說明；
- 實際情況時，Android更多的是呼叫遠端JS程式碼，即將載入的JS程式碼路徑改成url即可
需要載入JS程式碼：javascript.html
// 文字名：javascript
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Carson_Ho</title>
// JS程式碼
<script>
// Android需要呼叫的方法
function callJS(){
alert("Android呼叫了JS的callJS方法");
}
</script>
</head>
</html>
複製程式碼步驟2：在Android裡通過WebView設定呼叫JS程式碼
Android程式碼：MainActivity.java
註釋已經非常清楚
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/javascript.html");
button = (Button) findViewById(R.id.button);
button.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
// 必須另開執行緒進行JS方法呼叫(否則無法呼叫)
mWebView.post(new Runnable() {
@Override
public void run() {
// 注意呼叫的JS方法名要對應上
// 呼叫javascript的callJS()方法
mWebView.loadUrl("javascript: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（）
- 優點：該方法比第一種方法效率更高、使用更簡潔。
- 因為該方法的執行不會使頁面重新整理，而第一種方法（loadUrl ）的執行則會。
- Android 4.4 後才可使用
- 具體使用
// 只需要將第一種方法的loadUrl()換成下面該方法即可
mWebView.evaluateJavascript（"javascript:callJS()", new ValueCallback<String>() {
@Override
public void onReceiveValue(String value) {
//此處為 js 返回的結果
}
});
}
複製程式碼2.1.2 方法對比
2.1.3 使用建議
兩種方法混合使用，即Android 4.4以下使用方法1，Android 4.4以上方法2
// Android版本變數
final int version = Build.VERSION.SDK_INT;
// 因為該方法在 Android 4.4 版本才可使用，所以使用時需進行版本判斷
if (version < 18) {
mWebView.loadUrl("javascript:callJS()");
} else {
mWebView.evaluateJavascript（"javascript:callJS()", new ValueCallback<String>() {
@Override
public void onReceiveValue(String value) {
//此處為 js 返回的結果
}
});
}
複製程式碼2.2 JS通過WebView呼叫 Android 程式碼
對於JS呼叫Android程式碼的方法有3種：
- 通過
WebView的addJavascriptInterface（）進行物件對映 - 通過
WebViewClient的shouldOverrideUrlLoading ()方法回撥攔截 url - 通過
WebChromeClient的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回撥攔截JS對話方塊alert()、confirm()、prompt（）訊息
2.2.1 方法分析
方式1：通過 WebView的addJavascriptInterface（）進行物件對映
步驟1：定義一個與JS物件對映關係的Android類：AndroidtoJs
AndroidtoJs.java（註釋已經非常清楚）
// 繼承自Object類
public class AndroidtoJs extends Object {
// 定義JS需要呼叫的方法
// 被JS呼叫的方法必須加入@JavascriptInterface註解
@JavascriptInterface
public void hello(String msg) {
System.out.println("JS呼叫了Android的hello方法");
}
}
複製程式碼步驟2：將需要呼叫的JS程式碼以.html格式放到src/main/assets資料夾裡
需要載入JS程式碼：javascript.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Carson</title>
<script>
function callAndroid(){
// 由於物件對映，所以呼叫test物件等於呼叫Android對映的物件
test.hello("js呼叫了android中的hello方法");
}
</script>
</head>
<body>
//點選按鈕則呼叫callAndroid函式
<button type="button" id="button1" onclick="callAndroid()"></button>
</body>
</html>
複製程式碼步驟3：在Android裡通過WebView設定Android類與JS程式碼的對映
詳細請看註釋
public class MainActivity extends AppCompatActivity {
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：Javascript物件名
//引數2：Java物件名
mWebView.addJavascriptInterface(new AndroidtoJs(), "test");//AndroidtoJS類物件對映到js的test物件
// 載入JS程式碼
// 格式規定為:file:///android_asset/檔名.html
mWebView.loadUrl("file:///android_asset/javascript.html");
複製程式碼特點
- 優點：使用簡單
僅將Android物件和JS物件對映即可
- 缺點：存在嚴重的漏洞問題，具體請看文章：你不知道的 Android WebView 使用漏洞
方式2：通過 WebViewClient 的方法shouldOverrideUrlLoading ()回撥攔截 url
- 具體原理：
- Android通過
WebViewClient的回撥方法shouldOverrideUrlLoading ()攔截 url - 解析該 url 的協議
- 如果檢測到是預先約定好的協議，就呼叫相應方法
即JS需要呼叫Android的方法
- 具體使用： **步驟1：**在JS約定所需要的Url協議 JS程式碼：javascript.html
以.html格式放到src/main/assets資料夾裡
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Carson_Ho</title>
<script>
function callAndroid(){
/*約定的url協議為：js://webview?arg1=111&arg2=222*/
document.location = "js://webview?arg1=111&arg2=222";
}
</script>
</head>
<!-- 點選按鈕則呼叫callAndroid（）方法 -->
<body>
<button type="button" id="button1" onclick="callAndroid()">點選呼叫Android程式碼</button>
</body>
</html>
複製程式碼當該JS通過Android的mWebView.loadUrl("file:///android_asset/javascript.html")載入後，就會回撥shouldOverrideUrlLoading （），接下來繼續看步驟2：
步驟2：在Android通過WebViewClient複寫shouldOverrideUrlLoading （）
MainActivity.java
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/javascript.html");
// 複寫WebViewClient類的shouldOverrideUrlLoading方法
mWebView.setWebViewClient(new WebViewClient() {
@Override
public boolean shouldOverrideUrlLoading(WebView view, String url) {
// 步驟2：根據協議的引數，判斷是否是所需要的url
// 一般根據scheme（協議格式） & authority（協議名）判斷（前兩個引數）
//假定傳入進來的 url = "js://webview?arg1=111&arg2=222"（同時也是約定好的需要攔截的）
Uri uri = Uri.parse(url);
// 如果url的協議 = 預先約定的 js 協議
// 就解析往下解析引數
if ( uri.getScheme().equals("js")) {
// 如果 authority = 預先約定協議裡的 webview，即代表都符合約定的協議
// 所以攔截url,下面JS開始呼叫Android需要的方法
if (uri.getAuthority().equals("webview")) {
// 步驟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);
}
}
);
}
}
複製程式碼特點
- 優點：不存在方式1的漏洞；
- 缺點：JS獲取Android方法的返回值複雜。
如果JS想要得到Android方法的返回值，只能通過 WebView 的
loadUrl （）去執行 JS 方法把返回值傳遞回去，相關的程式碼如下：
// Android：MainActivity.java
mWebView.loadUrl("javascript:returnResult(" + result + ")");
// JS：javascript.html
function returnResult(result){
alert("result is" + result);
}
複製程式碼方式3：通過 WebChromeClient 的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回撥攔截JS對話方塊alert()、confirm()、prompt（） 訊息
在JS中，有三個常用的對話方塊方法：
方式3的原理：Android通過 WebChromeClient 的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回撥分別攔截JS對話方塊
（即上述三個方法），得到他們的訊息內容，然後解析即可。
下面的例子將用**攔截 JS的輸入框（即prompt（）方法）**說明 ：
- 常用的攔截是：攔截 JS的輸入框（即
prompt（）方法）- 因為只有
prompt（）可以返回任意型別的值，操作最全面方便、更加靈活；而alert（）對話方塊沒有返回值；confirm（）對話方塊只能返回兩種狀態（確定 / 取消）兩個值
步驟1：載入JS程式碼，如下： javascript.html
以.html格式放到src/main/assets資料夾裡
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Carson_Ho</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" onclick="clickprompt()">點選呼叫Android程式碼</button>
</body>
</html>
複製程式碼當使用mWebView.loadUrl("file:///android_asset/javascript.html")載入了上述JS程式碼後，就會觸發回撥onJsPrompt（），具體如下：
- 如果是攔截警告框（即
alert()），則觸發回撥onJsAlert（）；- 如果是攔截確認框（即
confirm()），則觸發回撥onJsConfirm（）；
步驟2：在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/javascript.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);
}
}
);
}
}
複製程式碼2.2.2 三種方式的對比 & 使用場景
3. 總結
-
本文主要對Android通過WebView與JS的互動方式進行了全面介紹
-
關於
WebView的系列文章希望會對你有所幫助： Android開發：最全面、最易懂的Webview詳解 -
接下來我會繼續講解其他安卓開發的知識，有興趣可以繼續關注Carson_Ho的安卓開發筆記！！！！