Skip to content

代码生成

代码生成模块基于数据库表结构自动生成前后端代码,大幅提升 CRUD 功能的开发效率,减少重复性编码工作。

功能总览

功能点说明
表结构导入从数据库导入表结构信息
生成配置代码生成的参数和模板配置
代码预览生成代码的在线预览
代码下载生成代码的打包下载
代码同步增量更新已生成的代码

使用流程

代码生成器的标准使用流程如下:

数据库建表 → 导入表结构 → 配置生成规则

预览生成代码 → 调整配置 → 下载代码

复制到项目 → 配置路由 → 完成功能

详细步骤

  1. 数据库建表:在数据库中创建业务表,设置字段类型、注释、主键等
  2. 导入表结构:从数据库导入表结构,系统自动解析字段信息
  3. 生成配置:配置代码生成选项(模块名、包路径、模板等)
  4. 代码预览:预览生成的各层代码文件
  5. 代码下载:一键下载所有生成的文件

生成配置

基本配置

配置项说明
模块名称生成代码所属的功能模块
包路径Java 包路径
作者代码作者信息
表前缀需要去除的表前缀(如表名 sys_user,前缀 sys_
功能名称功能的中文名称

模板选择

代码生成器支持多种代码模板:

  • 单表模板:标准 CRUD 代码生成
  • 树表模板:树形结构数据的代码生成(如部门、菜单)
  • 主子表模板:主表 + 子表的关联数据代码生成

生成内容

代码生成器覆盖完整的代码层次:

后端代码

文件说明
ControllerRESTful API 接口层
Service业务逻辑层接口和实现
Mapper数据访问层接口
XMLMyBatis 映射文件
VO视图对象(列表、详情、新增、编辑)
DTO数据传输对象(查询条件)
Converter对象转换器

前端代码

文件说明
index.vue列表页面
Form.vue新增/编辑表单组件
api.tsAPI 接口定义
types.ts类型定义
locale国际化语言包

自定义模板

系统支持自定义代码模板,满足个性化需求:

  • 模板引擎:基于 FreeMarker 模板引擎
  • 变量体系:可通过模板变量引用表信息、字段信息等
  • 自定义模板:开发团队可维护自己的模板库
  • 模板共享:团队内的模板复用和共享

最佳实践

  • 表设计规范:规范的数据库表设计(完整注释、合理字段类型)能生成更准确的代码
  • 表前缀处理:合理配置表前缀,避免生成冗余前缀
  • 增量生成:表结构调整后使用增量生成更新代码,避免手动修改覆盖
  • 二次开发:生成代码后根据业务需求进行定制化开发

OA 办公系统文档中心