講講為什么要有js與android之間的交互
隨著科技的快速發(fā)展，很多公司都會對移動產(chǎn)品進(jìn)行快速的迭代開發(fā)，降低開發(fā)的成本，來適應(yīng)市場的需求。
有人說js會替代android原生的應(yīng)用，因?yàn)閖s的跨平臺，前端只要通過開發(fā)h5頁面就能很快的在移動手機(jī)中展示，達(dá)到需求的效果。
的確，js開發(fā)確實(shí)能降低不少的勞動成本，同時不需要在發(fā)現(xiàn)bug的時候發(fā)版本，帶來良好的bug修復(fù)效果。但是在某些方面，還是不及原生的效果好，
那么android原生和js通常使用的場景是什么呢？我認(rèn)為在功能性比較強(qiáng)的地方或者流暢度要求比較高的地方，我們會建議用android原生開發(fā)，在更換頻率比較高的地方，會采用js開發(fā)，這樣不僅滿足來我們經(jīng)常更換的需求，同時對流暢度也能有一定的保障。
交互方式總結(jié)
Android與JS通過WebView互相調(diào)用方法，實(shí)際上是：
Android去調(diào)用JS的代碼
JS去調(diào)用Android的代碼
二者溝通的橋梁是WebView
對于Android調(diào)用JS代碼的方法有2種：
1.通過WebView的loadUrl（）
2.通過WebView的evaluateJavascript（）
對于JS調(diào)用Android代碼的方法有3種：
1.通過WebView的addJavascriptInterface（）進(jìn)行對象映射
2.通過 WebViewClient 的shouldOverrideUrlLoading ()方法回調(diào)攔截 url
3.通過 WebChromeClient 的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回調(diào)攔截JS對話框alert()、confirm()、prompt（） 消息
先來看看Android調(diào)用js的代碼
方法一共是兩種
1.使用WebView 的loadUrl（）方法
2.使用WebView的evaluateJavascript（）
loadurl 方法既可以是一個本地地址也可以是一個網(wǎng)址,我們就以本地網(wǎng)頁為示例吧
1.首先可以在android的asset資源文件下存放網(wǎng)頁
為了方便展示，本文是采用Andorid調(diào)用本地JS代碼說明；
實(shí)際情況時，Android更多的是調(diào)用遠(yuǎn)程JS代碼，即將加載的JS代碼路徑改成url即可
<html>
<head>
<meta charset="utf-8">
<title>Carson_Ho</title>
// JS代碼
<script>
// Android需要調(diào)用的方法
function AndroidcallJS(){
alert("Android調(diào)用了JS的AndroidcallJS方法");
}
</script>
</head>
</html>
然后在Activity里設(shè)置webView的屬性
WebSettings webSettings = mWebView.getSettings();
// 設(shè)置與Js交互的權(quán)限
webSettings.setJavaScriptEnabled(true);
// 設(shè)置允許JS彈窗
webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
// 格式規(guī)定為:file:///android_asset/文件名.html
mWebView.loadUrl("file:///android_asset/javascript.html");`
然后在你需要的地方，設(shè)置一個監(jiān)聽事件
mClick.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
// 通過Handler發(fā)送消息
mWebView.post(new Runnable() {
@Override
public void run() {
// 注意調(diào)用的JS方法名要對應(yīng)上
// 調(diào)用javascript的callJS()方法
mWebView.loadUrl("javascript:AndroidcallJS()");
}
});
}
});
mWebView.setWebChromeClient(new WebChromeClient() {
@Override
public boolean onJsAlert(WebView view, String url, String message, final JsResult result) {
AlertDialog.Builder mDialog= new AlertDialog.Builder(MainActivity.this);
mDialog.setTitle("彈窗");
mDialog.setMessage(message);
mDialog.setPositiveButton(android.R.string.ok, new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
result.confirm();
}
});
mDialog.setCancelable(false);
mDialog.create().show();
return true;
}
})；
}
}
我們再來看第二種方法 evaluateJavascript（）
這種方法是更加簡潔和高效的。以上網(wǎng)頁資源文件不變，把loadUrl 換成這個方法調(diào)用就可以了
mWebView.evaluateJavascript（"javascript:AndroidcallJS()", new ValueCallback<String>() {
@Override
public void onReceiveValue(String value) {
//此處為 js 返回的結(jié)果
}
});
}
該方法也是只能在android 4.4以上才能使用
方法對比
使用建議
兩種方法混合使用，即Android 4.4以下使用方法1，Android 4.4以上方法2
// Android版本變量
final int version = Build.VERSION.SDK_INT;
// 因?yàn)樵摲椒ㄔ?Android 4.4 版本才可使用，所以使用時需進(jìn)行版本判斷
if (version < 18) {
mWebView.loadUrl("javascript:callJS()");
} else {
mWebView.evaluateJavascript（"javascript:callJS()", new ValueCallback<String>() {
@Override
public void onReceiveValue(String value) {
//此處為 js 返回的結(jié)果
}
});
}
我們再來看一下js 調(diào)用Android方法
有3種：
1.通過WebView的addJavascriptInterface（）進(jìn)行對象映射
2.通過 WebViewClient 的shouldOverrideUrlLoading ()方法回調(diào)攔截 url
3.通過 WebChromeClient 的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回調(diào)攔截JS對話框alert()、confirm()、prompt（） 消息
方法分析
方式1：通過 WebView的addJavascriptInterface（）進(jìn)行對象映射
步驟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ǎn)擊按鈕則調(diào)用callAndroid函數(shù)
<button type="button" id="button1" "callAndroid()"></button>
</body>
</html>
步驟3：在Android里通過WebView設(shè)置Android類與JS代碼的映射
詳細(xì)請看注釋
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");
特點(diǎn)
優(yōu)點(diǎn)：使用簡單
僅將Android對象和JS對象映射即可
缺點(diǎn)：存在嚴(yán)重的漏洞問題，
方式二、通過 WebViewClient 的方法shouldOverrideUrlLoading ()回調(diào)攔截 url
原理：
1.Android通過 WebViewClient 的回調(diào)方法shouldOverrideUrlLoading ()攔截 url
2.解析該 url 的協(xié)議
3.如果檢測到是預(yù)先約定好的協(xié)議，就調(diào)用相應(yīng)方法
1.在JS約定所需要的Url協(xié)議
JS代碼：javascript2.html
<!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ǎn)擊按鈕則調(diào)用callAndroid（）方法 -->
<body>
<button type="button" id="button1" onclick="callAndroid()">點(diǎn)擊調(diào)用Android代碼</button>
</body>
</html>
2,在Android通過WebViewClient復(fù)寫shouldOverrideUrlLoading （）
public void initJs2() {
webview = (WebView) findViewById(R.id.webview);
WebSettings webSettings = webview.getSettings();
// 設(shè)置與Js交互的權(quán)限
webSettings.setJavaScriptEnabled(true);
// 設(shè)置允許JS彈窗
webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
// 步驟1：加載JS代碼
// 格式規(guī)定為:file:///android_asset/文件名.html
webview.loadUrl("file:///android_asset/javascript2.html");
// 復(fù)寫WebViewClient類的shouldOverrideUrlLoading方法
webview.setWebViewClient(new WebViewClient() {
@Override
public boolean shouldOverrideUrlLoading(WebView view, String url) {
// 步驟2：根據(jù)協(xié)議的參數(shù)，判斷是否是所需要的url
// 一般根據(jù)scheme（協(xié)議格式） & authority（協(xié)議名）判斷（前兩個參數(shù)）
//假定傳入進(jìn)來的 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);
}
}
);
}
點(diǎn)擊web按鈕 打印 I/System.out: js調(diào)用了Android的方法
shouldOverrideUrlLoading 不攔截 建議返回false
特點(diǎn)
- 優(yōu)點(diǎn)：不存在方式1的漏洞；
- 缺點(diǎn)：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（）方法）說明 ：
1.常用的攔截是：攔截 JS的輸入框（即prompt（）方法）
2.因?yàn)橹挥衟rompt（）可以返回任意類型的值，操作最全面方便、更加靈活；而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ǎn)擊按鈕則調(diào)用clickprompt() -->
<body>
<button type="button" id="button1" "clickprompt()">點(diǎn)擊調(diào)用Android代碼</button>
</body>
</html>
當(dāng)使用mWebView.loadUrl("file:///android_asset/javascript.html")加載了上述JS代碼后，就會觸發(fā)回調(diào)onJsPrompt（），具體如下：
1.如果是攔截警告框（即alert()），則觸發(fā)回調(diào)onJsAlert（）；
2.如果是攔截確認(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ù)）
//假定傳入進(jìn)來的 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);
}
}
);
}
}
三種方式的對比 & 使用場景
總結(jié)
參考鏈接：
Android與js的交互：https://blog.csdn.net/yuanbing1988/article/details/84197454
Android與js交互的方法：http://www.itdecent.cn/p/24c8175cb7f9
Android與js（WebView與 JS 交互方式）：https://blog.csdn.net/carson_ho/article/details/64904691/
Android與js交互（js調(diào)用Android）http://www.itdecent.cn/p/f21683a62203
