Proj Gen

代码生成

统一入口，根据参数生成不同类型的代码。

使用方式

Copy code
/proj-gen sql      - 生成建表 SQL
/proj-gen crud     - 生成完整 CRUD 代码
/proj-gen api      - 生成单个接口
/proj-gen enum     - 生成枚举类
/proj-gen          - 自动模式（读取技术方案文档）

前置检查

• 全流程任务文档已创建并可追溯
• 技术方案已确认且路径已记录在产物清单
• 任务清单已拆分并确认
• 涉及新增或重命名的数据库表、字段时，按 SQL 命名规范 校验目标 MySQL 精确版本的全部关键字（含非保留关键字）；范围包括 Entity 最终映射的列名，适用于 SQL、CRUD 和自动模式。新名称冲突修正后再生成，未核实版本或关键字清单时标记待核验，不得声称检查通过。已有冲突名称先记录影响并提出迁移方案，未经确认不得自动改名或改变映射。

未满足前置条件时：先补文档/确认流程，禁止生成代码。

自动模式

当存在技术方案文档时，直接执行 /proj-gen，自动：

1. 从任务文档的产物清单读取技术方案路径
2. 提取表结构、实体、接口等信息
3. 按顺序生成：SQL → Entity → Mapper → DTO → Service → Controller

同步更新任务文档：

• 流程状态总览标记“代码生成”为进行中/已完成
• 产物清单记录生成代码清单或路径
• 更新下一步指令为“业务开发”

触发时机：任务拆分完成后，开始编码前。

注意：自动模式生成的是代码骨架，业务逻辑仍需手动实现。

1. 生成 SQL (/proj-gen sql)

输入参数

字段类型、通用字段与建表模板

• 命名校验、字段类型与索引规则：SQL 参考文档
• 通用字段与完整 CREATE TABLE 模板：技术方案模板中的表结构设计。替换占位名称并完成关键字检查后再生成 DDL，业务列名与 Entity、Mapper 保持一致。

2. 生成 CRUD (/proj-gen crud)

输入参数

生成文件清单

Copy code
core/{module}/
├── entity/{Entity}.java
├── mapper/{Entity}Mapper.java
├── service/{Entity}Service.java
└── service/impl/{Entity}ServiceImpl.java

admin/  (Web端)
├── controller/{Entity}Controller.java
├── service/{Entity}ManageService.java
├── service/impl/{Entity}ManageServiceImpl.java
└── model/
    ├── request/{Entity}CreateRequest.java
    ├── request/{Entity}UpdateRequest.java
    ├── request/{Entity}QueryRequest.java
    └── response/{Entity}Response.java

api/  (App端)
├── controller/{Entity}Controller.java
├── service/{Entity}AppService.java
└── model/...

代码模板

• Entity 模板
• Mapper 模板
• Service 模板
• Controller 模板
• DTO 模板

3. 生成 API (/proj-gen api)

输入参数

常用接口模板

参考 API 接口示例

4. 生成枚举 (/proj-gen enum)

输入参数

枚举模板

参考 枚举模板

自检清单

• 命名符合规范（参考 CLAUDE.md）
• 新增或重命名的表、字段已通过目标 MySQL 版本关键字检查（大小写不敏感、完整名称匹配），并记录来源和结果；没有使用反引号绕过命名规则
• 已有冲突名称的迁移已确认，DDL、Entity 映射、Mapper SQL、索引引用、测试和文档保持一致
• 通用字段完整
• 必填字段有校验注解
• 写操作有 @ApiLog
• 接口路径符合 RESTful
• 每个字段有注释/Schema
• 类属性赋值优先使用 BeanUtil.copyProperties
• 返回日期字段必须添加 @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")

详细模板文件

以下模板包含完整代码示例和注意事项：

命名规范详细说明

基础命名规则

类命名约定

接口规范详细说明

URL 格式规范

标准格式：/{项目}/{端类型}/v{版本}/{模块}/{资源}

端类型说明：

• web - 管理后台
• api - App端/小程序
• open - 开放接口

示例：

• /toy/api/v1/feedback - 小程序反馈接口
• /toy/web/v1/user - 管理后台用户接口

RESTful 路径规范

响应格式规范

统一响应格式：

jsonCopy code
{
  "code": 0,
  "message": "成功",
  "data": {}
}

分页响应格式：

jsonCopy code
{
  "code": 0,
  "message": "成功",
  "data": {
    "records": [],
    "total": 100,
    "current": 1,
    "size": 20
  }
}