Skip to content

代码生成器概览

代码生成器是 Forge Admin 的核心效率工具,能将数据库表一键转换为包含前后端完整代码的 CRUD 功能模块,大幅降低重复开发工作量。

功能入口

登录管理后台后,点击左侧菜单 代码生成 > 代码生成,进入代码生成器页面。

生成流程

代码生成器遵循四步流程:导入表 → 配置字段 → 预览配置 → 下载代码

第一步:导入数据库表

  1. 在代码生成器首页,点击 导入 按钮
  2. 系统自动连接数据库,列出当前库中的所有用户表
  3. 勾选需要生成代码的表(支持多选)
  4. 点击 确定,表信息被导入生成器

第二步:配置字段

  1. 在列表中找到已导入的表,点击操作列的 编辑 按钮
  2. 进入字段配置页面,系统已根据数据库字段自动生成默认配置
  3. 针对每个字段进行调整:
配置项说明
字段名默认使用数据库列名
字段描述页面显示的中文标签
Java 类型自动映射,如 varchar→String, datetime→Date
表单类型输入框/下拉框/日期选择/文件上传
是否必填控制表单校验规则
是否列表显示控制表格列显示
是否查询条件控制搜索表单字段
是否为导入/导出控制 Excel 字段
  1. 配置完成后点击 提交

第三步:预览配置

  1. 在列表中找到目标任务,点击 预览 按钮
  2. 查看生成的代码结构预览:
    • 后端:Controller / Service / ServiceImpl / Mapper / Entity / XML
    • 前端:API 定义 / Vue 页面
    • SQL:菜单和权限的 INSERT 语句
  3. 确认无误后进入下载步骤

第四步:下载代码

  1. 点击 生成 按钮,系统生成完整的 ZIP 压缩包
  2. 下载 ZIP 文件到本地
  3. 解压后按目录结构放置到项目中:
    • 后端代码放入 forge-admin-server/src/main/java/...
    • 前端代码放入 forge-admin-ui/src/views/...
    • SQL 脚本在数据库中执行

生成能力

代码生成器自动生成以下完整代码:

  • 后端:Controller(RESTful 接口)、Service(业务层)、Mapper(数据访问)、Entity(实体类)、DTO/VO
  • 前端:完整的 CRUD Vue 页面(列表 + 新增/编辑表单)、API 接口定义文件
  • 配置:菜单资源 SQL、权限标识配置

使用技巧

  • 表名和字段注释建议使用中文,生成器会自动提取为页面标签
  • 导入前确认数据库表结构已定稿,避免反复生成
  • 高级配置中可设置生成模板、作者信息、包路径等偏好
  • 生成后建议先在开发分支中集成测试,再合并到主分支

注意事项

  • 生成器不会覆盖已有的同名文件,避免意外丢失自定义代码
  • 后端代码需按 Maven 目录结构放置
  • 生成的 SQL 脚本需手动执行到数据库

相关文档

Forge Admin — 基于 Vue3 + Spring Boot 的企业级后台管理框架