Android 利用WebViewJavascriptBridge 实现js和java的交互

原创 2016年08月29日 09:58:44

此文出自:http://blog.csdn.net/sk719887916/article/details/47189607,skay 博客

    按安卓开发目前现状来说,开发者大部分时间还是花在UI的屏幕适配上,使用原生控件开发成本已不是那么理想,鉴于很多项目和ios基于一致的ui界面,至使安卓UI开发成本花费更大的代价,因此目前结合Html5和原生控件是解决UI适配的一种很好的选择,处于APP性能也会用java和native层进行结合。不管是哪种结合,其实原理都差不多,只要按照它的协议来,是很容易的,今天我们仅对于Html和Java层结合,学习下WebViewJavascriptBridge。

   

一 什么是webViewjavascripBridge?

       WebViewJavascriptBridge是移动UIView和Html交互通信的桥梁,用作者的话来说就是实现java(ios为oc)和js的互相调用的桥梁。替代了WebView的自带的JavascriptInterface的接口,使得我们的开发更加灵活和安全。


 二 为什么要用webViewjavascripBridge?

     
    对于安卓开发有一段时间的人来说,知道安卓4.4以前谷歌的webview存在安全漏洞,网站可以通过js注入就可以随便拿到客户端的重要信息,甚至轻而易举的调用本地代码进行流氓行为,谷歌后来发现有此漏洞后,增加了防御措施,如果要是js调用本地代码,开发者必须在代码申明JavascriptInterface,
   列如在4.0之前我们要使得webView加载js只需如下代码:
  
[java] view plain copy
 print?在CODE上查看代码片派生到我的代码片
  1. mWebView.addJavascriptInterface(new JsToJava(), "myjsfunction");    

     4.4之后调用需要在调用方法加入加入@JavascriptInterface注解,如果代码无此申明,那么也就无法使得js生效,也就是说这样就可以避免恶意网页利用js对安卓客户端的窃取和攻击。

        但是即使这样,我们很多时候需要在js记载本地代码的时候,要做一些判断和限制,或者有可能也会做些过滤和对用户友好提示,因此JavascriptInterface也就无法满足我们的需求了,特此有大神就写出了WebViewJavascriptBridge框架。

     



三 怎么使用webViewjavascripBridge


   1 将jsBridge.jar引入到我们的工程

          Eclispe
         
           导入jar包, 或者直接copyjar源码, jar可以到gitHub上下载。

        Android Studio: 
             
repositories {
    // ...
    maven { url "https://jitpack.io" }
}

dependencies {
    compile 'com.github.lzyzsd:jsbridge:1.0.4'
}

     2 WebView包需使用以上包的webView


              Layout中使用第三方webView
       EG:
             
[html] view plain copy
 print?在CODE上查看代码片派生到我的代码片
  1. <?xml version="1.0" encoding="utf-8"?>  
  2. <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"  
  3.     android:layout_width="match_parent"  
  4.     android:layout_height="match_parent"  
  5.     android:orientation="vertical" >  
  6.   
  7.     <!-- button 演示Java调用web -->  
  8.     <Button   
  9.         android:id="@+id/button"  
  10.         android:layout_width="match_parent"  
  11.         android:text="@string/button_name"  
  12.         android:layout_height="48dp"  
  13.         />  
  14.       
  15.     <!-- webview 演示web调用Java -->  
  16.     <com.github.lzyzsd.jsbridge.BridgeWebView  
  17.         android:id="@+id/webView"  
  18.         android:layout_width="match_parent"  
  19.         android:layout_height="match_parent" >  
  20.      </com.github.lzyzsd.jsbridge.BridgeWebView>  
  21.   
  22. </LinearLayout>  

  3 Java代码

      1 activity
[java] view plain copy
 print?在CODE上查看代码片派生到我的代码片
  1. public class MainActivity extends Activity implements OnClickListener {  
  2.   
  3.     private final String TAG = "MainActivity";  
  4.   
  5.     BridgeWebView webView;  
  6.   
  7.     Button button;  
  8.   
  9.     int RESULT_CODE = 0;  
  10.   
  11.     ValueCallback<Uri> mUploadMessage;  
  12.   
  13.     static class Location {  
  14.         String address;  
  15.     }  
  16.   
  17.     static class User {  
  18.         String name;  
  19.         Location location;  
  20.         String testStr;  
  21.     }  
  22.   
  23.     @Override  
  24.     protected void onCreate(Bundle savedInstanceState) {  
  25.         super.onCreate(savedInstanceState);  
  26.         setContentView(R.layout.activity_main);  
  27.   
  28.         webView = (BridgeWebView) findViewById(R.id.webView);  
  29.   
  30.         button = (Button) findViewById(R.id.button);  
  31.   
  32.         button.setOnClickListener(this);  
  33.   
  34.         webView.setDefaultHandler(new DefaultHandler());  
  35.   
  36.         webView.setWebChromeClient(new WebChromeClient() {  
  37.   
  38.             @SuppressWarnings("unused")  
  39.             public void openFileChooser(ValueCallback<Uri> uploadMsg, String AcceptType, String capture) {  
  40.                 this.openFileChooser(uploadMsg);  
  41.             }  
  42.   
  43.             @SuppressWarnings("unused")  
  44.             public void openFileChooser(ValueCallback<Uri> uploadMsg, String AcceptType) {  
  45.                 this.openFileChooser(uploadMsg);  
  46.             }  
  47.   
  48.             public void openFileChooser(ValueCallback<Uri> uploadMsg) {  
  49.                 mUploadMessage = uploadMsg;  
  50.                 pickFile();  
  51.             }  
  52.         });  
  53.         //加载本地网页  
  54.   
  55.         //webView.loadUrl("file:///android_asset/demo.html");  
  56.         //加载服务器网页  
  57.         webView.loadUrl("https://www.baidu.com");  
  58.   
  59.         //必须和js同名函数,注册具体执行函数,类似java实现类。  
  60.         webView.registerHandler("submitFromWeb"new BridgeHandler() {  
  61.   
  62.             @Override  
  63.             public void handler(String data, CallBackFunction function) {  
  64.   
  65.                 String str ="这是html返回给java的数据:" + data;  
  66.                 // 例如你可以对原始数据进行处理  
  67.                 makeText(MainActivity.this, str, LENGTH_SHORT).show();  
  68.   
  69.                 Log.i(TAG, "handler = submitFromWeb, data from web = " + data);  
  70.                 function.onCallBack( str + ",Java经过处理后截取了一部分:"+ str.substring(0,5));  
  71.             }  
  72.   
  73.         });  
  74.         //模拟用户获取本地位置  
  75.         User user = new User();  
  76.         Location location = new Location();  
  77.         location.address = "上海";  
  78.         user.location = location;  
  79.         user.name = "Bruce";  
  80.   
  81.         webView.callHandler("functionInJs"new Gson().toJson(user), new CallBackFunction() {  
  82.             @Override  
  83.             public void onCallBack(String data) {  
  84.                 makeText(MainActivity.this"网页在获取你的位置", LENGTH_SHORT).show();  
  85.   
  86.             }  
  87.         });  
  88.   
  89.         webView.send("hello");  
  90.   
  91.     }  
  92.   
  93.     public void pickFile() {  
  94.         Intent chooserIntent = new Intent(Intent.ACTION_GET_CONTENT);  
  95.         chooserIntent.setType("image/*");  
  96.         startActivityForResult(chooserIntent, RESULT_CODE);  
  97.     }  
  98.   
  99.     @Override  
  100.     protected void onActivityResult(int requestCode, int resultCode, Intent intent) {  
  101.         if (requestCode == RESULT_CODE) {  
  102.             if (null == mUploadMessage){  
  103.                 return;  
  104.             }  
  105.             Uri result = intent == null || resultCode != RESULT_OK ? null : intent.getData();  
  106.             mUploadMessage.onReceiveValue(result);  
  107.             mUploadMessage = null;  
  108.         }  
  109.     }  
  110.   
  111.     @Override  
  112.     public void onClick(View v) {  
  113.         if (button.equals(v)) {  
  114.             webView.callHandler("functionInJs""data from Java"new CallBackFunction() {  
  115.   
  116.                 @Override  
  117.                 public void onCallBack(String data) {  
  118.                     // TODO Auto-generated method stub  
  119.                     Log.i(TAG, "reponse data from js " + data);  
  120.                 }  
  121.   
  122.             });  
  123.         }  
  124.   
  125.     }  
  126.   
  127. }  
2 自定webVIewClient

[java] view plain copy
 print?在CODE上查看代码片派生到我的代码片
  1. class MyWebViewClient extends BridgeWebViewClient{  
  2.   
  3.         public MyWebViewClient(BridgeWebView webView) {  
  4.             super(webView);  
  5.         }  
  6.     }  

   将自定义webViewClient设置到webview上
    
[java] view plain copy
 print?在CODE上查看代码片派生到我的代码片
  1. mWebView.setWebViewClient(new MyWebViewClient(mWebView));  

   上面句话很关键:

      
      通过实例化webView,用法和安卓原生的view没多大区别,设置WebChromClient, 设置加载的html(同样支持网络和本地文件),接着我们需要给web注册和html端约定好的js方法名。代码列举的submitFromweb和js的执行的方法名一致,玩过NDK的JNI调用的朋友也知道必须和c代码之间有个约定,其实js桥和jni有点类似,

通过注册handler来实现回调,Java代码中通过js返回的数据,进行处理后在调用function.onCallback返回给js.这里不做过多解释

[java] view plain copy
 print?在CODE上查看代码片派生到我的代码片
  1. //必须和js函数同名,注册具体执行回调函数,类似java实现类。  
  2.         webView.registerHandler("submitFromWeb"new BridgeHandler() {  
  3.   
  4.             @Override  
  5.             public void handler(String data, CallBackFunction function) {  
  6.   
  7.                 String str ="这是html返回给java的数据:" + data;  
  8.                 // 例如你可以对原始数据进行处理  
  9.                 makeText(MainActivity.this, str, LENGTH_SHORT).show();  
  10.   
  11.                 Log.i(TAG, "handler = submitFromWeb, data from web = " + data);  
  12.                 function.onCallBack( str + ",Java经过处理后截取了一部分:"+ str.substring(0,5));  
  13.             }  
  14.   
  15.         });  

     如果是webview刚开始就执行一段Java代码 ,可以通过webView.CallHandler()来实现 。当然我们注册的方法也要和js里面的方法名一致。
      
[java] view plain copy
 print?在CODE上查看代码片派生到我的代码片
  1. webView.callHandler("functionInJs"new Gson().toJson(user), new CallBackFunction() {  
  2.            @Override  
  3.            public void onCallBack(String data) {  
  4.             makeText(MainActivity.this"网页在获取你的位置", LENGTH_SHORT).show();  
  5.   
  6.            }  
  7.        });  

  3 Html和js实现

         html代码如下,效果图



    
[html] view plain copy
 print?在CODE上查看代码片派生到我的代码片
  1. <html>  
  2.     <head>  
  3.         <meta content="text/html; charset=utf-8" http-equiv="content-type">  
  4.         <title>  
  5.             js调用java  
  6.         </title>  
  7.     </head>  
  8.       
  9.     <body>  
  10.         <p>  
  11.             <xmp id="show">  
  12.             </xmp>  
  13.         </p>  
  14.         <p>  
  15.             <xmp id="init">  
  16.             </xmp>  
  17.         </p>  
  18.         <p>  
  19.             <input type="text" id="text1" value="用户名(username)" />  
  20.         </p>  
  21.         <p>  
  22.             <input type="text" id="text2" value="password" />  
  23.         </p>  
  24.         <p>  
  25.             <input type="button" id="enter" value="发消息给Native" onclick="testClick();"  
  26.             />  
  27.         </p>  
  28.         <p>  
  29.             <input type="button" id="enter1" value="调用Native方法" onclick="testClick1();"  
  30.             />  
  31.         </p>  
  32.         <p>  
  33.             <input type="button" id="enter2" value="显示html" onclick="testDiv();" />  
  34.         </p>  
  35.         <p>  
  36.             <input type="file" value="打开文件"  />  
  37.         </p>  
  38.     </body>  
  39.       
  40. </html>  

  js代码


    
[javascript] view plain copy
 print?在CODE上查看代码片派生到我的代码片
  1. <script>  
  2.   
  3.        function testDiv() {  
  4.            document.getElementById("show").innerHTML = document.getElementsByTagName("html")[0].innerHTML;  
  5.        }  
  6.   
  7.        function testClick() {  
  8.            var str1 = document.getElementById("text1").value;  
  9.            var str2 = document.getElementById("text2").value;  
  10.   
  11.            //发送消息给java代码  
  12.            var data = "name=" + str1 + ",pass=" + str2;  
  13.   
  14.            window.WebViewJavascriptBridge.send(  
  15.                data  
  16.                , function(responseData) {  
  17.   
  18.                    document.getElementById("show").innerHTML = "repsonseData from java, data = " +responseData  
  19.                }  
  20.            );  
  21.   
  22.        }  
  23.   
  24.        function testClick1() {  
  25.            var str1 = document.getElementById("text1").value;  
  26.            var str2 = document.getElementById("text2").value;  
  27.   
  28.            //调用本地java方法  
  29.            window.WebViewJavascriptBridge.callHandler(  
  30.                'submitFromWeb'  
  31.                , {'param': str1}  
  32.                , function(responseData) {  
  33.                    document.getElementById("show").innerHTML = "send get responseData from java, data = " + responseData  
  34.                }  
  35.            );  
  36.        }  
  37.   
  38.        function bridgeLog(logContent) {  
  39.            document.getElementById("show").innerHTML = logContent;  
  40.        }//注册事件监听  
  41.        function connectWebViewJavascriptBridge(callback) {  
  42.            if (window.WebViewJavascriptBridge) {  
  43.                callback(WebViewJavascriptBridge)  
  44.            } else {  
  45.                document.addEventListener(  
  46.                    'WebViewJavascriptBridgeReady'  
  47.                    , function() {  
  48.                        callback(WebViewJavascriptBridge)  
  49.                    },  
  50.                    false  
  51.                );  
  52.            }  
  53.        }  
  54.        //注册回调函数,第一次连接时调用 初始化函数  
  55.        connectWebViewJavascriptBridge(function(bridge) {  
  56.            bridge.init(function(message, responseCallback) {  
  57.                console.log('JS got a message', message);  
  58.                var data = {  
  59.                    'Javascript Responds''Wee!'  
  60.                };  
  61.                console.log('JS responding with', data);  
  62.                responseCallback(data);  
  63.            });  
  64.   
  65.            bridge.registerHandler("functionInJs"function(data, responseCallback) {  
  66.                document.getElementById("show").innerHTML = ("data from Java: = " + data);  
  67.                var responseData = "Javascript Says Right back aka!";  
  68.                responseCallback(responseData);  
  69.            });  
  70.        })  
  71.    </script>  

      这段代码不难理解,我们对上面的id为enter的Button注册了一个点击事件,点击后执行以下testClick()方法,依次类推,其他Button注册事件相同,


     当点击“发消息给Native”的按钮时,Js通过webWiew的jsBridage.send()发送一条数据给java层(密码和用户名),同时在此用function()来执行应java层回调函数的。此demo中是把java返回的数据插入到"show"的div里面去。

   

testClick1():此方法中调用callHandler来调用Java代码的submitFromweb同名函数,可以结合上面的Activty的代码理解下,此函数调用我们已在java注册实现好的

   

[java] view plain copy
 print?在CODE上查看代码片派生到我的代码片
  1. //必须和js同名函数,注册具体执行函数,类似java实现类。  
  2.         webView.registerHandler("submitFromWeb"new BridgeHandler() {  
  3.   
  4.             @Override  
  5.             public void handler(String data, CallBackFunction function) {  
  6.   
  7.                 String str ="这是html返回给java的数据:" + data;  
  8.                 // 例如你可以对原始数据进行处理  
  9.                 makeText(MainActivity.this, str, LENGTH_SHORT).show();  
  10.   
  11.                 Log.i(TAG, "handler = submitFromWeb, data from web = " + data);  
  12.                 function.onCallBack( str + ",Java经过处理后截取了一部分:"+ str.substring(0,5));  
  13.             }  
  14.   
  15.         });  

     java注册Js函数如上面列子 ,那么在js中注册方法来注册呢,

    在js中我们同样可以直接注册一个回调函数,通过 bridge.registerHandler()来注册,接着调用 responseCallback(responseData)来返回数据给java代码的同名函数。f

也可以直接调用init()来指定网页首次加载上面注册java代码。

  

[java] view plain copy
 print?在CODE上查看代码片派生到我的代码片
  1. connectWebViewJavascriptBridge(function(bridge) {  
  2.           bridge.init(function(message, responseCallback) {  
  3.               console.log('JS got a message', message);  
  4.               var data = {  
  5.                   'Javascript Responds''Wee!'  
  6.               };  
  7.               console.log('JS responding with', data);  
  8.               responseCallback(data);  
  9.           });  
  10.   
  11.           bridge.registerHandler("functionInJs", function(data, responseCallback) {  
  12.               document.getElementById("show").innerHTML = ("data from Java: = " + data);  
  13.               var responseData = "Javascript Says Right back aka!";  
  14.               responseCallback(responseData);  
  15.           });  
  16.       })  


四 总结

  
   
通过以上的API介绍,代码示例,不难发现此框架的优雅和简便,对js和java双方来说,如果Html中的js需要调用java代码,而java代码没做任何实现,那么js中方法也是无效的,反之java代码注册的函数,没在js里去回调实现,那么Java层也是无法获取js中数据的,由此可见,此通信是双方支持的,必须由双方来约定,这样就避免了Android之前存在的js注入漏洞,也很大的提高了安全性,也可以保证我们的网页数据不被第三方的APP获取,具体来讲,列如我们的项目某一个web的h5界面,被系统浏览器或者其他第三方App的恶意加载,那么它的java代码想调用你的js函数,实现需要你的H5的Js先注册,不然跟本无法调用你的h5信息。这样保证了这个html数据的安全性,,第三方的浏览器可以加载预览你的网页,但是第三方java无法和你的的h5中的js交互通信的。同样加载我们自己的APP加载第三方的网页时候,我们可以对第三方网页进行一些行为的过滤,方便保护我们手机的安全,列如第三方可以获取本机地址时我们可以提示用户授权。虽然H5并不属于插件的一种,但是借助h5我可以方便的去更新一些运营活动,和某些需要经常需要更换UI的业务功能的地方,以上只JSBridge的使用姿势,,以后再给大家解剖下JsBridge的内部实现



  项目地址
项目实例:https://github.com/NeglectedByBoss/JsBridge_Android
英文介绍:https://github.com/lzyzsd/JsBridg

版权声明:本文为博主原创文章,未经博主允许不得转载。

相关文章推荐

Android中WebView使用总结

webView的初步了解

如何捕获未捕获的异常

如何捕获未捕获的异常

iOS OC与JS的交互(WebViewJavascriptBridge实现)

在开发的过程中,我们会遇到原生app与web的交互,除了用WebView加载HTML5文件显示外,还可能需要和WebView进行交互,例如点击WebView上面的按钮调用原生OC的函数方法,上一章总结...

[iOS] 使用WebViewJavascriptBridge实现OC与JS交互

[iOS] 使用WebViewJavascriptBridge实现OC与JS交互

使用WebViewJavascriptBridge实现OC与JS交互

前言 当下,很多APP里面都会有HTML5网页,我们除了简单的用WebView加载显示外,很多情况下,我们还需要和WebView进行交互,比如点击WebView上面的按钮调用OC端的函数实现...

iOS开发使用WebViewJavascriptBridge实现OC与JS交互

[iOS] 使用WebViewJavascriptBridge实现OC与JS交互 前言 当下,很多APP里面都会有HTML5网页,我们除了简单的用WebView加载显示外,很多情况下,我们还需要和...

[js&oc交互]WebViewJavascriptBridge简单实用

WebViewJavascriptBridge实用流程Git: [https://github.com/tianNanYiHao/WebViewJavascriptBridge.git] 其实Web...

IOS 开发OC 与JS 交互 WebviewJavaScriptBridge 的简单实用(二)

之前的博客OC(Object_C)与前端页面JS(JavaScript)交互整理(一) 中简单的介绍啦,OC与JS 交互中的,苹果提供的原生的stringByEvaluatingJavaScriptF...

在Android上实现Java和Js交互

其实webview加载资源的速度并不慢,但是如果资源多了,当然就很慢。图片、 css 、 js 、 html 这些资源每个大概需要 10-200ms ,一般都是 30ms 就 ok 了。不过webvi...

[Android][转]在Android上实现Java和Js交互

转自:http://zhiweiofli.iteye.com/blog/1900249 其实webview加载资源的速度并不慢,但是如果资源多了,当然就很慢。图片、 css 、 js 、 ht...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Android 利用WebViewJavascriptBridge 实现js和java的交互
举报原因:
原因补充:

(最多只允许输入30个字)