设计原则与实践指南.pdfVIP

n给API取个好的名字，包括包结构

包结构：划分清楚、职责分明，职责单一

API的接口名、类名等，比如：IUser、UserApi、UserService

API里面的方法、参数列表：尽量望文知义，尽量不要使用缩写

n团队设计应该要保持一致性，比如命名、参数风格等

同样或类似功能，命名风格应该一致，比如：getById（Stringid），

findById、getUserById

n牢记少即是多，尤其是对外的接口

尽量少向外去公布内容，比如：少对外公布方法，少对外公布数据等

n尽量隐藏的细节

比如：的实现方式，不用外部知道

nAPI公开的内容越少越好

比如：类型、状态等枚举值，这些也尽量不要公开

n方法优于字段

n要合理规划API的粒度

对外的接口尽量采用粗粒度接口，对内的接口到底使用粗粒度还是细粒度，

要根据具体情况来分析，如果是分布式调用的话，也应该使用粗粒度接

口。

另外，尽量不要所谓的通用接口。

n要为增加参数做好准备

尽量使用对象来进行输入输出

n设计API时要区