sql-backend

智能sql生成管理系统

为提高开发者工作效率而生！！！

SQL Father - 模拟数据生成器（前端）

在线体验：https://sqlfather.com/

前端代码仓库：https://github.com/xiaoxu9/sql-frontend

后端代码仓库：https://github.com/xiaoxu9/sql-backend

项目背景

项目的创作起因就是鱼皮为了解决自己开发项目时反复写 SQL 建表和造数据的麻烦，顺便开源给大家一起来学习和完善~

试想一下：如果我做新项目的时候，不用写建表 SQL、不用造数据，能直接得到一个造好了假数据的表，那该有多好！

主要应用场景如下：

1）通过填写可视化表单的方式，快速生成建表语句、模拟数据和代码，告别重复工作！

2）支持多种快捷导入方式。比如已经有现成的数据表，可以直接导入建表语句，一键生成模拟数据；还可以直接导入 Excel 表格，快速完成建表；甚至还支持智能导入，输入几个单词就自动生成表格和数据！

3）支持多种生成模拟数据的规则。比如固定值、随机值、正则表达式、递增值，甚至还支持选择词库来生成特定范围内的随机值！

4）支持词库、表设计、字段信息共享。可以学习或参考其他同学的库表设计，或者直接使用现成的库表和字段，一键生成或进行二次开发，协作万岁！

5）可以直接使用现成的词库来建立字典表，或者作为研究用的数据集，并支持二次完善词库！

功能大全

用户前台

• 可视化建表
• 快捷导入建表
  • 智能导入
  • 导入表
  • 导入配置
  • 导入建表 SQL
  • 导入 Excel
• 一键生成
  • SQL 建表、插入数据语句
  • 模拟数据
  • JSON 数据
  • Java 代码
  • 前端代码
• 多种模拟数据生成规则
  • 固定值
  • 随机值
  • 正则表达式
  • 递增
  • 定制词库
• 词库共享
  • 创建词库
  • 词库继承
  • 一键创建字典表
  • 根据词库生成模拟数据（可以用来决定午饭吃什么哈哈）
• 表信息共享
  • 创建表信息
  • 一键复制建表语句
  • 一键导入表
• 字段共享
  • 创建字段
  • 一键复制创建字段语句
  • 一键导入字段
• 举报

管理后台

• 用户管理
• 词库管理
• 表信息管理
• 字段信息管理
• 举报管理

技术栈

前端

主要技术：

• React 18
• Umi 4.x
• Ant Design 4.x 组件库
• Ant Design Pro Components 高级组件
• TypeScript 类型控制
• Eslint 代码规范控制
• Prettier 美化代码

依赖库：

• monaco-editor 代码编辑器
• copy-to-clipboard 剪切板复制

后端

主要技术：

• Spring Boot 2.7.x
• MyBatis Plus 3.5.x
• MySQL 8.x
• Spring AOP

依赖库：

• FreeMarker：模板引擎
• Druid：SQL 解析
• datafaker：模拟数据
• Apache Commons Lang3：工具库
• Hutool：工具库
• Gson：Json 解析
• Easy Excel：Excel 导入导出
• Knife4j：接口文档生成

快速启动

后端

1. 运行 sql 目录下的 create_table.sql 建表
2. 修改 application.yml 中的数据库地址为自己的
3. 安装完 Maven 依赖后，直接运行即可
4. 已经编写好了 Dockerfile，支持 Docker 镜像部署。

前端

安装依赖：

npm run install

运行：

npm run dev

打包：

npm run build

系统设计

主要分享系统的整体架构和核心设计，而传统 web 开发部分不做过多介绍。

整体架构设计

核心设计理念：将各输入方式统一为明确的 Schema，并根据 Schema 生成各类内容。

架构设计图如下，即任意输入 => 统一 Schema => 任意输出：

系统分为以下几个核心模块，各模块职责分明：

1. Schema 构造器：将各种不同的输入源转为统一的 Table Schema 定义
2. 统一 Schema 定义：本质是一个 Java 类（JSON 配置），用于保存表和字段的信息
3. 生成器：负责根据 Schema 生成数据和代码
4. 共享服务：包括词库、表信息、字段信息共享

核心模块的代码都在后端 core 目录下

Schema 构造器

核心类：TableSchemaBuilder，作用是将不同的参数统一收敛为 TableSchema 对象。

Schema 定义

用于保存表和字段的信息，结构如下：

{
  "dbName": "库名",
  "tableName": "test_table",
  "tableComment": "表注释",
  "mockNum": 20,
  "fieldList": [{
    "fieldName": "username",
    "comment": "用户名",
    "fieldType": "varchar(256)",
    "mockType": "随机",
    "mockParams": "人名",
    "notNull": true,
    "primaryKey": false,
    "autoIncrement": false
  }]
}

生成器

多种生成类型

将每种生成类型定义为一个 Builder（core/builder 目录）：

其中，对于 SQL 代码生成器（ SqlBuilder），使用方言来支持不同的数据库类型（策略模式），并使用单例模式 + 工厂模式创建方言实例。

对于 Java、前端代码生成器（JavaCodeBuilder、FrontendCodeBuilder），使用 FreeMarker 模板引擎来生成。

多种模拟数据生成规则

每种生成规则定义为一个 Generator，使用 DataGeneratorFactory（工厂模式）对多个 Generator 实例进行统一的创建和管理。

使用 dataFaker 库实现随机数据生成（RandomDataGenerator）。

使用 Generex 库实现正则表达式数据生成（RuleDataGenerator)。

统一的生成入口

使用门面模式聚合各种生成类型，提供统一的生成调用和校验方法

共享服务

包括词库、表信息、字段信息共享，其实就是对这些实体的增删改查 web 服务。