Android SDK 开发经验浅谈

2.2 SDK 设计原则

首先需要明确，一方面，SDK 的价值是给调用者带来价值。所以要努力降低用户的上手难度，易于理解。另一方面要时 SDK 代码易于维护。

1. 接口易用性

做 App 开发时，我也抱怨过XX 的 SDK 真难用。一个 SDK 好不好用，关键就看接口的设计是否简单易用，对于接入方来说他不会关注你的实现细节，能用一个 API 接口搞定的业务，坚决不用两个。注意控制接口的数量。

另一方面，注意接口的命名。一个好的 API 接口的命名能够让调用者见名思意，做到不需要借助帮助文档就能使用的程度就说明这个接口命名是成功的。比如对于 Android 中设置点击事件的接口 setOnClickListener。

2. 命名规范要统一

对于 SDK 开发来说，统一命名规范很重要，最好的状态是接入方看到接口命名就能知道是哪家厂商的 SDK。换句话说就是 SDK 的命名规范统一，形成自己公司的品牌效应。同时也方便接入方使用。

对于编码规范，网上都有各个大厂的规范模板，可以选择其中一个或自定义自己团队的规范，尽早统一代码风格。

3. 跨端接口尽量保持一致

对于同一套 SDK，尽量保持各端接口命名、实现逻辑要一致。在我们的开发过程中，也出现由于跨端之间的逻辑有差异导致客户在 Android 和 iOS 上体验不一致的问题，同时也会带来额外的支持工作。所以对于涉及到多个端的需求设计，一定要进行详细的沟通和确认，防止出现接口命名和实现不一致的情况。

4. 尽量不依赖第三方库

随着开源的普及，GitHub 上有很多经典的开源项目供开发者使用。对于 App 开发者，会经常使用到开源项目，比如网络请求 OkHttp、图片加载 Glide 等