Java API 设计准则
程序员文章站
2022-04-13 14:24:27
...
在Java API设计中有着许多的各种规则与折衷考量,和其他所有复杂任务一样,它考验着我们的记忆力及脑力。这里我找到了一个对正在设计Java API的软件开发人员而言非常不错的准则列表
,其中介绍的一些准则可能是很明显的,又或者不那么显眼,但确实非常不错,希望你会喜欢。
这里摘录了一些:
- 优先 将API与其实现置于不同的包中。
- 优先 将API放入高层包中,实现则可放在低层包。
- 考虑 将大型API拆分成若干包。
- 考虑 将API与其实现包归置到不同的Java文档中。
- 避免 对API中实现类的内部依赖。
- 避免 出现不必要的API碎裂(fragmentation)情况。
- 不要 将公共实现类放在API包中。
- 不要 在调用及实现类间创建依赖。
- 不要 将不相关的API放在同一个包中。
- 不要 将API与SPI(Service Provider Interface,服务提供者接口)放在同一个包中。
- 不要 移动及重命名已发布的公共API包。
完整的准则列表点击这里 查看。