代码生成功能使用

pclin
27
2025-01-09

提供交互式的 Web UI 用于生成兼容 mybatis-plus 框架的相关功能代码,包括 Entity,Mapper,Mapper.xml,Service,Controller、前端 vue 等 ,可以自定义模板以及各类输出参数,实现更高灵活度的代码生成。

#一、 目标数据源维护

开发平台>数据源管理 > 新增

数据库文档

在维护之后,可以在数据源管理的表格中选择相应的数据源,然后在右侧操作栏中导出相关的数据库文档。

#二、 生成代码设计

【同步】表结构

请谨慎使用“同步”功能,因为它会获取表的元信息(字段等)并覆盖上次代码设计的结果。

#①【生成】基本信息

  • ① 本次生成代码表注释,如果表注释为空则需要手动填写

  • ② 当前代码所属 PIGX 模块名称(比如 admin)

  • ③ 当前代码的功能名引文 (比如 address),经过 ② ③ 设置可获得 java package 为如下的代码

package 项目包名.模块名.功能名

  • ④ 选择代码风格,默认: 生成单表的增删改查、前后端代码等,主子表: 详细第四节说明

  • ⑤ 后端生成路径, 点击代码生成生成的相关的后端代码会自动移动到此目录下方便开发

#示例:生成的后端放在单体项目的pigx-upms-biz 目录下
/Users/lengleng/work/super/pigx-boot/pigx-upms/pigx-upms-biz

  • ⑥ 前端生成路径, 点击代码生成生成的相关的前端代码会自动移动到此目录下方便开发

#示例:生成的前端放在单体项目UI目录下
/Users/lengleng/work/super/pigx-ui

#②【生成】属性设置

该功能可以自动管理目标表的字段信息,并自动匹配字段对应的 java 类型。 请注意:

  • 维护字段说明

  • 如果是字典类型的字段,请维护关联的字段名

  • 自动填充策略对应 mybatis-plus 的自动填充策略。

#③【生成】列表查询

该功能可控制生成的表格界面及其查询相关字段。 请注意:

  • 列表显示:控制此字段是否在表格中显示

  • 是否显示:控制此字段是否作为查询条件在顶部显示。

#④【生成】表单页面

该功能可控制生成的表单界面 请注意:

  • 是否显示:控制此字段是否在表单中显示。

#四、主子表(一对多)代码生成

#① 子表配置

在上文 二、①基本信息维护时,如点击子表按钮,会自动弹出子表配置界面

如何理解主子表

  • 主表字段: 选择主表 user 中的关联条件字段(一般为主键 id)

  • 子表字段: 选择从表 address 中的关联条件字段 (user_id)

#② 风格选择

风格选择

如需要主子表代码生成,必须选择 主子表风格

#五、 表单设计器

表单设计器基于 vform 开源版本项目 (pigcloud已购买商业使用版权,vform 官方已允许隐藏或定制产品名),详细使用 文档参考 (opens new window)

经过上述第二步(④)表单页面的设置之后,点击“开发平台”>“代码生成”>“设计”,即可微调字段。此功能仅作为表单设计的辅助功能。如果需要生成整套代码,请参考以上操作。

#① 基本使用

  • 栅栏布局的设置:点击空白处可设置栅栏。若需要一行两列的布局,则每个宽度应设置为 12。

  • 新增字段:首先在左侧组件库中拖拽栅栏容器,每个栅栏推荐放置两个组件。

  • 针对下拉、多项和单选字段的字典设置操作:选中相关字段后,可以在右“组件设置”面板中进行远程字典的设置,并自动关联“字典管理”数据。

#② 设计结果导出

动物装饰