godot-design

Godot GDScript 接口设计规范与指导，强调 TDD 友好、可测试、可维护的设计原则： 1. **单一职责原则（SRP）** 每个类或接口应仅负责一项功能。避免将多个不相关的逻辑耦合在同一个脚本中，以提升可测试性和可维护性。 2. **依赖注入（DI）** 优先通过构造函数或方法参数注入依赖，而非在内部直接实例化。这使得在单元测试中可轻松替换为模拟对象（Mock）或桩对象（Stub）。 3. **接口抽象与信号解耦** 使用抽象类或接口定义行为契约，避免直接依赖具体实现。利用 Godot 的信号机制实现松耦合通信，便于模拟和测试交互逻辑。 4. **纯函数与无副作用方法** 尽可能编写纯函数（输入确定则输出确定，无副作用），便于单元测试验证逻辑正确性。避免在方法中直接修改全局状态或场景树结构。 5. **可测试的节点结构** 将核心逻辑封装在独立的脚本中，而非过度依赖场景节点层级。可通过 `add_child()` 动态加载节点进行测试，避免依赖编辑器场景。 6. **TDD 友好的开发流程** 采用“红-绿-重构”循环：先编写失败的测试，再实现最小功能使其通过，最后优化代码结构。确保每个功能都有对应的测试覆盖。 7. **使用 Mock 与 Test Doubles** 利用 GDScript 的动态特性或第三方测试框架（如 Gut）创建 Mock 对象，模拟节点、信号或外部服务行为，隔离被测单元。 8. **清晰的命名与文档注释** 方法、变量和信号命名应自解释。为公共接口添加 `##` 注释，说明用途、参数和返回值，提升代码可读性和维护性。 9. **避免 Godot 引擎特性污染业务逻辑** 将 `_process`、`_physics_process` 等引擎回调仅用于调度，核心逻辑应封装在独立方法中，便于脱离引擎环境测试。 10. **模块化与可复用设计** 将通用功能封装为独立模块或工具类，通过组合而非继承构建复杂行为，提高代码复用率和测试便利性。 遵循以上原则，可构建出结构清晰、易于测试、长期可维护的 Godot GDScript 项目。

存档时间线

版本索引永久保留；内容副本只保留最新 1 份，更早版本仅留索引与哈希（存档时间线的证据链不会因此断裂）。

下载存档内容副本