SDK封装规范

一:命名规范

• 接口名称，参数命名清晰规范，参数尽可能少，所有传入参数要做好校验，禁止使用拼音和中文
• 类名前缀和包命名缩写要一致
• 函数命名遵循共性，不要出现歧义或者违背大家的共识
• 所有资源命名前缀 比如 yyy_xx_sdk 其他命名 yyy_xx
• 项目命名：myyXxxSDK，包名：cn.myy.sdk.xxx

二:注释规范

• 代码注释规范清楚
• 接口注释要完善
• 注释形式统一
• 注释内容准确简洁

三:日志设计

• 可控制打印log级别
• 核心处理log日志可以配置
• 主流程，异常日志存储方便定位问题

四:第三方库依赖处理原则

• 优先使用系统Api,减少三方库依赖
• 如果确实因为项目需要，要引入一些开源库，可以通过源码集成的形式引入，再更改一下包名（类名），避免集成冲突。

五:版本管理规范

• 使用三位版本号，每位版本号最高三位数字如1.0.121
• 第三位：bug修复，极小的变更
• 第二位：一般的功能迭代
• 第一位：项目重构，功能变更较大，需团队共同确定

六:开放规范

• API功能单一，减少类似enum的入参设计,最好单一性原则
• 线程处理， 如非必要不要使用应用主线程，不能长时间占用，SDK内应有一个专门线程处理SDK 相关操作
• 尽量减少全局回调
• 提供异常情况回调和输出方便接入放定位，错误回调采用code+msg组合
• 能不用单例的就尽量少的使用
• 对iOS 来说能不用xib 就不用，能不用通知就不用通知
• 多考虑第三方带来的影响，比如键盘处理

七:通用规范 （注意事项）

• 接口隔离 （小而 精简）
• 接口易用性 （对外接口易用，易懂）
• 向后兼容 （升级SDK兼容）接口废弃@deprecated
• 配套有完整且详细的使用说明文档和版本更新说明
• AppId 和 AppKey的分配，用于区分集成sdk的是哪一个公司，做好权限控制
• SDK的 sdkVersion要尽量小，最好不要超过使用SDK的项目的Version（支持的系统）
• 尽量不要引用第三方库，要尽量使用系统自带的功能，然后在其基础上进行封装。
• SDK需要有较强的容错性，增减稳定，增大力度对于SDK内部异常进行捕获。
• SDK内部对于关键路径要有详细的Log记录，便于后期排查问题。
• 各个库之间要做到高内聚，低耦合
• 核心代码的安全性