在 Zephyr 项目中,API(应用程序接口)被明确划分为三类:public API、private API 和 internal API。开发者需严格区分这三者以确保代码的稳定性与可维护性。
Public API 位于 `include/zephyr` 文件夹内,且未被标记为 private。这类接口专为树内或树外的软件组件设计,遵循严格的生命周期规定,承诺长期稳定,是构建应用程序的首选依赖来源。
Private API 定义在源代码树的任意位置,但仅限于其所属的软件组件内部使用。它们随时可能变更,严禁被外部代码调用,否则将导致不可预知的破坏。
Internal API 同样定义在源码树中,旨在扩展 Zephyr 内核功能,通常用于内核与架构特定代码(如以 `arch_` 前缀开头的函数)之间交互。虽然内部 API 相对稳定,但其稳定性保证远少于公共 API,且应用层不得在其作用范围之外调用。
开发实践中,应优先依赖 public API 构建应用逻辑;若需使用 internal API,必须确保调用上下文严格限定在组件内部或架构扩展场景,避免跨模块滥用;private API 则完全属于实现细节,不应出现在任何对外接口中。