前端书写 sdk

sdk 都做些什么

软件开发者工具包

sdk 有哪些原则

1. 原生

2. 简短

3. 执行迅速

4. 易读

5. 可测试

哪些情况你应该设计 sdk

• 嵌入的 widgets

• 分析和度量

• 封装网络服务

sdk 内容应该使用异步语法来加载脚本.改善用户体验,sdk 类库不应该影响主页面的加载. 针对现代浏览器, 可以使用 async

同步与异步

渲染页面不可或缺的代码应该内联，内联代码应该简短并且执行速度要快。不是初始化必须的代码应该异步或延迟执行。

sdk 版本管理

使用“主版本.小版本.补丁号”这种有语义的命名方式管理版本。v1.0.0 v1.5.0 v2.0.0这样的版本号让使用者容易在changelog文档中跟综和查找。

命名空间

应该最多定义一个命名空间，不要使用通用的名字定义命名空间以防止和其他类库冲突。

应该用(function () { ... })()把SDK代码包起来。