Skip to content

项目维护

项目是代码生成的核心组织单元,它将数据源、模板和生成配置组织在一起,形成一个完整的代码生成方案。

什么是项目?

项目就像是一个"代码生成配方",它包含了:

  • 使用哪个数据源:连接哪个数据库
  • 使用哪些模板:生成什么类型的代码
  • 生成到哪里:生成的代码放在什么位置
  • 生成哪些表:生成哪些表的代码

为什么需要项目?

通过项目,您可以:

  1. 组织管理:将相关的生成配置组织在一起
  2. 复用配置:相同的配置可以用于多个表
  3. 批量生成:一次生成多个表的代码
  4. 版本管理:保存不同的生成方案

如何创建项目?

1. 进入项目管理页面

登录系统后,在左侧菜单找到【项目管理】点击进入。

2. 添加新项目

点击【新增项目】按钮,填写以下信息:

基础配置

  • 项目名称:项目的显示名称,如 用户管理模块
  • 数据源:选择要使用的数据源
  • 表前缀(可选):如果只生成特定前缀的表,可以填写表前缀
  • 模块名:生成代码的模块名,如 systemuser

项目说明

  • 项目描述:项目的详细说明,便于后续维护

3. 保存项目

填写完成后,点击【保存】按钮,项目就创建完成了。系统会自动生成一个唯一的项目编码。

项目配置

创建项目后,需要进行详细的配置。

1. 任务配置

点击项目列表中的【任务配置】按钮,进入任务配置页面。

添加任务

点击【添加任务】按钮,为项目添加生成任务:

  • 选择模板:选择要使用的模板
  • 任务名称:给任务起一个名称,如 生成实体类
  • 是否生成:是否启用这个生成任务
  • 生成路径:生成的代码放在什么位置
  • 包路径:Java包路径或文件目录

任务示例

模板类型任务名称生成路径包路径
实体类模板生成实体类src/main/javacom.example.system.domain
Mapper模板生成Mapper接口src/main/javacom.example.system.mapper
Controller模板生成Controllersrc/main/javacom.example.system.rest
Vue页面模板生成Vue页面src/viewssystem

2. 表选择

在任务配置页面,可以选择要生成哪些表的代码:

  • 全选:生成所有表的代码
  • 单选:选择特定的表
  • 按前缀筛选:如果配置了表前缀,会自动筛选

3. 保存配置

配置完成后,点击【保存配置】按钮,所有配置就保存完成了。

项目管理

查看项目列表

在项目管理页面,可以看到所有已创建的项目列表,显示项目名称、数据源、创建时间等信息。

编辑项目

点击项目列表中的【编辑】按钮,可以修改项目基本信息。

删除项目

点击【删除】按钮可以删除不再需要的项目。删除前请确认:

  1. 该项目没有重要的配置
  2. 删除后无法恢复

复制项目

如果需要创建相似的项目,可以使用【复制】功能,复制现有项目的配置,然后修改差异部分。

导出/导入项目

  • 导出项目:可以将项目配置导出为文件,用于备份或分享
  • 导入项目:可以从文件导入项目配置,快速创建新项目

项目使用

1. 生成代码

配置好项目后,就可以生成代码了:

方式一:在页面生成

  1. 在项目列表中找到要生成的项目
  2. 点击【生成代码】按钮
  3. 系统会连接数据库,读取表结构
  4. 根据模板生成代码
  5. 生成完成后,可以下载ZIP包

方式二:使用客户端生成

如果集成了generator-client,可以在代码中调用生成接口。

2. 预览代码

在生成代码前,可以使用【预览】功能查看生成的代码效果,确认无误后再生成。

3. 批量生成

如果一个项目配置了多个表,可以一次性生成所有表的代码。

项目示例

示例1:用户管理模块

项目名称:用户管理模块
数据源:dev_mysql
表前缀:user_
模块名:user

任务配置:
1. 实体类模板 -> src/main/java -> com.example.user.domain
2. Mapper模板 -> src/main/java -> com.example.user.mapper
3. Service模板 -> src/main/java -> com.example.user.service
4. Controller模板 -> src/main/java -> com.example.user.rest
5. Vue页面模板 -> src/views -> user

示例2:订单管理模块

项目名称:订单管理模块
数据源:prod_mysql
表前缀:order_
模块名:order

任务配置:
1. 实体类模板 -> src/main/java -> com.example.order.domain
2. Mapper模板 -> src/main/java -> com.example.order.mapper
3. Controller模板 -> src/main/java -> com.example.order.rest

常见问题

Q: 项目配置可以修改吗?

可以,随时可以编辑项目配置,修改后需要重新生成代码。

Q: 一个项目可以生成多个模块的代码吗?

建议一个项目对应一个模块,如果需要生成多个模块的代码,可以创建多个项目。

Q: 项目配置可以共享吗?

可以通过导出/导入功能共享项目配置。

Q: 生成代码时出错怎么办?

可能原因:

  1. 数据库连接失败
  2. 表结构发生变化
  3. 模板语法错误
  4. 生成路径没有权限

解决方法:

  1. 检查数据源连接
  2. 重新选择表
  3. 检查模板语法
  4. 检查文件权限

Q: 生成的代码需要手动修改吗?

生成的代码是基础代码,通常需要根据业务需求进行适当修改。

最佳实践

1. 项目规划

  • 按模块划分:每个功能模块创建一个项目
  • 按环境区分:开发、测试、生产环境使用不同的项目
  • 明确范围:明确项目要生成哪些表的代码

2. 配置管理

  • 统一规范:团队使用统一的生成规范
  • 版本控制:重要的项目配置进行版本管理
  • 定期备份:定期导出项目配置进行备份

3. 生成策略

  • 增量生成:只生成有变化的代码
  • 分批生成:大项目分批生成
  • 预览确认:生成前先预览确认

4. 代码集成

  • 代码审查:生成的代码需要进行代码审查
  • 逐步集成:先集成小模块,再逐步扩大
  • 持续优化:根据使用反馈优化配置

下一步

创建好项目后,您可以:

  1. 生成代码 - 开始生成代码
  2. 集成到项目 - 将生成的代码集成到您的项目
  3. 调整优化 - 根据需求调整模板和配置

提示:如果您是第一次创建项目,建议先从简单的项目开始,参考项目示例进行配置。

Released under the MIT License.