概述
单表的增删改查是开发过程中最常用、最简单、技术含量较低的代码开发,重复性的机械劳动,不仅浪费了宝贵的开发时间还会拖慢思路,直接降低开发质量。为了解决这一问题,Pangea 2.0
引入了代码生成,根据数据库已存在表结构,一键生成增删改查代码,提高开发效率,更多的时间留给开发人员开发关键业务代码。
「代码生成」入口
从应用列表中,找到「代码生成工具」并进入
快速上手
提前准备:数据库中建好该功能对应的表,建表时最好加上字段的注释和表的说明,方便理解。
下面以page_group
为例所一下演示说明
Step1:数据表导入
首先添加需要对哪张表创建增删改查,点击「导入」,显示"导入表结构"。
- 由于数据表较多,你可以通过名称或描述来查询你的数据表,对于搜索结果不满意可以点击重置
- 可以通过切换「数据库唯一KEY」来切换数据库,默认状态下,我们只展示默认库的数据表
- 一次可以同时导入多张数据表
点击代码生成编辑按钮,会出现基本信息、字段信息和生成信息3个页签
基本信息
- 表名称:数据表的英文编码,必填字段
- 表描述:数据表的中文名称,便于快速了解,该名称也可能会出现在一些与表相关的功能中,必填字段
- 实体类名称:代码中domain对象名称,必填字段
- 作者,必填字段
- 备注, 选填字段,建议填写表结构的业务含义
字段信息
在这里你可以对你的数据表进行最后的调整,尤其注意以下几项:
- 字段描述:对应实体属性注释
- 物理类型:对应物理表字段类型
- Java类型:对应JAVA代码表字段类型
- Java属性:对应JAVA代码表字段名称
- 插入、编辑、列表、查询:可以手动选择
- 查询方式:比如模糊查询可以选择LIKE
- 必填:选中后该字段将为必填
- 显示类型:可以选择文本框、文本域、下拉框、单选框以及日期控件
- 字典类型:手动输入
生成信息
- 生成模板:单表增删改查(一般选此项)、树表增删改查(树表无分页,数据展示为树形表格)
- 树编码字段:树显示的编码字段名, 如:dept_id
- 树父编码字段:树显示的父编码字段名, 如:parent_Id
- 树名称字段:树节点的显示名称字段名, 如:dept_name
- 生成包路径:生成在哪个包下;实际对应
package
- 生成模块名:一般为模块英文简称;
- 生成业务名:一般为功能英文简称;实际对应类上
@RequestMapping("xxx")
中的xxx
- 生成功能名:类描述;实际对应类文件注释
上述信息全部填写完毕后,点击「提交」完成导入。
Step2:预览检查
数据表导入后,点击操作列的「预览」按钮,可以预览代码检查生成信息是否有误。
Step3:生成代码
确认无误后,点击操作列的「生成代码」按钮,代码将会以zip包的形式下载到本地,然后导入程序中使用。
注意事项
- 数据库的表一定要完整的写上注释和表说明
- 可以多张表同时生成代码,同时导入到编译器,提高开发效率
- 生成的代码查询方式使用的是
mybatis-plus,.xml
文件里只有简单的映射,一些自定义的查询请参考mybatis-plus
使用方式,尽量避免直接在xml
里写sql
的方式查询 - 导入后可以进行编辑操作,点击删除按钮将直接删掉生成的表数据,请谨慎操作
特别注意
代码生成工具为封装接口,请勿单独调用
常见问题
1.生成的代码前端字段缺少显示中文显示?
因为数据库没有加上字段注释,编辑时也没有加上,导致中文注释是空的,建议大家创建表时,增加字段注释,方便运维和理解。
2.表修改了,代码生成的代码没相应修改?
因为没有重新导入,从列表中删除该张表后重新导入,再生成代码。
3.导入里没有自己建的表?
生成代码服务是个单独的服务(gen
),确认建表的库和gen
服务连接的数据库是不是一致。