Webview+echarts实现Android图表

Posted

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Webview+echarts实现Android图表相关的知识，希望对你有一定的参考价值。

参考技术A WebView是android中一个非常实用的组件，它和safai、chrome一样都是基于webkit网页渲染引擎，可以通过加载html数据的方式便捷地展现软件界面，WebView主要负责解析、渲染。webview的常见工具类和用法如下：

先在js中定义要被调用方法：

```javascript

function initChartView()

```

在安卓中的类EChartWebView注册js方法：

```java

fun initChartView()

    Log.i("initChartView():",""+loadUrl("javascript:initChartView()"))



```

javascriptInterface、webViewClient.shouldOverrideUrlLoading()、webChromeClient.onconsoleMessage()、webChromeClient.onJspompt()

具体使用在后面叙述

（参考： isea533的ECharts-Java使用Java快速开发ECharts图表  和  _frendy的轻松实现 Android 图表 • ECharts）

由于eacharts 里各种图表的属性和数据等都是由 option ，使用 WebView 加载H5网页有两种思路：

1）由 Android 获取数据并生成 option，而 H5 则负责解析 option 并调用 ECharts 进行绘制。

2）H5 负责所有流程，获取数据、生成 option并调用 ECharts 进行绘制。

在此使用第 1）种方法，具体实现如下：

```java

implementation'com.github.frendyxzc:Charts:0.0.2'

implementation'com.github.abel533:ECharts:2.2.7'

```

--- loadUrl(URL）：加载http网页的方法

--- webSettings ：与webview相关的配置

--- addJavascriptInterface ：提供js调用java的相关方法

--- setDataSource : 对java构建完成的option进行返回

在com.github.abel533.echarts.Option中已提供了与Echarts实现的各种配置，我们只需调用即可

tooltip()：与标签有关

grid()：刻度线

CategoryAxis()：建立横向类目轴

ValueAxis()：纵轴

MarkPoint()：点数据

MarkLine()：标线

图表数据填充：

数据填充Echarts的XY轴的两种方法

（1）for in 循环方式

```java

for (item  in  Arraylist<E>)

categoryAxis.data(item.x)

line.data(item.y)



```

（2）Kotlin的变长参数

```java

categoryAxis.data(*dataArrayX)

line.data(*dataArrayY)

```

注：此处的dataArrayX和dataArrayY是任意类型的数组

*建立完成后选择展示的图表类型（线型图表）*：

```java

option.exportToHtml("line.html")

```

注：line.html和js等文件放置在安卓assets文件中

安卓端的数据就是option，option是构建的json字符串

在安卓端获取数据并构建被js调用的方法：

```java

addJavascriptInterface(EChartInterface(context), "Android")

```

定义一个接口供数据回调：

```java

private var dataSource: DataSource? = null

fun setDataSource(data: EChartWebView.DataSource, needReload: Boolean)

    dataSource = data



interface DataSource

        fun markChartOptions(): GsonOption

   

```

接口里方法的定义：

```java

  internal inner class EChartInterface(var context: Context)

        val chartOptions: String?

            @JavascriptInterface

            get()

                if (dataSource != null)

                    val option = dataSource!!.markChartOptions()

                    Log.i("xq","echarts图表的option：$option")

                    return option.toString()

               

                return null

           

   

```

在js页面调用安卓的方法

```java

option = JSON.parse(Android.getChartOptions())；

JSON.parse是将json字符串其转化为json对象

```

其中Android.getChartOptions()就是js调用安卓的方法

初始化Echarts图标并设置option ，实现如下：

```java

chart = echarts.init(chartDoc)；

chart.setOption(option);

```

介绍：formatter用于规定echarts数据显示的内容和格式。

使用：

饼图模板变量：

（1）a：系列名，series.name。

（2）b：数据名，series.data.name。

（3）c：数据值，series.data.value。

（4）d：百分比。

（5）@xxx：数据中名为'xxx'的维度的值，如@product表示名为'product'` 的维度的值。

（6）@[n]：数据中维度n的值，如@[3]` 表示维度 3 的值，从 0 开始计数。

示例：

formatter:"b：c(d%)"

折线、柱状图模板变量：

（1）a：系列名，series.name。

（2）b：数据名，xAxis.data。

（3）c：数据值，yAxis.data。

（5）@xxx：数据中名为'xxx'的维度的值，如@product表示名为'product'` 的维度的值。

（6）@[n]：数据中维度n的值，如@[3]` 表示维度 3 的值，从 0 开始计数。

示例：

formatter:"a<br/>b：c"

此方法需要自行拼接要显示的标签内容，可以灵活配置比如有些图表option的配置在类库 abel533:ECharts:2.2.7 中是没有的，自定义formatter内容需要知道参数具体表示的内容，这里可以通过js的打印打印出函数传入的参数值，使用函数返回params对象，params是点数据的对象集合，打印出它的内容即可知道每个参数具体代表什么。

示例：

formatter:function(params)

  console.log(params)

  var result = params[0].name

  for(i=0;i<params.length;i++)

    result = result+"<br>"+"<span style=display:inline-block;margin-right:5px;border-radius:10px;width:8px;height:8px;background-color:"+params[i].color+"></span>"+params[i].seriesName+": "+params[i].value

 

  return result

WebView与 JS 交互方式

前言

  • 现在很多App里都内置了Web网页（Hybrid App），比如说很多电商平台，淘宝、京东、聚划算等等，如下图

技术分享图片

  • 上述功能是由Android的WebView实现的，其中涉及到Android客户端与Web网页交互的实现
  • 今天我将全面介绍Android通过WebView与JS交互的全面方式

阅读本文前请先阅读：Android开发：最全面、最易懂的Webview详解

目录

技术分享图片

1. 交互方式总结

Android与JS通过WebView互相调用方法，实际上是：

  • Android去调用JS的代码
  • JS去调用Android的代码

二者沟通的桥梁是WebView

对于Android调用JS代码的方法有2种： 
1. 通过WebView的loadUrl（） 
2. 通过WebView的evaluateJavascript（）

对于JS调用Android代码的方法有3种： 
1. 通过WebView的addJavascriptInterface（）进行对象映射 
2. 通过 WebViewClient 的shouldOverrideUrlLoading ()方法回调拦截 url 
3. 通过 WebChromeClient 的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回调拦截JS对话框alert()、confirm()、prompt（） 消息

2. 具体分析

2.1 Android通过WebView调用 JS 代码

对于Android调用JS代码的方法有2种： 
1. 通过WebView的loadUrl（） 
2. 通过WebView的evaluateJavascript（）

方式1：通过WebView的loadUrl（）

  • 实例介绍：点击Android按钮，即调用WebView JS（文本名为javascript）中callJS（）
  • 具体使用：

步骤1：将需要调用的JS代码以.html格式放到src/main/assets文件夹里

  1. 为了方便展示，本文是采用Andorid调用本地JS代码说明；
  2. 实际情况时，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代码

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

        // 设置与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) {
                // 通过Handler发送消息
                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（）

  • 优点：该方法比第一种方法效率更高、使用更简洁。

    1. 因为该方法的执行不会使页面刷新，而第一种方法（loadUrl ）的执行则会。
    2. 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 代码

对于JS调用Android代码的方法有3种： 
1. 通过WebView的addJavascriptInterface（）进行对象映射 
2. 通过 WebViewClient 的shouldOverrideUrlLoading ()方法回调拦截 url 
3. 通过 WebChromeClient 的onJsAlert()、onJsConfirm()、onJsPrompt（）方法回调拦截JS对话框alert()、confirm()、prompt（） 消息

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

 

技术分享图片

特点

方式2：通过 WebViewClient 的方法shouldOverrideUrlLoading ()回调拦截 url

  • 具体原理： 

    1. Android通过 WebViewClient 的回调方法shouldOverrideUrlLoading ()拦截 url
    2. 解析该 url 的协议
    3. 如果检测到是预先约定好的协议，就调用相应方法 

     

    即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：

步骤2：在Android通过WebViewClient复写shouldOverrideUrlLoading （）

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

        // 设置与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（）方法）说明 ：

  1. 常用的拦截是：拦截 JS的输入框（即prompt（）方法）
  2. 因为只有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（），具体如下：

  1. 如果是拦截警告框（即alert()），则触发回调onJsAlert（）；
  2. 如果是拦截确认框（即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 三种方式的对比 & 使用场景

技术分享图片

3. 总结

  • 本文主要对Android通过WebView与JS的交互方式进行了全面介绍

技术分享图片

















以上是关于Webview+echarts实现Android图表的主要内容，如果未能解决你的问题，请参考以下文章

Flutter WebView加载本地html的问题

Android WebView与JS的交互方式 最全面汇总

Carson带你学Android：最全面的Webview使用详解

Android：你要的WebView与 JS 交互方式 都在这里了

你不知道的 Android WebView 使用漏洞

关于JavaFx的WebView调用Echarts点线不对应的问题