7、嵌入式系统开发：重构、API 设计与启动流程

嵌入式系统开发：重构、API 设计与启动流程

1. 重构的重要性与实践

重构常被视为应对失败的激烈手段，但实际上它是一种有益的实践。在系统成型过程中，重构能改进软件，同时随着时间推移，软件组件和外设的支持也会不断发展。

1.1 重构的条件与测试

重构在旧代码的所有测试都正常运行时效果更佳。在重新设计模块内部结构时，单元测试应适应新的函数签名。而如果模块的 API 保持不变，那么该模块现有的功能测试不应改变，只要与其他模块的接口保持一致，这些测试就能持续反馈重构过程的状态和准确性。

1.2 代码规模与重构难度

较小的代码部分比大型代码更容易进行重构，这也是我们应保持每个模块小巧且专注于系统特定功能的另一个原因。通过中间可交付原型推进开发意味着应用代码会不断变化，当子系统设计为相互独立且与应用代码本身独立时，这种变化所需的工作量会更少。

2. API 与文档设计

API 往往能揭示系统内部实现和架构师的设计选择，一个清晰、易读且易懂的 API 是嵌入式系统最重要的特性之一。应用开发者期望能快速理解如何访问功能，并以最有效的方式使用系统。

2.1 API 的设计原则

API 代表了系统与应用之间的契约，因此必须提前设计，并且在开发接近最终交付时应尽量少修改。

2.2 文档的提供方式

API 中的一些接口可能描述复杂的子系统并抽象出更复杂的特性，因此提供足够的文档来帮助应用开发者了解和利用系统的所有功能是很有必要的。可以通过以下方式提供文档：
- 在代码仓库中以单独文件的形式分发用户手册。