apache/shardingsphere-ui

Apache ShardingSphere UI 镜像文档

1. 镜像概述

1.1 简介

Apache ShardingSphere UI是Apache ShardingSphere分布式数据库生态系统的官方可视化管理工具镜像，提供图形化界面用于配置、监控和管理ShardingSphere的核心功能（如数据分片、读写分离、分布式事务等），旨在简化分布式数据库的管理复杂度，提升运维效率。

1.2 主要用途

• 可视化配置分布式数据库分片规则、读写分离策略及数据脱敏规则
• 实时监控ShardingSphere集群运行状态、性能指标及数据流量
• 集中管理ShardingSphere Proxy/JDBC节点及注册中心配置
• 提供数据分片分布、SQL执行路径等可视化分析能力

2. 核心功能与特性

2.1 配置管理

• 支持分片规则（行表达式、分布式主键等）可视化配置与版本控制
• 提供读写分离策略（轮询、随机等）图形化配置界面
• 支持数据脱敏规则（AES、MD5等算法）直观配置
• 配置变更实时生效，无需重启集群节点

2.2 监控与告警

• 实时展示集群节点CPU/内存使用率、连接数等系统指标
• 监控分片数据分布、SQL执行耗时及吞吐量等业务指标
• 支持自定义告警规则（如节点下线、连接异常）及多渠道通知（邮件、钉钉等）
• 提供历史监控数据查询与趋势图表（折线图、柱状图等）

2.3 集群管理

• 可视化展示ShardingSphere集群拓扑结构及节点状态
• 支持Proxy/JDBC节点的添加、移除及配置同步
• 集成注册中心（ZooKeeper/Nacos）管理界面，便捷维护注册中心元数据
• 支持集群配置的批量导入/导出及备份恢复

2.4 数据可视化

• 分片表数据分布热力图及均衡性分析
• SQL执行路径可视化，直观展示路由过程
• 数据源连接池状态（活跃连接数、空闲连接数）实时监控
• 分布式事务状态及历史记录查询

3. 使用场景与适用范围

3.1 适用场景

• 企业级分布式数据库环境中，简化ShardingSphere配置与运维流程
• 运维团队需要实时掌握分布式数据库集群运行状态
• 开发人员在测试/生产环境快速验证分片规则有效性
• 对分布式数据库进行集中化管理，降低人工操作风险

3.2 适用人群

• 分布式数据库运维工程师
• 数据库开发人员
• ShardingSphere集群管理团队
• 需监控分布式数据库性能的技术负责人

4. 使用方法与配置说明

4.1 拉取镜像

bash
docker pull apache/shardingsphere-ui:latest

4.2 基础启动命令

默认配置启动（连接本地ShardingSphere集群，使用H2内存数据库存储元数据）：

bash
docker run -d -p 8080:8080 --name shardingsphere-ui apache/shardingsphere-ui:latest

4.3 自定义配置启动

4.3.1 环境变量配置

通过环境变量修改核心配置（完整参数见下表）：

bash
docker run -d -p 8080:8080 \
  --name shardingsphere-ui \
  -e SPRING_PROFILES_ACTIVE=prod \
  -e SERVER_PORT=8080 \
  -e REGISTRY_CENTER_TYPE=zookeeper \
  -e REGISTRY_CENTER_CONNECT_STRING=zookeeper://192.168.1.100:2181 \
  -e SPRING_DATASOURCE_URL=jdbc:mysql://192.168.1.101:3306/shardingsphere_ui \
  -e SPRING_DATASOURCE_USERNAME=admin \
  -e SPRING_DATASOURCE_PASSWORD=Admin@123 \
  apache/shardingsphere-ui:latest

4.3.2 核心环境变量说明

4.4 docker-compose集成示例

yaml
version: '3.8'
services:
  shardingsphere-ui:
    image: apache/shardingsphere-ui:latest
    container_name: shardingsphere-ui
    ports:
      - "8080:8080"
    environment:
      - SPRING_PROFILES_ACTIVE=prod
      - REGISTRY_CENTER_TYPE=zookeeper
      - REGISTRY_CENTER_CONNECT_STRING=zookeeper:2181
      - SPRING_DATASOURCE_URL=jdbc:mysql://mysql:3306/shardingsphere_ui?useSSL=false&serverTimezone=UTC
      - SPRING_DATASOURCE_USERNAME=root
      - SPRING_DATASOURCE_PASSWORD=Root@123
    depends_on:
      - zookeeper
      - mysql
    restart: always

  zookeeper:
    image: zookeeper:3.8
    container_name: zookeeper
    ports:
      - "2181:2181"
    volumes:
      - zk-data:/data
    restart: always

  mysql:
    image: mysql:8.0
    container_name: mysql
    ports:
      - "3306:3306"
    environment:
      - MYSQL_ROOT_PASSWORD=Root@123
      - MYSQL_DATABASE=shardingsphere_ui
    volumes:
      - mysql-data:/var/lib/mysql
    restart: always

volumes:
  zk-data:
  mysql-data:

启动命令：

bash
docker-compose up -d

4.5 访问与使用

1. 容器启动后，通过浏览器访问 http://<主机IP>:8080
2. 使用默认账号密码登录：admin/admin（首次登录需修改密码）
3. 根据注册中心配置自动发现ShardingSphere集群节点，进入对应功能模块操作

5. 注意事项

• 生产环境配置：必须使用外部数据库（如MySQL）存储UI元数据，避免H2内存数据库导致数据丢失
• 网络安全：配置防火墙策略，限制UI访问IP；通过HTTPS加密传输（可配合Nginx反向代理实现）
• 资源配置：根据集群规模调整容器资源（建议至少2核4G内存），避免监控数据处理延迟
• 版本兼容：UI版本需与ShardingSphere集群版本保持一致（如UI 5.4.0对应集群5.4.x版本）

6. 参考资源

• 官方文档
• https://github.com/apache/shardingsphere-ui
• https://hub.docker.com/r/apache/shardingsphere-ui