API 设计原则

　　每个 API 接口应该只专注一件事，并做好：如果它很难命名，那么这或许是个不好的征兆，好的名称可以驱动开发、并且只需拆分与合并模块即可

　　API 应尽可能地轻小：满足需求、对有疑问的地方可以暂时不使用(函数、类、方法、参数等，你可以不添加，但千万不要删除)、概念性的东西比体积重要、寻找一个良好的动力体积比;

　　实现不要影响 API：关注实现细节(不要迷惑用户、不要随便改变实现方式)、意识到具体的实现细节(不要有越权的方法行为，例如不要制订哈希函数、所有的调优参数都是可疑的);

　　不要让实现细节“泄露”到 API(例如 on-disk 和 on-the-wire 格式等异常情况);

　　最小化可访问：设计人员应尽量把类及成员设为私有，公共类不应该有公共字段(包括异常实例)，最大限度地提高信息隐藏，允许模块可以被使用、理解、构建、测试和独立调试;

　　命名问题：应该见名知意，避免含糊的缩写、对同一样东西的命名应该有个一致性的前缀(遍及整个平台 API)、讲究对称、代码应该易读。如下所示：

　　if (car.speed () > 2 * SPEED_LIMIT)

　　generateAlert ("Watch out for cops!");

　　更多资讯：武汉软件工程师培训学校