# flavor

**Repository Path**: openus/flavor

## Basic Information

- **Project Name**: flavor
- **Description**: flavor 是一款数据库客户端连接工具
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-22
- **Last Updated**: 2026-05-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Flavor - 数据库管理客户端

<div align="center">
  <img src="src/pic/f1.png" alt="Flavor" width="400"/>
  <img src="src/pic/f2.png" alt="Flavor" width="400"/>
</div>

## 简介

- Flavor 是一款跨平台数据库管理客户端，基于 Electron 和 Vue.js 构建。它提供统一的管理界面，支持 MySQL、SQLServer、Redis 和 ZooKeeper 等多种数据库类型。
- 主要用于管理自己的数据库，提供方便的界面和功能。

## 功能特性

### 多数据库支持
- **MySQL / SQLServer** - 功能完整的 SQL 编辑器，支持语法高亮、自动补全和查询执行
- **Redis** - 直观的键值浏览器，支持 String、Hash、List、Set、ZSet 等数据类型
- **ZooKeeper** - 树形节点浏览器，支持完整的 CRUD 操作

### SQL 查询编辑器
- SQL 语法高亮（CodeMirror）
- 智能自动补全（SQL 关键字、表名、列名）
- 多种结果视图（表格、JSON）
- 查询历史记录
- 保存和组织常用查询

### 数据管理
- 可视化表结构查看器
- 数据导出（CSV、JSON、SQL）
- 数据导入（CSV）
- 表创建和修改向导

### 数据迁移
- 同类型数据库迁移（MySQL → MySQL、SQLServer → SQLServer）
- 表结构迁移
- 选择性表/字段迁移

### 现代化界面
- 深色/浅色主题切换
- 响应式布局
- 键盘快捷键
- 系统托盘支持

## 技术栈

- **前端框架**: Vue 3 + TypeScript + Element Plus
- **桌面框架**: Electron 33
- **构建工具**: electron-vite + Vite
- **状态管理**: Pinia
- **数据库驱动**: MySQL Connector、Redis、ZooKeeper Java 客户端

## 开发

### 环境要求

- Node.js >= 18
- Yarn >= 1.22
- Java 11+（用于后端 API）

### 安装依赖

```bash
yarn install
```

### 启动开发服务器

```bash
yarn dev
```

### 构建生产版本

```bash
yarn dist
```

构建后的应用位于 `release/` 目录。

### 构建配置

创建 `.env` 文件配置后端 API 地址：

```env
VITE_API_BASE_URL=http://localhost:18887
```

## 项目结构

```
flavor/
├── src/
│   ├── core/                 # 核心应用模块
│   │   ├── main/             # Electron 主进程
│   │   ├── preload/          # Electron 预加载脚本
│   │   ├── renderer/        # Vue.js 渲染进程
│   │   │   ├── layouts/     # 布局组件
│   │   │   ├── stores/      # Pinia 状态管理
│   │   │   └── styles/      # 全局样式
│   │   └── shared/          # 共享工具
│   │       ├── api/         # API 客户端
│   │       ├── event-bus/   # 事件总线
│   │       └── plugin-system/ # 插件系统
│   ├── plugins/              # 功能插件
│   │   ├── plugin-connection/    # 连接管理
│   │   ├── plugin-query-editor/  # SQL 查询编辑器
│   │   ├── plugin-query-history/  # 查询历史
│   │   ├── plugin-redis/          # Redis 浏览器
│   │   ├── plugin-saved-query/   # 保存的查询
│   │   ├── plugin-table-structure/ # 表结构查看器
│   │   ├── plugin-table-viewer/   # 表数据查看器
│   │   ├── plugin-export/          # 数据导出
│   │   ├── plugin-import/         # 数据导入
│   │   └── plugin-zookeeper/     # ZooKeeper 浏览器
│   └── pic/                 # 图片资源
├── public/                  # 静态资源
├── dist-electron/          # 构建输出
└── release/               # 打包后的应用
```

## 后端 API

Flavor 需要运行 `flavor-admin` 后端服务。默认连接到 `http://localhost:18887`。

后端配置说明请参考 [flavor-admin](../flavor-admin/README.md)。

## 键盘快捷键

| 快捷键 | 功能 |
|--------|------|
| `Ctrl+Enter` | 执行查询 |
| `Ctrl+S` | 保存查询 |
| `Ctrl+Q` | 新建查询 |
| `Ctrl+H` | 切换历史面板 |
| `Ctrl+,` | 打开设置 |
| `Escape` | 关闭弹窗/取消 |


## release

前端 ： yarn dist （先注释 .gitignore 中的 dist-electron/ ，打包完恢复）