Apache Zeppelin可视化插件开发入门指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00743/article/details/148487247

Apache Zeppelin可视化插件开发入门指南

zeppelin Web-based notebook that enables data-driven, interactive data analytics and collaborative documents with SQL, Scala and more. 项目地址: https://gitcode.com/gh_mirrors/zeppelin2/zeppelin

什么是Apache Zeppelin可视化插件

Apache Zeppelin的可视化插件是一种通过扩展框架在运行时动态加载/卸载的可插拔组件。这些插件本质上是一个JavaScript npm包，用户可以在Notebook中使用它们，就像使用内置的可视化功能一样。

可视化插件工作原理

1. 从注册表加载扩展包文件

Zeppelin需要知道有哪些可视化插件可用。它会从在线和本地注册表中读取包信息。注册表位置可以通过环境变量或配置文件进行设置。

2. 启用插件包

当Zeppelin从注册表加载扩展包文件后，可用包会显示在扩展菜单中。用户只需点击"启用"按钮即可激活插件。

3. 动态创建和加载可视化包

插件启用后，系统会创建一个JavaScript包，并通过REST API端点提供服务。

4. 使用可视化插件

启用后，Zeppelin会显示新增的可视化按钮，用户可以像使用内置可视化一样使用这些插件。

开发新的可视化插件

1. 创建npm包

首先需要创建一个包含package.json的npm包。必须包含两个关键依赖项：

zeppelin-vis：提供可视化基础类
zeppelin-tabledata：提供数据转换功能

示例package.json：

{
  "name": "my_zeppelin_vis",
  "description": "我的自定义可视化",
  "version": "1.0.0",
  "main": "index",
  "license": "Apache-2.0",
  "dependencies": {
    "zeppelin-tabledata": "*",
    "zeppelin-vis": "*"
  }
}

2. 创建可视化组件

需要创建一个继承自Visualization类的JavaScript文件。基本结构如下：

import Visualization from 'zeppelin-vis'
import PassthroughTransformation from 'zeppelin-tabledata/passthrough'

export default class MyVisualization extends Visualization {
  constructor(targetEl, config) {
    super(targetEl, config)
    this.passthrough = new PassthroughTransformation(config)
  }

  render(tableData) {
    // 在这里实现可视化渲染逻辑
    this.targetEl.html('这是我的可视化组件')
  }

  getTransformation() {
    return this.passthrough
  }
}

3. 创建扩展包文件

扩展包文件是一个JSON配置文件，包含以下关键信息：

{
  "type": "VISUALIZATION",
  "name": "my_visualization",
  "description": "我的自定义可视化描述",
  "license": "Apache-2.0",
  "artifact": "./path/to/my/package",
  "icon": "<i class='fa fa-chart'></i>"
}