Superset二次开发之深度解读系列：1.概述

Apache Superset 是一款现代化的企业级商业智能 Web 应用程序，专为数据探索和可视化而设计。本概述介绍了 Superset 的架构、核心组件和主要功能，以帮助开发人员了解该系统的工作原理。

What is Apache Superset?  

Apache Superset 是一个开源数据探索和可视化平台，其设计理念是用户友好、功能丰富且高度可扩展。它允许用户连接到各种数据库、创建交互式可视化效果并构建仪表板，而无需编写代码，同时还为高级用户提供了强大的功能。

Superset 基于 Python Flask 后端和基于 React 的前端构建。它通过 SQLAlchemy 支持多种数据库和数据引擎，并通过基于插件的系统提供各种可视化选项。

资料来源：

• superset/config.py

Key Features 主要特点

Superset 为数据浏览和可视化提供了一套全面的功能：

1. SQL Lab：用于直接查询数据库的交互式 SQL 编辑器
2. Chart Builder：用于创建可视化的无代码界面
3. Dashboard Builder：用于将可视化合并到交互式仪表板中的工具
4. Database Connections ： 支持 30+ 数据库，包括 PostgreSQL、MySQL、BigQuery、Snowflake 等常用数据库
5. Security ：使用基于角色的权限系统进行精细访问控制
6. Caching ：可配置的缓存以提高性能
7. API：用于自定义和集成的编程访问

资源来源：

• superset/config.py

System Architecture 系统架构

Superset 遵循客户端-服务器架构，具有单独的前端和后端组件，通过 REST API 进行通信。

High-Level Architecture 高级架构

资源来源：

• superset/models/core.py
• superset/security/manager.py

Data Flow 数据流

下图说明了数据如何流经 Superset 系统

资料来源：

• superset/common/query_context.py
• superset/views/core.py

Core Components  核心组件

Superset 的架构由几个核心组件组成，这些组件协同工作以提供其功能：

Database Connectors and Engine Specs   数据库连接器和引擎规格

Superset 通过 SQLAlchemy 连接到各种数据库。每个受支持的数据库都有一个 EngineSpec 类，用于处理特定于数据库的功能，例如时间粒度表达式、类型映射和查询执行。

资料来源：

• superset/db_engine_specs/base.py
• superset/db_engine_specs/presto.py
• superset/db_engine_specs/hive.py
• superset/db_engine_specs/postgres.py

Data Models 数据模型

Superset 中表示系统中不同实体的核心数据模型：

资料来源：

• superset/models/core.py
• superset/connectors/sqla/models.py
• superset/security/manager.py

Visualization System 可视化系统

Superset 使用基于插件的可视化系统，该系统支持多种图表类型

资料来源：

• superset/viz.py
• superset/common/query_object.py
• superset/common/query_context.py

Security Model 安全模型

Superset 基于 Flask-AppBuilder 实现了一个健壮的安全模型：

资料来源：

• superset/security/manager.py
• superset/views/base.py

Configuration and Deployment 配置和部署

可以通过 superset_config.py 中的各种设置来配置 Superset。主配置文件 superset/config.py 包含所有可以覆盖的默认设置。

Deployment Options  部署选项

Superset 可以通过多种方式进行部署：

Feature Flags 功能标志

Superset 使用功能标志来启用或禁用某些功能。这些可以在 superset_config.py 中配置：

FEATURE_FLAGS = {
    "DRILL_BY": True,
    "DASHBOARD_VIRTUALIZATION": True,
    "EMBEDDABLE_CHARTS": True,
    "SQL_VALIDATORS_BY_ENGINE": True
}

资料来源：

• superset/config.py 
• RESOURCES/FEATURE_FLAGS.md

Extensibility 可扩展性

Superset 的设计使其可以通过多种方式进行扩展

1. Database Support：通过创建自定义引擎规范添加对新数据库的支持
2. Visualizations：创建自定义可视化插件
3. Authentication：与自定义身份验证系统集成
4. API Integration：使用 Superset 的 REST API 与其他系统集成

资料来源：

• superset/db_engine_specs/base.py
• superset/views/base.py

 Getting Started  入门

对于希望贡献或定制 Superset 的开发人员，代码库的组织方式如下

superset/ ——Superset 后端代码

 -- superset/views/ ——Flask 视图和 API 端点

 -- superset/models/ ——SQLAlchemy 模型

 -- superset/db_engine_specs/ ——数据库引擎规范

 -- superset/connectors/ ——数据库连接器

 -- superset/security/ ——安全和身份验证

superset-frontend/ - React 前端代码

 -- superset-frontend/src/ - 源代码

 -- superset-frontend/plugins/ - 可视化插件

资料来源：

• README.md
• superset/initialization/init.py

待更新目录