2021-02-18 SDK设计原则

SDK 设计遵循的原则

• 接口隔离：设计的接口应该小而精简，即接口功能单一，高内聚低耦合；
• 开闭原则：对于扩展功能开放，对与内部修改封闭，对外交互部分尽量面向接口编程，实现抽象；
• 易用性：接口简单易懂，命名合理，提供接口朴实实用，不同通过文档能给明白其实现的功能；
• 向后兼容：用户升级后原功能不变，不可影响用户原使用功能；
• 文档指南：完善的SDK接入指南，一份好的接入文档让用户事半功倍，不仅可以用户快速接入，而且可以减少后续的bug；

接口设计原则

• 接口名称及参数名称要足够清晰
• 接口功能单一
• 接口参数尽可能少
• 名词命名要统一
• 同步异步处理
• 多线程处理
• 三方接口使用