如何创建一个一流的SDK?

时间：2023-03-10 02:02:05
如何创建一个一流的SDK?

怎么样的SDK算是一个好的SDK？

在做SDK的过程中我们走过非常多的弯路，是一个难以想象的学习过程，我们总结一个好的SDK应该具备的特质：

易用性，稳定性，轻量，灵活，优秀的支持.

一、易用性

因为工作的关系我接触了很多的开发者，其中有行业知名的公司的开发者，也有极小的个人开发者.有一个现象很有意思，不管是能力较强的开发者还是能力一般的开发者，他们都会不停的对你的SDK吐槽.因为他们对于好用的标准是不一样的，所以你必须要将你的SDK易用性考虑到极致，不然后续的技术支持将是一个十分痛苦的事情.

  • 不要过度设计,过度设计是程序员常常犯的错误,如果只是一个演示demo,应该尽量的简单，简单到最基础的程序员都能够看懂.

  • 接口尽量的见名知义.

  • 要相信绝大多数的开发者都是不看文档的.于是根据开发者的直觉去设计API，这样听起来是不是太靠谱？事实上比如你的SDK的生命周期设计方法跟系统差异性不大，比如你的播放器的接口设计跟系统播放器相差不大，那对开发者来讲就是福音.

  • 接口能够统一的尽量统一，比如iOS和Android的接口，应该尽量的统一.

  • 尽量多的默认参数，这里面有一些小的技巧，以下我提一个小的例子，比如我们的SDK,我们有一个跳转录制的接口，事实上就是将一堆的参数给到下一个SDK页面，让SDK接收参数,我们选择给一个结构体暴露给用户，如下：

    AliyunVideoParam recordParam = new AliyunVideoParam.Builder()
    
                  .setResulutionMode(resolutionMode) //设置录制分辨率，目前支持360p，480p，540p，720p
    
                  .setRatioMode(ratioMode) //设置视频比例，目前支持1:1,3:4,9:16
    
                  .setRecordMode(RecorderDemo.RECORD_MODE_AUTO) //设置录制模式，目前支持按录，点录和混合模式
    
                  .setFilterList(eff_dirs) //设置滤镜地址列表
    
                  .setBeautyLevel(80) //设置美颜度
    
                  .setBeautyStatus(true) //设置美颜开关
    
                  .setCameraType(CameraType.FRONT) //设置前后置摄像头
    
                  .setFlashType(FlashType.ON) // 设置闪光灯模式
    
                  .setNeedClip(true) //设置是否需要支持片段录制
    
                  .setMaxDuration(max) //设置最大录制时长
    
                  .setMinDuration(min) //设置最小录制时长
    
                  .setVideQuality(videoQuality) //设置视频质量
    
                  .setGop(gop) //设置关键帧间隔
    
                  .build();
    
  AliyunVideoRecorder.startRecordForResult(this,REQUEST_RECORD,recordParam);
    这样有什么好处呢，我们事实上可以预制N个参数。这样用户调用一个录制功能只需要做什么呢？,如下：
    AliyunVideoParam recordParam = new AliyunVideoParam.Builder().build();
    
AliyunVideoRecorder.startRecordForResult(this,REQUEST_RECORD,recordParam);
    • 上面还说了开发者对于易用性的标准是不一样的，面向的需求也是不一样的，上面的需求只能满足最基础的简单需求，如果要自定义界面，这个时候就需要暴露更加深

      的接口.于是我们将我们的接口设计分为多层.这样就基本能够满足用户最初级的要求和自定义属性的要求.
    DEMO--->AliyunVideoRecorder(第一层接口)---->AliyunIRecorder(第二层接口)

二 、稳定性

如何保证一个SDK的稳定性？自动化测试、适配测试、API的稳定、代码审查、内存检测、可测试性都缺一不可.

  • 自动化测试:依赖系统的自动化测试工具就可以完成人工绝大多数的自动化UI测试.能够解放黑盒测试的双手，这个时候如果有使用Jenkins之类的持续集成的系统，你还能够让你的开发者及时的能够发现问题、解决问题。
  • 适配测试：一个安卓永远的痛，现在基本没有很多好的方法，只有去找一些规律找机器适配,但是做多了就会发现还是有规律可循的，比如GPU的型号，系统版本，使用的硬件差异，甚至品牌.早期我们也是按CPU,GPU型号去买机器的.
  • API的稳定: 一个好的SDK设计的API应该从一开始就需要考虑扩展性，尽量多的考虑将来可能的需求，尽量将这些需求包进来.我见过很多开发者懊恼如果让我再设计一次一定能够将这个接口设计的更好一些

相关文章