项目规则
也就是在项目根目录写好 AGENTS.md:
markdown
markdown
代码解读
复制代码
Java Project Agent Guide
[Tech Stack]
- Java: 17
- Spring Boot: 3.x
- Build: Maven
- Test: JUnit 5
[Commands]
- Build: `mvn clean package`
- Unit tests: `mvn test`
- Run app: `mvn spring-boot:run`
[Architecture Rules]
- Controller 只处理 HTTP 入参、出参和状态码。
- Service 处理业务流程和事务边界。
- Repository/Mapper 只处理数据访问。
- 不允许 Controller 直接访问 Mapper。
[Testing Rules]
- 改业务逻辑必须补测试。
- 修 bug 必须补回归测试,除非说明原因。
- 优先写小测试,再考虑完整 SpringBootTest。
[Safety Rules]
- 不允许操作生产数据库。
- 不允许执行破坏性命令,除非用户明确确认。
- 不允许输出密码、token、身份证、手机号等敏感信息。
Ai提示词
1. 新需求开发
markdown
markdown
代码解读
复制代码
先别急着写代码。请按以下流程处理这个 Java 后端需求:
1. 阅读相关代码和 AGENTS.md。
2. 澄清需求目标、业务规则和边界。
3. 给出 Controller、Service、Repository 的分层设计。
4. 说明需要新增或修改哪些文件。
5. 小步实现,不做无关重构。
6. 补充或更新测试。
7. 运行最小相关验证,并说明结果。
需求:xxx
业务规则:xxx
验收标准:xxx
适合:新接口、新业务流程、新模块、小型功能改造。
2. Bug 修复
markdown
markdown
代码解读
复制代码
请按系统化 Debug 的方式处理这个问题,不要直接猜测修复。
要求:
1. 先复述你理解的故障现象。
2. 找到相关代码路径和可能影响因素。
3. 给出可验证的根因假设。
4. 尽量用测试、日志或代码证据验证假设。
5. 只做最小修复。
6. 补充回归测试,或说明为什么无法补测试。
7. 运行相关验证。
问题现象:xxx
错误日志:xxx
复现步骤:xxx
适合:线上异常、测试失败、偶现 bug、数据不一致。
3. SQL / 事务 / 持久化修改
markdown
markdown
代码解读
复制代码
请重点从 Java 持久化风险角度检查这个变更。
请关注:
1. SQL 是否可能全表扫描或误更新。
2. WHERE 条件是否可能为空。
3. 分页排序是否稳定。
4. 是否需要索引或执行计划检查。
5. 事务边界、传播行为和回滚规则是否正确。
6. 是否存在锁范围过大、批处理内存过高或 N+1 问题。
7. 是否需要补充数据库相关测试。
需求:xxx
相关表:xxx
相关 Mapper/Repository:xxx
适合:MyBatis、JPA、Repository、SQL、事务、批处理、迁移。
4. 写测试
markdown
markdown
代码解读
复制代码
请先为这个改动选择测试策略,不要默认使用 SpringBootTest。
请判断应该使用:
- unit test
- slice test
- integration test
- Testcontainers
要求:
1. 说明为什么选择该测试层级。
2. 测试应覆盖正常路径和关键异常路径。
3. Mock 只用于稳定边界,不要 mock 被测对象本身。
4. 测试名要描述业务行为。
5. 运行相关测试并说明结果。
目标代码:xxx
需要验证的行为:xxx
适合:补单测、补回归测试、测试重构、老项目加保护网。
5. 代码 Review
markdown
markdown
代码解读
复制代码
请按 Java 后端生产级标准 review 这次改动。
重点检查:
1. 是否满足需求和验收标准。
2. Controller、Service、Repository 分层是否清晰。
3. 事务、SQL、锁、分页、批处理是否安全。
4. 是否存在权限、越权、敏感信息或注入风险。
5. 测试是否覆盖关键行为和回归场景。
6. 日志、traceId、metrics 是否支持线上定位。
7. 是否存在发布、回滚或兼容性风险。
请按严重程度输出:Blocking / Important / Suggestion。
适合:PR Review、AI 生成代码审查、上线前自查。
6. 上线前检查
markdown
markdown
代码解读
复制代码
请做一次 Java 后端上线前检查。
重点检查:
1. 是否有数据库变更,是否兼容,是否可回滚。
2. 是否有配置变更,不同环境是否一致。
3. 是否影响老接口、老客户端、老消息消费者。
4. 是否有 feature flag、灰度或回滚方案。
5. 是否有 smoke test。
6. 是否有日志、metrics、告警和排障路径。
7. 失败后如何止损和恢复。
变更内容:xxx
计划上线范围:xxx
适合:发版前、数据库迁移、配置变更、核心链路改动。
7. 长任务与上下文管理
markdown
markdown
代码解读
复制代码
这是一个长任务,请不要只依赖当前对话上下文。
要求:
1. 先建立任务计划、发现记录和进度记录。
2. 每完成一个阶段,更新当前进展和剩余风险。
3. 重要结论写入文档,不只留在聊天记录里。
4. 如果上下文过长,请先总结当前状态,再继续执行。
5. 每个阶段都要有明确验证方式。
任务目标:xxx
涉及模块:xxx
预期交付:xxx
适合:模块重构、跨服务排查、升级迁移、批量治理、长时间调研。
8. 解释代码 / 帮新人理解模块
markdown
markdown
代码解读
复制代码
请帮助我理解这段 Java/Spring 代码。
要求:
1. 先用一句话说明它解决什么业务问题。
2. 再按调用链解释主要流程。
3. 标出关键类、关键方法和关键数据结构。
4. 说明可能的异常路径、事务边界和外部依赖。
5. 最后给出新手阅读这块代码的建议顺序。
代码/文件:xxx
我当前最困惑的是:xxx
适合:接手老项目、Code Review 前理解上下文、带新人熟悉模块。
9. 生成文档 / 接口说明
markdown
markdown
代码解读
复制代码
请基于现有代码生成面向研发团队的说明文档。
要求:
1. 不要编造代码里不存在的行为。
2. 先说明模块职责和核心流程。
3. 列出主要接口、入参、出参、错误码和边界条件。
4. 标出依赖的数据库表、外部服务、配置项和消息主题。
5. 最后给出测试和排障建议。
目标模块/接口:xxx
文档读者:后端研发 / 测试 / 前端 / 运维
适合:接口文档、模块说明、交接文档、测试说明。
10. 学习新技术 / 做技术调研
markdown
markdown
代码解读
复制代码
请帮我做一次面向 Java 后端研发的技术调研。
要求:
1. 先说明这个技术解决什么问题,不要直接堆概念。
2. 对比它和我当前技术栈的差异。
3. 给出适合使用和不适合使用的场景。
4. 给出一个最小可运行示例或接入步骤。
5. 列出生产落地风险、性能影响、监控和回滚方案。
技术主题:xxx
当前技术栈:xxx
目标场景:xxx
适合:技术选型、学习新框架、引入新组件前调研。
11. 复盘与知识沉淀
markdown
markdown
代码解读
复制代码
请总结这次任务中是否有值得长期沉淀的经验。
请判断:
1. 是否应该写入 AGENTS.md,成为项目硬规则。
2. 是否应该写入 wiki,成为项目知识。
3. 是否应该提炼成 project skill,供以后自动触发。
4. 是否只是一次性上下文,不需要沉淀。
任务背景:xxx
最终修复/实现:xxx
踩坑或关键发现:xxx
适合:复杂 bug 修复后、事故复盘后、架构决策后、重复踩坑后。