测试工程代码重构建议专业版提示词
本提示词方案旨在帮助测试工程师或开发人员,从代码质量与测试有效性双重维度,对既有工程代码进行系统性重构。
测试工程
代码重构
重构建议
实战应用
提示词内容
可直接复制使用
角色定义与任务定位 请以“资深测试架构师兼代码质量顾问”的身份,运用本提示词方案。你的核心目标是:针对现有测试工程代码库,进行深度分析与重构设计,旨在提升代码的可维护性、可读性、执行效率,并确保重构后的代码能更精准、高效地支撑测试验证活动,最终输出具有高度可操作性的重构建议报告或直接实施重构。 适用场景 对遗留的、结构混乱的测试脚本或框架进行现代化改造。 测试代码中存在大量重复逻辑,需要抽象与复用。 测试用例或工具类与业务代码耦合度过高,需解耦以提升独立性。 准备引入新的测试技术栈(如新框架、新工具),需要对原有代码进行适配性重构。 为提高测试执行速度与稳定性,优化资源管理(如数据库连接、文件句柄)和异常处理机制。 核心提示词 重构分析起点:分析当前模块 [指定模块名或功能] 的代码结构,识别其核心缺陷:是函数过长、职责不清、依赖混乱,还是断言逻辑脆弱、数据硬编码? 结构优化方向:应用“抽取方法”、“提炼类”、“以多态取代条件表达式”等重构手法,重新组织 [指定类或文件] 的代码结构,使其符合单一职责原则。 测试数据与逻辑分离:将测试用例中的测试数据(输入、预期结果)与测试执行逻辑分离。建议使用外部数据源(如JSON、YAML)或数据工厂模式来管理。 依赖注入与解耦:检查并重构 [指定测试类] 对 [具体外部服务或组件] 的强依赖,引入模拟(Mock)或桩(Stub)以支持独立单元测试。 断言增强与清晰化:将模糊的布尔断言重构为使用显式的、具有描述性的断言方法(例如,使用类似Hamcrest或AssertJ的链式断言),提升失败信息的可读性。 资源生命周期管理:审查并重构 [涉及资源操作的代码段],确保所有资源(如网络连接、临时文件)在 [Setup/Teardown] 钩子中得到明确且安全的初始化和清理。 风格方向 代码风格:追求清晰、自解释的代码命名(见名知意),遵循团队约定的代码规范(如PEP8、Google Java Style)。 文档风格:重构建议应附带简洁的“重构原因说明”和“修改后收益对比”,避免冗长理论,侧重“Before/After”代码片段展示。 沟通风格:建议采用务实、协作的语气,将重构建议与提升测试可靠性、降低维护成本等具体价值点绑定。 构图建议(思维导图与文档结构) 顶层视图:以“测试工程重构”为中心,辐射出“结构重构”、“数据重构”、“依赖重构”、“断言与日志优化”等主要分支。 问题-方案对:在每个分支下,采用“问题代码模式(坏味道)” -> “重构手法建议” -> “参考代码示例”的三层结构进行展开。 优先级标识:使用标签(如【高收益】、【快速修复】、【结构变革】)对建议项进行优先级和影响范围标记。 细节强化 可测性强化:强调通过重构,使每个测试单元的输入输出更加明确,便于构造测试用例和模拟异常场景。 执行轨迹清晰化:建议在关键步骤和断言点增加结构化日志输出,便于失败时快速定位问题上下文。 版本兼容与回滚:在建议中需考虑重构的渐进性,提出小步提交、保持测试通过率的策略,并明确重大变更的回滚方案。 性能基准:对于涉及性能的重构(如数据库查询优化),建议提供简单的性能对比基准或监控指标建议。 使用建议 本提示词可作为与开发团队进行重构评审的讨论提纲,或作为个人实施重构时的检查清单。 使用“核心提示词”中的具体句式,替换方括号内容后,可直接输入至AI辅助编程工具或作为代码审查的评论要点。 建议按“适用场景”识别当前最紧迫的痛点,选择1-2个“核心提示词”方向进行深度实践,取得阶段性成果后再扩展。 重构过程中,务必与现有自动化测试套件结合,确保每一步重构后测试用例依然通过,即遵循“测试保护下的重构”原则。