這篇文章給大家分享的是有關Android中WebView與JS交互的示例分析的內容。小編覺得挺實用的,因此分享給大家做個參考,一起跟隨小編過來看看吧。
Android 和 H5 都是移動開發應用的非常廣泛。市面上很多App都是使用Android開發的,但使用Android來開發一些比較復雜附屬類,提示性的頁面是得不償失的。而H5具有開發速度快,更新不用依賴于App的更新,只需要服務端更新相應的頁面即可,所以,App和H5頁面相結合就顯得尤為重要。而android和H5都不可能每次都是獨立存在的,而是相互影響也相互的調用,獲取信息等,例如,H5頁面要獲取App中的用戶的基本信息,或者App端要操作H5頁面等,下面來看看這兩是怎么交互的
目錄

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 代碼
方式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代碼
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 代碼
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對象映射即可
缺點:存在嚴重的漏洞問題
方式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:
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 三種方式的對比 & 使用場景

感謝各位的閱讀!關于“Android中WebView與JS交互的示例分析”這篇文章就分享到這里了,希望以上內容可以對大家有一定的幫助,讓大家可以學到更多知識,如果覺得文章不錯,可以把它分享出去讓更多的人看到吧!
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。