目錄
目錄
1. 交互方式總結(jié)
Android與JS通過WebView互相調(diào)用方法聋庵，實際上是：
- Android去調(diào)用JS的代碼
- JS去調(diào)用Android的代碼
二者溝通的橋梁是WebView
對于Android調(diào)用JS代碼的方法有2種：
- 通過WebView的loadUrl（）
- 通過WebView的evaluateJavascript（）
對于JS調(diào)用Android代碼的方法有3種：
- 通過WebView的addJavascriptInterface（）進行對象映射
- 通過 WebViewClient 的shouldOverrideUrlLoading ()方法回調(diào)攔截 url
- 通過 WebChromeClient的onJsAlert()葡缰、onJsConfirm()、onJsPrompt（）方法回調(diào)攔截JS對話框alert()座泳、confirm()羹呵、prompt（）消息
2. 具體分析
2.1 Android通過WebView調(diào)用 JS 代碼
方式1：通過WebView的loadUrl（）
- 實例介紹：點擊Android按鈕优构，即調(diào)用WebView JS（文本名為javascript）中callJS（）
具體使用：
步驟1：將需要調(diào)用的JS代碼以.html格式放到src/main/assets文件夾里
為了方便展示琢融，本文是采用Andorid調(diào)用本地JS代碼說明界牡；
實際情況時，Android更多的是調(diào)用遠(yuǎn)程JS代碼漾抬，即將加載的JS代碼路徑改成url即可
需要加載JS代碼：javascript.html
// 文本名：javascript
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Carson_Ho</title>
// JS代碼
<script>
// Android需要調(diào)用的方法
function callJS(){
alert("Android調(diào)用了JS的callJS方法");
}
</script>
</head>
</html>
步驟2：在Android里通過WebView設(shè)置調(diào)用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();
// 設(shè)置與Js交互的權(quán)限
webSettings.setJavaScriptEnabled(true);
// 設(shè)置允許JS彈窗
webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
// 先載入JS代碼
// 格式規(guī)定為: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方法調(diào)用(否則無法調(diào)用)
mWebView.post(new Runnable() {
@Override
public void run() {
// 注意調(diào)用的JS方法名要對應(yīng)上
// 調(diào)用javascript的callJS()方法
mWebView.loadUrl("javascript:callJS()");
}
});
}
});
// 由于設(shè)置了彈窗檢驗調(diào)用結(jié)果,所以需要支持js對話框
// webview只是載體宿亡，內(nèi)容的渲染需要使用webviewChromClient類去實現(xiàn)
// 通過設(shè)置WebChromeClient對象處理JavaScript的對話框
//設(shè)置響應(yīng)js 的Alert()函數(shù)
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代碼調(diào)用一定要在 onPageFinished（） 回調(diào)之后才能調(diào)用，否則不會調(diào)用纳令。
onPageFinished()屬于WebViewClient類的方法挽荠，主要在頁面加載結(jié)束時調(diào)用
方式2：通過WebView的evaluateJavascript（）
優(yōu)點：
- 該方法比第一種方法效率更高、使用更簡潔泊碑。
- 因為該方法的執(zhí)行不會使頁面刷新坤按，而第一種方法（loadUrl ）的執(zhí)行則會毯欣。
Android 4.4 后才可使用
具體使用
// 只需要將第一種方法的loadUrl()換成下面該方法即可
mWebView.evaluateJavascript（"javascript:callJS()", new ValueCallback<String>() {
@Override
public void onReceiveValue(String value) {
//此處為 js 返回的結(jié)果
}
});
}
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 返回的結(jié)果
}
});
}
2.2 JS通過WebView調(diào)用 Android 代碼
2.2.1 方法分析
- 方式1：通過 WebView的addJavascriptInterface（）進行對象映射
步驟1：定義一個與JS對象映射關(guān)系的Android類：AndroidtoJs
AndroidtoJs.java（注釋已經(jīng)非常清楚）
// 繼承自O(shè)bject類
public class AndroidtoJs extends Object {
// 定義JS需要調(diào)用的方法
// 被JS調(diào)用的方法必須加入@JavascriptInterface注解
@JavascriptInterface
public void hello(String msg) {
System.out.println("JS調(diào)用了Android的hello方法");
}
}
步驟2：將需要調(diào)用的JS代碼以.html格式放到src/main/assets文件夾里
需要加載JS代碼：javascript.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Carson</title>
<script>
function callAndroid(){
// 由于對象映射腹忽，所以調(diào)用test對象等于調(diào)用Android映射的對象
test.hello("js調(diào)用了android中的hello方法");
}
</script>
</head>
<body>
//點擊按鈕則調(diào)用callAndroid函數(shù)
<button type="button" id="button1" onclick="callAndroid()"></button>
</body>
</html>
步驟3：在Android里通過WebView設(shè)置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();
// 設(shè)置與Js交互的權(quán)限
webSettings.setJavaScriptEnabled(true);
// 通過addJavascriptInterface()將Java對象映射到JS對象
//參數(shù)1：Javascript對象名
//參數(shù)2：Java對象名
mWebView.addJavascriptInterface(new AndroidtoJs(), "test");//AndroidtoJS類對象映射到j(luò)s的test對象
// 加載JS代碼
// 格式規(guī)定為:file:///android_asset/文件名.html
mWebView.loadUrl("file:///android_asset/javascript.html");
效果圖
特點
優(yōu)點：使用簡單,僅將Android對象和JS對象映射即可
缺點：存在嚴(yán)重的漏洞問題
方式2：通過 WebViewClient 的方法shouldOverrideUrlLoading ()回調(diào)攔截 url
**具體原理： **
Android通過 WebViewClient 的回調(diào)方法shouldOverrideUrlLoading ()攔截 url解析該 url 的協(xié)議
如果檢測到是預(yù)先約定好的協(xié)議，就調(diào)用相應(yīng)方法即JS需要調(diào)用Android的方法
具體使用：
步驟1：在JS約定所需要的Url協(xié)議
JS代碼：javascript.html
以.html格式放到src/main/assets文件夾里
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Carson_Ho</title>
<script>
function callAndroid(){
/*約定的url協(xié)議為：js://webview?arg1=111&arg2=222*/
document.location = "js://webview?arg1=111&arg2=222";
}
</script>
</head>
<!-- 點擊按鈕則調(diào)用callAndroid（）方法 -->
<body>
<button type="button" id="button1" onclick="callAndroid()">點擊調(diào)用Android代碼</button>
</body>
</html>
當(dāng)該JS通過Android的mWebView.loadUrl("file:///android_asset/javascript.html")加載后砚作，就會回調(diào)shouldOverrideUrlLoading （）窘奏，接下來繼續(xù)看步驟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();
// 設(shè)置與Js交互的權(quán)限
webSettings.setJavaScriptEnabled(true);
// 設(shè)置允許JS彈窗
webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
// 步驟1：加載JS代碼
// 格式規(guī)定為:file:///android_asset/文件名.html
mWebView.loadUrl("file:///android_asset/javascript.html");
// 復(fù)寫WebViewClient類的shouldOverrideUrlLoading方法
mWebView.setWebViewClient(new WebViewClient() {
@Override
public boolean shouldOverrideUrlLoading(WebView view, String url) {
// 步驟2：根據(jù)協(xié)議的參數(shù)，判斷是否是所需要的url
// 一般根據(jù)scheme（協(xié)議格式） & authority（協(xié)議名）判斷（前兩個參數(shù)）
//假定傳入進來的 url = "js://webview?arg1=111&arg2=222"（同時也是約定好的需要攔截的）
Uri uri = Uri.parse(url);
// 如果url的協(xié)議 = 預(yù)先約定的 js 協(xié)議
// 就解析往下解析參數(shù)
if ( uri.getScheme().equals("js")) {
// 如果 authority = 預(yù)先約定協(xié)議里的 webview葫录，即代表都符合約定的協(xié)議
// 所以攔截url,下面JS開始調(diào)用Android需要的方法
if (uri.getAuthority().equals("webview")) {
// 步驟3：
// 執(zhí)行JS所需要調(diào)用的邏輯
System.out.println("js調(diào)用了Android的方法");
// 可以在協(xié)議上帶有參數(shù)并傳遞到Android上
HashMap<String, String> params = new HashMap<>();
Set<String> collection = uri.getQueryParameterNames();
}
return true;
}
return super.shouldOverrideUrlLoading(view, url);
}
}
);
}
}
特點
優(yōu)點：不存在方式1的漏洞着裹；
缺點：JS獲取Android方法的返回值復(fù)雜。
如果JS想要得到Android方法的返回值米同，只能通過 WebView 的 loadUrl （）去執(zhí)行 JS 方法把返回值傳遞回去骇扇，相關(guān)的代碼如下：
// Android：MainActivity.java
mWebView.loadUrl("javascript:returnResult(" + result + ")");
// JS：javascript.html
function returnResult(result){
alert("result is" + result);
}
方式3：通過 WebChromeClient的onJsAlert()摔竿、onJsConfirm()、onJsPrompt（）方法回調(diào)攔截JS對話框alert()少孝、confirm()继低、prompt（） 消息
在JS中，有三個常用的對話框方法：
常用的對話框方法
方式3的原理：Android通過 WebChromeClient 的onJsAlert()稍走、onJsConfirm()袁翁、onJsPrompt（）
方法回調(diào)分別攔截JS對話框 （即上述三個方法），得到他們的消息內(nèi)容婿脸，然后解析即可粱胜。
下面的例子將用攔截 JS的輸入框（即prompt（）方法）
說明 ：
常用的攔截是：攔截 JS的輸入框（即prompt（）方法）因為只有prompt（）可以返回任意類型的值，操作最全面方便狐树、更加靈活年柠；而alert（）對話框沒有返回值；confirm（）對話框只能返回兩種狀態(tài)（確定 / 取消）兩個值
步驟1：加載JS代碼褪迟，如下： javascript.html
以.html格式放到src/main/assets文件夾里
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Carson_Ho</title>
<script>
function clickprompt(){
// 調(diào)用prompt（）
var result=prompt("js://demo?arg1=111&arg2=222");
alert("demo " + result);
}
</script>
</head>
<!-- 點擊按鈕則調(diào)用clickprompt() -->
<body>
<button type="button" id="button1" onclick="clickprompt()">點擊調(diào)用Android代碼</button>
</body>
</html>
當(dāng)使用mWebView.loadUrl("file:///android_asset/javascript.html")加載了上述JS代碼后冗恨，就會觸發(fā)回調(diào)onJsPrompt（），具體如下：
- 如果是攔截警告框（即alert()）味赃，則觸發(fā)回調(diào)onJsAlert（）掀抹；
- 如果是攔截確認(rèn)框（即confirm()），則觸發(fā)回調(diào)onJsConfirm（）心俗；
步驟2：在Android通過WebChromeClient復(fù)寫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();
// 設(shè)置與Js交互的權(quán)限
webSettings.setJavaScriptEnabled(true);
// 設(shè)置允許JS彈窗
webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
// 先加載JS代碼
// 格式規(guī)定為:file:///android_asset/文件名.html
mWebView.loadUrl("file:///android_asset/javascript.html");
mWebView.setWebChromeClient(new WebChromeClient() {
// 攔截輸入框(原理同方式2)
// 參數(shù)message:代表promt（）的內(nèi)容（不是url）
// 參數(shù)result:代表輸入框的返回值
@Override
public boolean onJsPrompt(WebView view, String url, String message, String defaultValue, JsPromptResult result) {
// 根據(jù)協(xié)議的參數(shù)傲武，判斷是否是所需要的url(原理同方式2)
// 一般根據(jù)scheme（協(xié)議格式） & authority（協(xié)議名）判斷（前兩個參數(shù)）
//假定傳入進來的 url = "js://webview?arg1=111&arg2=222"（同時也是約定好的需要攔截的）
Uri uri = Uri.parse(message);
// 如果url的協(xié)議 = 預(yù)先約定的 js 協(xié)議
// 就解析往下解析參數(shù)
if ( uri.getScheme().equals("js")) {
// 如果 authority = 預(yù)先約定協(xié)議里的 webview，即代表都符合約定的協(xié)議
// 所以攔截url,下面JS開始調(diào)用Android需要的方法
if (uri.getAuthority().equals("webview")) {
//
// 執(zhí)行JS所需要調(diào)用的邏輯
System.out.println("js調(diào)用了Android的方法");
// 可以在協(xié)議上帶有參數(shù)并傳遞到Android上
HashMap<String, String> params = new HashMap<>();
Set<String> collection = uri.getQueryParameterNames();
//參數(shù)result:代表消息框的返回值(輸入值)
result.confirm("js調(diào)用了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的確認(rèn)框
@Override
public boolean onJsConfirm(WebView view, String url, String message, JsResult result) {
return super.onJsConfirm(view, url, message, result);
}
});
}
}
效果圖
2.2.2 三種方式的對比 & 使用場景
方式的對比 & 使用場景
