模板与提示词.md 4.6 KB

表结构模板 · 编码提示词 · Review 提示词

一、表结构设计输出格式

## 表结构设计:{模块名}

### ER 图
```mermaid
erDiagram
  leave_apply ||--o{ leave_apply_flow : "1:N"
  leave_apply {
    bigint id PK "主键"
    varchar apply_no UK "单号"
    tinyint leave_type "1年假 2事假 3病假 4调休"
    datetime start_time "开始时间"
    datetime end_time "结束时间"
    decimal(5,1) days "天数"
    tinyint approve_status "0草稿 1审批中 2通过 3驳回"
    datetime create_time "创建时间"
  }

建表 SQL

CREATE TABLE `leave_apply` (
  `id` BIGINT NOT NULL AUTO_INCREMENT COMMENT '主键',
  `apply_no` VARCHAR(32) NOT NULL COMMENT '单号',
  `leave_type` TINYINT NOT NULL COMMENT '1年假 2事假 3病假 4调休',
  `start_time` DATETIME NOT NULL COMMENT '开始时间',
  `end_time` DATETIME NOT NULL COMMENT '结束时间',
  `days` DECIMAL(5,1) NOT NULL COMMENT '请假天数',
  `approve_status` TINYINT NOT NULL DEFAULT 0 COMMENT '0草稿 1审批中 2通过 3驳回',
  `create_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `update_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
  `deleted` TINYINT NOT NULL DEFAULT 0 COMMENT '逻辑删除',
  PRIMARY KEY (`id`),
  UNIQUE KEY `uk_apply_no` (`apply_no`),
  KEY `idx_emp_time` (`emp_id`, `start_time`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='请假申请';

设计说明

  • 索引依据:列表页按「员工+时间区间」查询,建 idx_emp_time
  • 与现有表冲突:无
  • 存疑项:days 是否需要冗余存储(可由起止时间算出),倾向保留以便统计

    
    **必须说明索引依据**,AI 常见的错误是给每个字段都建索引,或者说不出为什么建。
    
    ## 二、编码提示词
    
    

技术栈:Spring Boot 3.2 / JDK 17 / MyBatis-Plus 3.5 / MySQL 8.0 现有代码风格:Controller 只做参数校验与转换,业务在 Service,禁止 Service 调 Service 以外的东西

任务:实现 LeaveApplyService.submit(LeaveApplyDTO dto) 已有:LeaveApplyMapper、HrClient(查询年假余额)、FlowService(启动审批流) 约束:

  1. 不引入新依赖
  2. 只用 Spring Boot 3.2 支持的 API,不确定的标注出来
  3. 事务边界覆盖「落库 + 启动流程」,外部 HR 调用放在事务外
  4. 金额/权限/状态机/对账四类逻辑不要实现,写方法签名 + TODO
  5. 空值和边界要处理:余额为空、并发重复提交、起止时间倒挂

    
    ## 三、Review 提示词
    
    

请按以下顺序检查这段代码,逐条给结论(有问题 / 无问题 / 需确认):

  1. 是否有不存在的 API 或与所用版本不符的写法
  2. 空值、空集合、0、负数、超长字符串是否处理
  3. 事务边界是否正确(外部调用是否在事务内)
  4. SQL 是否有全表扫描风险(where/join 字段是否走索引)
  5. 是否有 N+1 查询
  6. 日志是否打印了敏感信息
  7. 异常是否被吞掉(catch 后不处理也不抛)
  8. 是否存在并发问题(先查后改、库存扣减类逻辑)
  9. 是否有硬编码(连接串、密钥、路径、魔法值)
  10. 命名与现有代码风格是否一致

只报告问题,不要重写代码,除非我要求。


## 四、AI 代码的典型缺陷对照

| 缺陷 | 表现 | 怎么发现 |
|---|---|---|
| 幻觉 API | 调用了框架里不存在的方法 | 编译报错;不确定时查官方文档 |
| 版本错配 | 用了新版本才有的写法 | 编译或运行时报 NoSuchMethod |
| 空指针 | 不判空直接取属性 | Code Review 逐字段看 |
| 事务失效 | 外部 HTTP 调用放在事务内 | 看方法上的 @Transactional 范围 |
| N+1 查询 | 循环里查数据库 | 看 for 循环内是否有 mapper 调用 |
| 全表扫描 | where 用函数包裹字段、缺索引 | EXPLAIN |
| 并发覆盖 | 先 select 再 update | 看是否有乐观锁或悲观锁 |
| 异常吞掉 | catch 里只有 log | 搜 catch 块 |
| 过度防御 | 三层 try-catch 套一起 | 看嵌套深度 |
| 硬编码 | 路径、密钥、魔法值写死 | 搜字符串常量 |

## 五、修 bug 时的规矩

不要直接让 AI "把这个问题修一下"。先要它给**根因判断**,人确认后再动手。

这段报 NullPointerException,堆栈如下:<粘贴> 请先判断根因(不要给修复代码),列出:

  1. 哪个对象为 null
  2. 它为什么是 null(从调用链推断)
  3. 需要补充哪些信息才能确认 ``` 确认根因后再让它改,避免"加个判空绕过去",把真正的问题埋得更深。