JS SDK的标准创建原则

Myth丶恋晨 2022-12-19 00:57 107阅读 0赞

SDK全称是“Software Development Kit”，直译就是软件开发工具集。说的再通俗点就是一个面向开发者，针对特定领域的软件包。比如Java SDK（JDK）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VqaW54aWFu_size_16_color_FFFFFF_t_70][]

一、**设计原则**

*  最小可用性原则，即用最少的代码，如无必要勿增实体。
 *  最少依赖原则，即最低限度的外部依赖，如无必要勿增依赖

1  满足功能需求

SDK一般都是偏于面向某个领域，所以，同时在设计和实现的时候明确职责和边界很重要，同时还应该足够精简，专注领域内的业务。

2  足够稳定

*  绝不能导致宿主应用崩溃，这是最基础也是最严格的要求。
 *  较好的性能，比如SDK体积应尽量小，运行速度尽量快。
 *  可测试，保障每一次变更。
 *  向后兼容，不轻易出现 Breakchange。

3  少依赖，易扩展

*  最小程度的第三方依赖，尽可能自行实现，确实无法避免则最小化引入。
 *  插件化，最大限度支持扩展。
 *  Hook机制，满足个性化诉求

二、职责边界

1、前端领域，稳定性方面主要的关注点

*  JS异常
 *  资源加载异常
 *  API请求异常
 *  白屏异常

2、性能方面，核心的关注点

*  白屏时间
 *  可交互时间（TTI）
 *  首屏时间
 *  FP / FMP / FCP 等

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VqaW54aWFu_size_16_color_FFFFFF_t_70 1][]

相关链接

[https://yueying-docs.effirst.com/api-usage.html][https_yueying-docs.effirst.com_api-usage.html]

[https://semver.org/][https_semver.org]

[https://jestjs.io/][https_jestjs.io]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VqaW54aWFu_size_16_color_FFFFFF_t_70]: /images/20221120/d6e3a1c17ab34b079731c1d59f739a58.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VqaW54aWFu_size_16_color_FFFFFF_t_70 1]: /images/20221120/a654fa725ef1434aa885e894758915d9.png
[https_yueying-docs.effirst.com_api-usage.html]: https://yueying-docs.effirst.com/api-usage.html
[https_semver.org]: https://semver.org/
[https_jestjs.io]: https://jestjs.io/