Files
yidaima/RuoYi-Vue/doc/code-generator-platform.md
王鹏 a8bd6c53be init
2025-08-14 14:43:47 +08:00

2.6 KiB
Raw Blame History

代码生成平台功能规划

1. 平台概述

代码生成平台是一个基于RuoYi-Vue框架的扩展系统旨在提供可视化的项目代码生成服务。该平台支持通过配置化的方式快速生成前后端代码提高开发效率减少重复工作。

2. 核心功能模块

2.1 项目管理

  • 项目基本信息配置
    • 项目名称、包名、版本号
    • 项目描述、作者信息
    • 技术栈选择(前端框架、后端框架等)
  • 项目依赖管理
    • 自动生成pom.xml/package.json
    • 依赖版本管理
  • 项目结构预览
    • 可视化展示项目目录结构
    • 支持自定义目录结构

2.2 模块配置

  • 自定义模块配置
    • 模块基本信息
    • 数据库表设计
    • 字段配置
    • 关联关系
    • 业务规则

2.3 代码生成

  • 后端代码生成
    • 实体类生成
    • Mapper接口生成
    • Service接口及实现类生成
    • Controller生成
    • 配置文件生成
    • 单元测试生成
  • 前端代码生成
    • Vue组件生成
    • API接口生成
    • 路由配置生成
    • 权限配置生成
  • 代码预览
    • 支持在线预览生成的代码
    • 支持代码编辑和调整
  • 代码下载
    • 支持按模块下载
    • 支持整体项目下载

2.4 模板管理

  • 内置模板
    • 提供常用业务场景的代码模板
    • 支持模板分类管理
  • 自定义模板
    • 支持用户自定义代码模板
    • 模板导入导出
    • 模板版本管理

2.5 生成配置

  • 代码风格配置
    • 缩进、换行等格式设置
    • 命名规范配置
  • 注释配置
    • 类注释模板
    • 方法注释模板
    • 字段注释模板
  • 代码规范配置
    • 代码检查规则
    • 格式化规则

3. 技术架构

3.1 前端技术栈

  • Vue 2.x
  • Element UI
  • Axios
  • Vue Router
  • Vuex

3.2 后端技术栈

  • Spring Boot
  • MyBatis
  • MySQL
  • Redis
  • Maven

4. 数据库设计

4.1 核心表结构

  • 项目表(gen_project)
  • 模块表(gen_module)
  • 模板表(gen_template)
  • 配置表(gen_config)

5. 接口设计

5.1 项目管理接口

  • 项目CRUD
  • 项目配置管理
  • 项目结构管理

5.2 模块管理接口

  • 模块CRUD
  • 模块配置管理
  • 模块关联管理

5.3 代码生成接口

  • 代码预览
  • 代码生成
  • 代码下载

5.4 模板管理接口

  • 模板CRUD
  • 模板导入导出
  • 模板版本管理

6. 安全设计

  • 用户认证
  • 权限控制
  • 操作日志
  • 数据加密

7. 部署方案

  • 支持Docker部署
  • 支持集群部署
  • 支持多环境配置

8. 后续规划

  • 支持更多技术栈
  • 支持微服务架构
  • 支持云原生部署
  • 支持AI辅助代码生成
  • 支持代码质量分析
  • 支持自动化测试生成