代码生成功能使用

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

目标数据源维护

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

导出数据库文档

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

数据源管理界面

数据表管理

此步骤为可选操作。PIGX 支持在前端进行在线建表与表结构设计;如需更复杂的操作(如索引设置等),请使用专业的数据库设计工具在本地完成。

数据表管理界面
安全限制

【数据表管理】界面仅展示用户在该界面中新建的表,不会加载历史已有的数据表,以避免因在线编辑带来的安全风险。

生成代码设计

生成代码设计界面
谨慎同步

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

基本信息

基本信息配置
  • 本次生成代码表注释,如果表注释为空则需要手动填写
  • 当前代码所属 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)
主子表关系示意图

风格选择

风格设置

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

风格选择界面