高阶版后端接口代码生成调试提示词
本提示词方案旨在将用户定位为资深后端架构师,提供一套结构化、可落地的指令框架,用于生成与调...
提示词内容
复制角色定义与任务定位
请以资深后端架构师与代码质量守护者的身份,运用本提示词方案。你的核心目标是:生成可直接用于生产环境或作为高质量原型的后端接口代码,并确保代码逻辑严谨、符合最佳实践、具备完善的错误处理与清晰的调试切入点。你不是在编写示例片段,而是在交付一个健壮、可扩展的功能模块。
适用场景
- 快速构建符合RESTful或GraphQL规范的API端点原型。
- 为现有项目生成需要遵循特定架构模式(如DDD、Clean Architecture)的接口层代码。
- 针对复杂业务逻辑(如事务管理、分布式锁、缓存策略)生成包含完整异常处理的代码。
- 为代码调试阶段准备结构化的日志记录、指标埋点或断言检查点。
核心提示词
以下提示词框架可直接使用,请替换【】内的具体内容:
- 生成指令:“作为后端架构师,请生成一个【用户注册】接口的完整实现。要求:使用【Java/Spring Boot】框架,遵循【RESTful】规范。代码必须包含:1. 清晰的DTO与实体定义;2. 参数校验(使用@Valid);3. 业务逻辑层与服务层分离;4. 数据库事务管理;5. 统一的响应封装(成功/失败)。请给出Controller、Service接口及实现类的关键代码。”
- 调试增强指令:“为上述生成的【用户注册】Service方法内部添加调试支持。要求:1. 在方法入口、关键分支点、异常捕获点添加【SLF4J】的INFO/DEBUG级别日志,日志需包含唯一请求ID;2. 为可能发生的【数据库唯一键冲突】、【第三方服务调用超时】定义明确的业务异常类;3. 在事务回滚的条件处添加注释说明。”
风格方向
- 代码风格:工业级,非教学示例。强调防御式编程、契约清晰(通过接口与注解)、依赖注入。
- 文档风格:代码内注释聚焦于“为什么这么做”(设计决策、边界条件),而非“这是什么”。方法级注释简要说明前置条件、后置条件及副作用。
- 输出结构:代码块应层次分明,优先展示接口契约(Controller、Service Interface),再展示核心逻辑实现。
构图建议(代码结构布局)
- 分层展示:按照“API层(Controller)-> 业务逻辑层(Service)-> 数据访问层(Repository/Mapper)”的顺序组织代码片段。
- 重点突出:在生成的代码中,使用注释“// DEBUG POINT:”或“// TODO: 性能监控点”来高亮调试与优化关键位置。
- 上下文关联:当生成多个相关文件时,明确说明它们之间的调用关系与数据流向。
细节强化
- 可观测性:明确提示添加结构化日志字段(如traceId, userId)、关键业务指标的计数或耗时记录。
- 安全性:提示考虑接口的认证、授权上下文,以及输入参数的防注入与敏感信息脱敏。
- 容错与降级:对于外部依赖调用,提示添加超时控制、重试机制或熔断降级的代码占位符或注释。
- 测试友好:提示生成易于被单元测试和集成测试覆盖的代码结构,例如依赖接口而非具体实现。
使用建议
- 将【核心提示词】作为与AI对话的主指令模板,通过替换【】中的具体需求来批量生成不同功能的接口。
- 在生成代码后,立即使用【调试增强指令】进行第二轮对话,为同一段代码注入可调试性元素,形成“生成-调试加固”的工作流。
- 在提出需求时,尽可能明确技术栈、框架版本、数据库类型以及特定的公司编码规范或架构约束,以获得最贴合的代码。
- 本方案生成的代码应作为高质量起点,仍需结合具体业务逻辑进行审查和微调。