Scaffold-Boot-3.0框架使用文档Scaffold-Boot-3.0框架使用文档
首页
快速开始
变更记录
Source
首页
快速开始
变更记录
Source
  • 开始
  • 基础

    • 目录结构
    • 代码生成器
    • 增删改查
    • 异常处理
    • Knife4j(Swagger)文档
    • 登录&登出
    • 系统安全
    • 数据字典
    • Excel处理
    • 文件上传下载
    • 工具类
    • 定时任务
    • 微信集成
    • 短信服务
    • 参数配置
    • 接口限流
    • 日志审计
    • 数据脱敏
    • 网站管理
  • AI开发

    • AI项目工程结构
    • MCP服务
    • AI开发模式介绍
  • 开发规范
  • 常见问题
  • 深入

    • 配置详解-Config类
    • 配置详解-Yml配置文件
  • 生命周期

    • SonarQube代码质量保证
    • 部署到测试环境
    • 部署到正式环境
  • 优秀案例

    • Excel导入完整案例
  • 信创专区

    • 海量数据库
    • 神通数据库
    • 达梦数据库
    • 麒麟v10安装插件
  • 框架升级

代码生成器

章节简介

本章将介绍如何使用代码生成器,快速实现基于单表的增删改查功能。包括查询参数,也可一键生成。用好代码生成器,可以做到一次生成,无需修改,立即使用

功能入口

提示

启动项目后打开系统管理->代码生成,即可进入生成模块。可通过表名搜索到需要生成的表,点击操作列中“代码生成”按钮即可打开对应表的生成配置界面。
配置完成后:
1、点击“生成代码”按钮浏览器将自动下载代码Zip包。
2、点击“生成到本地”按钮,代码zip包将生成在项目目录下的.generated文件夹下。

img.png

img.png

img.png

生成内容配置

  1. 注释配置

提示

此属性用于配置查询条件、列表页表头、详情页、表单页内,此字段显示的中文名称:

默认取出数据库中字段的备注,当数据库中字段备注与展示内容不一致时,可根据实际情况进行微调。

举例:status一般建表时设置备注为“状态(0禁用,1启用)”,但实际应该显示为“状态”。这种情况就可以在这里进行配置修改。

img_1.png

  1. 展示配置:

提示

通过勾选操作,可分别配置字段在“列表页”、“详情页”、“编辑页”是否展示。

在图例中birth、remark未勾选列表展示,则在列表页的表格上不会展示这两列;详情页和表单页所有字段均勾选,则全部展示。

img_2.pngimg_3.png

列表页字段展示
  1. 查询条件配置:

提示

如某字段需要作为列表页查询条件,则可在“查询条件”下拉列表中选择对应查询方式,代码生成器将自动生成此查询条件

目前支持“完全匹配”、“模糊匹配”、“在范围内”。其中“模糊匹配”仅支持字符串类数据库字段。“在范围内”仅支持数字、时间类数据库字段。系统将根据具体类型,生成开始、结束两个查询条件用于范围查询

更多信息请参考附录

img_4.png

img_5.png

列表页查询条件展示
  1. 字典配置

提示

字符类型字段可标记为字典数据字段,常见的例如audit_status、company_type这一类数据库中存code的字段。

配置为字典后生成器将进行如下操作

1.列表页此字段将自动翻译为对应字典中文

2.详情页同上

3.编辑页此字段以对应字典下拉组件编辑

4.如果此字段为查询条件,则以对应字典下拉组件展示此查询条件

img_6.png

img_7.png

列表页字典配置效果展示

img_8.png

详情页字典配置效果展示

img_9.png

表单页字典配置效果展示
  1. 必填配置

提示

用于配置编辑页此字段是否必填

img_10.png

img_11.png

必填配置效果展示

生成结构配置

  1. 基本配置(模块名、 JAVA 类名、 VUE 列表页名、接口路径)

注意

注:系统默认根据表名带出,一般无需修改;

img_12.png

模块名:控制Java和Vue代码所处的文件夹(模块)名称

img_13.png

模块名

Java类名:控制从Controller到Mapper以及实体Java类的前缀

img_14.png

JAVA 类名

Vue文件名称:控制生成的Vue文件名称

img_15.png

VUE 列表页名

接口路径:控制Controller级@RequestMapping的值

img_16.png

接口路径

附录

1. 配置相关对应关系表:
MySQL属性类型JAVA属性类型查询条件匹配类型
varchar、char等StringEQ(完全匹配)、LIKE(模糊匹配)、IN(在列表内)
bigintLongEQ(完全匹配)、IN(在列表内)
bitBooleanEQ(完全匹配)
int、tinyint、double、float、decimal等Integer、Double、Float、DecimalEQ(完全匹配)、IN(在列表内)、RANGE(在范围内)
date、datetime等LocalDate、LocalDateTimeEQ(完全匹配)、IN(在列表内)、RANGE(在范围内)

表 1:字段类型与查询条件匹配类型对应关系表

JAVA属性类型查询条件匹配类型查询条件组件表单组件
String是字典EQ(完全匹配)、LIKE(模糊匹配)单选字典下拉框可多选多选字典下拉框
IN(在列表内)多选字典下拉框不可多选单选字典下拉框
不是字典EQ(完全匹配)、LIKE(模糊匹配)普通输入框普通输入框
IN(在列表内)多选下拉框
LongEQ(完全匹配)单选下拉框多选下拉框
IN(在列表内)多选下拉框
BooleanEQ(完全匹配)单选下拉框(选是/否)radio单选框组(选是/否)
Integer、Double、Float、DecimalEQ(完全匹配)number输入框number输入框
IN(在列表内)普通输入框
RANGE(在范围内)number范围框
LocalDateEQ(完全匹配)日期单选框日期单选框
IN(在列表内)日期多选框
RANGE(在范围内)日期范围框
LocalDateTimeEQ(完全匹配)、IN(在列表内)日期时间选择框日期时间选择框
RANGE(在范围内)日期时间范围框

表 2:查询条件匹配类型与前端展示组件对应关系表

2. 数据库存储类型为tinytext、text、mediumtext、longtext的字段:

提示

详情整行展示,其他字段自动调整,效果如下:

img_17.png

提示

表单页用 textarea组件整行展示,效果如下:

img_18.png

3. Long类型代码生成默认为有关联关系的字段(一般为关联其他表的 id)

提示

查询条件、表单页的下拉可选择数据获取需自行实现

列表页、详情页的展示需自行实现数据转换

在 GitLab 上编辑此页
最后更新: 2025/11/10 17:22
贡献者: xuew, yangxu, lidan
Prev
目录结构
Next
增删改查