怎么样的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应该从一开始就需要考虑扩展性,尽量多的考虑将来可能的需求,尽量将这些需求包进来.我见过很多开发者懊恼如果让我再设计一次一定能够将这个接口设计的更好一些

    如何创建一个一流的SDK?的更多相关文章

    1. 使用 ADD-ON SDK 开发 基于 Html JQuery 和 CSS 的 firefox 插件入门教程1: 创建一个简单的 Add-on

      [本文转载自http://sixpoint.me/942/implementing-simple-addon/] 实现一个简单的插件 教程的这个部分带你使用 SDK 来实现, 运行并打包一个插件. 这 ...

    2. 用vlc SDK创建一个播放视频文件和RTSP流视频的Demo

      #include <stdio.h> #include <tchar.h> #include <time.h> #include <windows.h> ...

    3. 如何用Unity创建一个的简单的HoloLens 3D程序

      注:本文提到的代码示例下载地址>How to create a Hello World 3D holographic app with Unity 之前我们有讲过一次如何在HoloLens中创建 ...

    4. DirectX游戏编程(一):创建一个Direct3D程序

      一.环境 Visual Studio 2012,DirectX SDK (June 2010) 二.准备 1.环境变量(如没有配置请添加) 变量名:DXSDK_DIR 变量值:D:\Software\ ...

    5. 创建一个Android项目

      当我们的eclipse安装了SDK后,点击Window-->Perference-->DDMS.eclipse界面立即转为DDMS界面. 这时,我们可以打开我们的服务端(安卓模拟器或者是我 ...

    6. 创建一个Portlet工程

      使用Liferay的SDK创建一个简单的Portlet,此Portlet不包括业务逻辑.不包括数据库,只有简单的页面展现,用以说明Portlet的开发过程. 一.创建Portlet工程 1.打开Lif ...

    7. Chapter 2 创建一个应用

      App Engine开发模式如下一般简单<1.The App Engine development model is as simple as it gets:>: 1.创建这个应用 2. ...

    8. 如何用 React Native 创建一个iOS APP?

      诚然,React Native 结合了 Web 应用和 Native 应用的优势,可以使用 JavaScript 来开发 iOS 和 Android 原生应用.在 JavaScript 中用 Reac ...

    9. 创建一个Android工程

      Creating an Android Project 原文演示了怎么通过Android Studio和命令行两种方式来创建一个Android工程. 原文链接:http://developer.and ...

    随机推荐

    1. 利用 Forcing InnoDB Recovery 特性解决 MySQL 重启失败的问题

      小明同学在本机上安装了 MySQL 5.7.17 配合项目进行开发,并且已经有了一部分重要数据.某天小明在开发的时候,需要出去一趟就直接把电脑关掉了,没有让 MySQL 正常关闭,重启 MySQL 的 ...

    2. HYML / CSS和Javascript 部分

      1  CSS实现垂直水平居中 HTML结构: <div class="wrapper"> <div class="content">&l ...

    3. Python 一行代码

      Python语法十分便捷,通过几个简单例子了解其趣味 1.Fizz.Buzz问题为: 打印数字1到100, 3的倍数打印"Fizz", 5的倍数打印"Buzz" ...

    4. 为什么大多数培训机构还停留在只教ssh框架?

      最近听一些朋友说,招聘面试的很多人简历都差不多,大部分人的简历上面都写了熟悉ssh框架,我朋友就在吐槽,为什么这些人简历都差不多,并且都熟悉ssh框架? 后面他说, 可能这些人都是培训机构出来的, 然 ...

    5. git 分支的创建与提交

      我们在开发的过程中会遇到很多团队协作的问题,怎么来解决团队合作呢,就是靠分支来管理代码.一般来说一个功能就要创建一个分支,这样才能减少代码的冲突,给开发带来很大的方便. 首先需要克隆代码 git cl ...

    6. Oracle修改监听端口号1521[转]

      在oracle中,默认的监听端口号为1521,一旦有人扫描出这个端口号就会知道此服务器为oracle数据库服务器,存在极其大的安全隐患,在这里,教大家如何修改oracle默认端口号为9999: 1.查 ...

    7. 从性能角度看react组件拆分的重要性

      React是一个UI层面的库,它采用虚拟DOM技术减少Javascript与真正DOM的交互,提升了前端性能:采用单向数据流机制,父组件通过props将数据传递给子组件,这样让数据流向一目了然.一旦组 ...

    8. trait技术详解,这次包你学得会

      trait的使用技巧trait是php5.4以后新增加的一个功能,可以将多个类中,共用的一些属性和方法提取出来做来公共trait类,就像是装配汽车的配件,如果你的类中要用到这些配件,就直接用use导入 ...

    9. poj 1001 分析

      1) n = 0; return 1: 2) n = 1; bool standardizeNumNoDot(string &s){标准化是一定要得} _将‘.’前后的〇全部去除,正常retu ...

    10. 拖拽系列一、JavaScript实现简单的拖拽效果

          前端拖拽相关应用汇总 在现实生活中就像男孩子牵着(拖着)女朋友的手穿过马路:从马路的一端走到另一端这种场景很常见: 而在前端开发中拖拽效果也算是前端开发中应用最常见.最普遍的特效:其拖拽涉及知 ...