探究Android 中 WebView 與 JS 的交互

目錄

目錄

1.交互方式總結(jié)

  • 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（）== 消息

2.具體分析

2.1 Android通過WebView調(diào)用 JS 代碼

對于Android調(diào)用JS代碼的方法有2種：

  1. 通過==WebView==的==loadUrl（）==
  2. 通==過WebView==的==evaluateJavascript（）==
方式1：通過WebView的loadUrl（）
  • 實(shí)例介紹：點(diǎn)擊Android按鈕，即調(diào)用WebView JS（文本名為javascript）中callJS（）
  • 具體使用：
步驟1：將需要調(diào)用的JS代碼以.html格式放到src/main/assets文件夾里

為了方便展示如贷，本文是采用Andorid調(diào)用本地JS代碼說明陷虎；
實(shí)際情況時(shí)，Android更多的是調(diào)用遠(yuǎn)程JS代碼杠袱，即將加載的JS代碼路徑改成url即可

需要加載JS代碼：javascript.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代碼

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();

        // 設(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) {
                // 必須另開線程進(jìn)行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è)置了彈窗檢驗(yàn)調(diào)用結(jié)果,所以需要支持js對話框
        // webview只是載體尚猿，內(nèi)容的渲染需要使用webviewChromClient類去實(shí)現(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é)束時(shí)調(diào)用

方式2：通過WebView的evaluateJavascript（）
  • 優(yōu)點(diǎn)：該方法比第一種方法效率更高、使用更簡潔菩彬。

1.因?yàn)樵摲椒ǖ膱?zhí)行不會使頁面刷新缠劝，而第一種方法（loadUrl ）的執(zhí)行則會。
2.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;
// 因?yàn)樵摲椒ㄔ?Android 4.4 版本才可使用，所以使用時(shí)需進(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é)果
        }
    });
}

2.2 JS通過WebView調(diào)用 Android 代碼

對于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（）== 消息

2.2.1 方法分析

方式1：通過 WebView的addJavascriptInterface（）進(jìn)行對象映射

步驟1：定義一個(gè)與JS對象映射關(guān)系的Android類：AndroidtoJs
// 繼承自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" 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");

特點(diǎn)

  • 優(yōu)點(diǎn)：使用簡單

僅將Android對象和JS對象映射即可

方式2：通過 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代碼：javascript.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>

當(dāng)該JS通過Android的mWebView.loadUrl("file:///android_asset/javascript.html")加載后脓规，就會回調(diào)shouldOverrideUrlLoading （）栽连，接下來繼續(xù)看步驟2：

步驟2：在Android通過WebViewClient復(fù)寫==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();

        // 設(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é)議名）判斷（前兩個(gè)參數(shù)）
                                          //假定傳入進(jìn)來的 url = "js://webview?arg1=111&arg2=222"（同時(shí)也是約定好的需要攔截的）

                                          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)
  • 優(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中愁铺，有三個(gè)常用的對話框方法：

方式3的原理：Android通過 WebChromeClient 的onJsAlert()鹰霍、onJsConfirm()、onJsPrompt（）方法回調(diào)分別攔截JS對話框
（即上述三個(gè)方法）帜讲，得到他們的消息內(nèi)容衅谷，然后解析即可椒拗。

下面的例子將用攔截 JS的輸入框（即prompt（）方法）說明 ：

1.常用的攔截是：攔截 JS的輸入框（即prompt（）方法）
2.因?yàn)橹挥衟rompt（）可以返回任意類型的值似将，操作最全面方便、更加靈活蚀苛；而alert（）對話框沒有返回值在验；confirm（）對話框只能返回兩種狀態(tài)（確定 / 取消）兩個(gè)值

步驟1：加載JS代碼，如下：
<!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" onclick="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é)議名）判斷（前兩個(gè)參數(shù)）
                                            //假定傳入進(jìn)來的 url = "js://webview?arg1=111&arg2=222"（同時(shí)也是約定好的需要攔截的）

                                            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 三種方式的對比 & 使用場景

相關(guān)文章

Android開發(fā)：最全面世落、最易懂的Webview詳解
Android：你不知道的 WebView 使用漏洞
手把手教你構(gòu)建 Android WebView 的緩存機(jī)制 & 資源預(yù)加載方案

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 人面猴
    序言：七十年代末淮腾，一起剝皮案震驚了整個(gè)濱河市，隨后出現(xiàn)的幾起案子，更是在濱河造成了極大的恐慌谷朝，老刑警劉巖洲押，帶你破解...
    沈念sama閱讀 211,042評論 6贊 490
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件，死亡現(xiàn)場離奇詭異圆凰，居然都是意外死亡杈帐，警方通過查閱死者的電腦和手機(jī)，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,996評論 2贊 384
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進(jìn)店門专钉，熙熙樓的掌柜王于貴愁眉苦臉地迎上來娘荡，“玉大人，你說我怎么就攤上這事驶沼∨阢澹” “怎么了？”我有些...
    開封第一講書人閱讀 156,674評論 0贊 345
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵回怜，是天一觀的道長大年。 經(jīng)常有香客問我，道長玉雾，這世上最難降的妖魔是什么翔试？ 我笑而不...
    開封第一講書人閱讀 56,340評論 1贊 283
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任，我火速辦了婚禮复旬，結(jié)果婚禮上垦缅，老公的妹妹穿的比我還像新娘。我一直安慰自己驹碍，他們只是感情好壁涎，可當(dāng)我...
    茶點(diǎn)故事閱讀 65,404評論 5贊 384
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布。 她就那樣靜靜地躺著志秃，像睡著了一般怔球。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上浮还，一...
    開封第一講書人閱讀 49,749評論 1贊 289
  • 城市分裂傳說
    那天竟坛，我揣著相機(jī)與錄音，去河邊找鬼钧舌。 笑死担汤，一個(gè)胖子當(dāng)著我的面吹牛，可吹牛的內(nèi)容都是我干的洼冻。 我是一名探鬼主播崭歧，決...
    沈念sama閱讀 38,902評論 3贊 405
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼，長吁一口氣：“原來是場噩夢啊……” “哼碘赖！你這毒婦竟也來了驾荣？” 一聲冷哼從身側(cè)響起外构，我...
    開封第一講書人閱讀 37,662評論 0贊 266
  • 萬榮殺人案實(shí)錄
    序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎播掷，沒想到半個(gè)月后审编，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體，經(jīng)...
    沈念sama閱讀 44,110評論 1贊 303
  • ?護(hù)林員之死
    正文 獨(dú)居荒郊野嶺守林人離奇死亡歧匈，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,451評論 2贊 325
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年垒酬，在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片件炉。...
    茶點(diǎn)故事閱讀 38,577評論 1贊 340
  • 活死人
    序言：一個(gè)原本活蹦亂跳的男人離奇死亡勘究，死狀恐怖，靈堂內(nèi)的尸體忽然破棺而出斟冕，到底是詐尸還是另有隱情口糕，我是刑警寧澤，帶...
    沈念sama閱讀 34,258評論 4贊 328
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布磕蛇，位于F島的核電站景描，受9級特大地震影響，放射性物質(zhì)發(fā)生泄漏秀撇。R本人自食惡果不足惜超棺，卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,848評論 3贊 312
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望呵燕。 院中可真熱鬧棠绘，春花似錦、人聲如沸再扭。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,726評論 0贊 21
  • 一樁弒父案，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽霍衫。三九已至候引，卻和暖如春，著一層夾襖步出監(jiān)牢的瞬間敦跌，已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,952評論 1贊 264
  • 情欲美人皮
    我被黑心中介騙來泰國打工逛揩， 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留柠傍，地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,271評論 2贊 360
  • 代替公主和親
    正文 我出身青樓辩稽，卻偏偏與公主長得像惧笛，于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子逞泄，可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,452評論 2贊 348

推薦閱讀更多精彩內(nèi)容