如何快速将你的应用封装成js-sdk?

前言

本文将介绍前端如何封装一款 js-sdk 以及如何快速将你的应用变成 js-sdk , 我们将总结一些封装 js-sdk 的原则和案例, 来帮大家更快的上手 sdk 开发. 其中笔者还会以H5-Dooring 为例子, 介绍如何将 H5 页面编辑器封装成一个 js-sdk 供他人使用. 

正文

在开始文章之前, 笔者先来介绍一下什么是 sdk .

sdk 即软件开发工具包, 一般是一些软件工程师为特定的软件包、软件框架、硬件平台、操作系统等建立应用软件时的开发工具的集合。

对于 js-sdk 而言, 我们能举出很多例子, 如下:

• UI组件库

• 性能监控工具, 如阿里 arms

• 统计分析工具

• 阿里云智能验证sdk

• 极验验证sdk

sdk 的目的是提高我们开发项目的效能, 安全性和便捷性等问题, 所以我们在设计 sdk 时一定要遵循一些原则, 如下: 

• 最小可用性原则: 也就是没有必要的功能/代码尽量不额外添加, 使代码达到最简

• 最少依赖原则: 也就是没有必要的依赖坚决不添加, 以达到最低限度的外部依赖

• 易扩展: 插件化，最大限度支持扩展和自定义

• 稳定性: 绝不能导致宿主应用崩溃，向后兼容, 可测试

在熟悉以上的背景和原则之后, 我们来看看如何实现一个 sdk 的案例.

将 H5-Dooring 封装成一个 js-sdk

笔者在这拿 开源页面制作工具 H5-Dooring 来作为案例(当然将其封装成 sdk 也是我们迭代中的一部分, 甚至后期会做成npm包), 介绍如何封装js-sdk, 我们先看一张抽象图:  我们的 sdk 就好像一个完整系统的一个零件, 可以和系