如何开发一款JSSDK

本文作者系360奇舞团前端开发工程师JSSDK的定义与分类什么是JSSDKSDK是Software Development Kit（软件开发工具包）的缩写，JSSDK是为了帮助前端实现特定需求，而向开发者暴露的一些JS-API的集合，开发者可以通过它在网页中集成和使用某些特定的功能，例如社交分享、地图服务、支付功能等.它通常包括一下模块：JavaScript库：这是 JSSDK 的核心部分，包含了

奇舞周刊

1438人浏览 · 2024-07-01 18:00:37

奇舞周刊 · 2024-07-01 18:00:37 发布

本文作者系360奇舞团前端开发工程师

JSSDK的定义与分类

什么是JSSDK

SDK是Software Development Kit（软件开发工具包）的缩写，JSSDK是为了帮助前端实现特定需求，而向开发者暴露的一些JS-API的集合，开发者可以通过它在网页中集成和使用某些特定的功能，例如社交分享、地图服务、支付功能等.它通常包括一下模块：

JavaScript库：这是 JSSDK 的核心部分，包含了一系列预先编写好的JavaScript代码，这些代码实现了一些特定的功能，如用户认证、数据分析、社交分享等。
API 文档：这部分文档详细描述了如何使用 JSSDK 中的各个功能。它通常会包含函数和方法的列表，以及如何使用这些函数和方法。
示例代码：这部分代码展示了如何在实际项目中使用 JSSDK。通过阅读和运行示例代码，开发者可以更好地理解如何使用 JSSDK。

JSSDK的分类

JSSDK 的分类主要取决于它们提供的功能和服务。通常根据其功能不同分为：UI组件库、JS工具库、分析统计SDK、社交媒体SDK

UI组件库：通过封装一系列组件，通过配置帮助开发者调用，实现一些UI效果，例如：Antd、ElementUI、Vant、Bootstrap等
JS类库：通过实现一类常用的方法，便于开发处理数据，也不用再考虑兼容性，常用的如：lodash、moment、axios、jQuery等
监控统计工具：通过API，来监听前端系统的报错、统计数据，以及数据上报等，例如：Sentry、百度统计、Google Analytics JSSDK等
其他第三方的SDK：微信SDK、支付宝SDK、新浪微博SDK，Facebook JSSDK等

如何设计JSSDK

设计SDK要遵循的原则

单一职责原则:SDK一般都是为了满足一类业务的需要，所以设计之初要明确业务范围，如果功能过于复杂，可以拆改成几个独立的SDK，在主SDK中引入相关逻辑就OK了，这样便于功能解耦和测试。
最小可用、最少依赖性原则:能用确定的方法实现，就不要再去搞复杂的内容。SDK要减少依赖，一些工具库能不用就不用。尽可能自行实现必要的方法，或者引入尽量少的库。否则会导致SDK打包后过大，或者更新版本带来的兼容问题。
稳定性原则:保持SDK足够的稳定性，一方面要保持API方法的稳定，另一方面在设计API的入参时，参数要用对象类型，这样便于后续扩展添加更多参数。如果SDK有升级要考虑兼容旧版本。新功能要新增API，旧的API不要删除。
易用性原则:要满足易用性原则，首先要有简洁的API，明确的方法注释、文档跟示例代码很重要，不管SDK写的多漂亮，使用者首先接触的是接入文档，然后是覆盖所有API的示例代码，一个好的实例代码能起到事半功倍的效果。

语言与构建工具选择

语言的选择语言无非是选择TS还是JS,这里推荐使用TS来编写SDK代码因为相比JS而言他有如下优势：

类型系统：TypeScript的最大特点就是它的类型系统。这个类型系统可以在编译阶段捕获许多常见的错误，如类型错误、未定义的函数或属性等，从而提高代码的质量和可维护性。
更好的工具支持：由于TypeScript的类型信息，IDE 和编辑器可以提供更好的代码补全、自动提示等功能。

构建工具的选择推荐使用Rollup来作为SDK项目的打包构建工具

Rollup的配置通常比Webpack更简单，更易于理解。这对于新手或者希望快速开始项目的开发者来说是一个优点。
更好的Tree-shaking：Rollup 的Tree-shaking功能通常比Webpack更有效。Tree-shaking 是一种只包含实际使用的代码，而去除未使用代码的优化技术。这可以帮助减小最终打包文件的大小。
Rollup是以ES6模块标准为中心设计的，这使得它在处理ES6模块时更加高效。
适合库的打包：由于Rollup的特性，它通常更适合用于打包库（library）或者工具，而Webpack则更适合用于打包应用（application）。

SDK核心功能的实现

需求

假设我们开发一款问卷投放SDK，满足问卷的自动投放、代码控制投放、事件触发投放、问卷回收等逻辑。注意单一职责原则的应用，只做问卷的投放、回收逻辑。问卷里面内容展示，以及内部相关逻辑不涉及。

项目结构

`src`: 源代码

api/index.ts: 网络请求的API封装
core/index.ts:核心入口文件
core/dependencies.ts:核心逻辑实现文件
style/index.css: 样式文件
types/index.ts: 声明的类型文件
utils/constants.ts: 常量文件
utils/http.ts: 网络请求封装库
utils/index.ts: 工具函数
utils/pv.ts: 路由监听处理函数

API的设计

`SDK API`的设计根据功能分为两大类：`生命周期方法`与`实例方法`.

生命周期方法：主要是SDK的生命周期回调函数：从init初始化方法，问卷的打开与关闭回调。
实例方法：负责具体的业务实现

需要注意的是在设计对外API时，每个API都要有方法执行完成后回调，便于用户执行后续逻辑。

项目架构

Index入口文件里面主要是对外的 SDK生命周期方法与实例方法。首先调用initQaSDK,完成问卷SDK实例的创建，里面主要包含：

单例模式来创建实例
接受用户的必要入参与参数校验
设置路由变化监听
完成与服务端的对接逻辑

Dependencies：里面是核心逻辑层的实现。单独抽出一个文件的目的是，便于方法的复用。再下面是对Dom的操作：Dom元素的创建、更新、与移除逻辑，最底下是依赖语言与构建工具

rollup.config.mjs

import ts from "rollup-plugin-typescript2";
import dts from "rollup-plugin-dts";
import commonjs from '@rollup/plugin-commonjs'
// es6 转 es5
import babel from '@rollup/plugin-babel'
// 模块自动导入并导出
import { importExportPlugin } from 'rollup-plugin-import-export'
import postcss from 'rollup-plugin-postcss'; // 处理css 的插件
// 代码压缩
import terser from '@rollup/plugin-terser'
// 配置环境变量
import replace from 'rollup-plugin-replace';
import { nodeResolve } from '@rollup/plugin-node-resolve';
import json from '@rollup/plugin-json';

import path from "path"
import { fileURLToPath } from 'url'
const __filenameNew = fileURLToPath(import.meta.url)
const __dirnameNew = path.dirname(__filenameNew)

const isProduction = process.env.NODE_ENV === 'production';

const API_URL_MAP = {
    production: 'https://prod.***',
    pre: 'https://pre.*****',
    development: 'https://dev.***'
};

function getEnvApiUrl() {
    return API_URL_MAP[process.env.NODE_ENV] || API_URL_MAP.production;
}

export default [
    {
        //入口文件
        input: './src/core/index.ts',
        output: [
             //打包esModule
            {
                file: path.resolve(__dirnameNew, "./dist/index.esm.js"),
                format: "es", //输出类型 ESM 支持通过import export引入
                sourcemap: false,
            },
             //打包common js 支持 require exports 引入
            {
                file: path.resolve(__dirnameNew, "./dist/index.cjs.js"),
                format: "cjs",
                sourcemap: false,
            },
            //打包 AMD CMD UMD global 引入 将依赖包注入到全局变量中 支持<script>引入
            {
                file: path.resolve(__dirnameNew, "./dist/index.js"),
                format: "umd",
                name: "QaSdk",
                sourcemap: false,
            },
        ],
         //配置ts
        plugins: [
            nodeResolve(),
            json(),
            postcss(),
            ts(),
            importExportPlugin(),
            babel(),
            commonjs(),
            isProduction ? terser() : null, // 生成环境启用压缩
            replace({
                'process.env.API_URL': JSON.stringify(getEnvApiUrl()),
                'process.env.API_URL_MAP': JSON.stringify(API_URL_MAP),
                'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV),
            })
        ],
    },
    {
        //打包声明文件
        input: "./src/core/index.ts",
         output: {
            file: path.resolve(__dirnameNew, "./dist/index.d.ts"),
            format: "es",
          },
          plugins: [dts()],
    }
]

rollup.config.mjs 是 Rollop 构建工具的核心配置文件，相当于 webpack.config.js 文件在 Webpack 构建工具中的作用。用于定义构建过程的各种设置。例如，入口文件、输出文件、模块解析规则、插件等。

-input: 入口文件

- output: 输出配置项

定义了三种输出格式：

es：这是ES模块格式。这种格式的模块可以通过 import 和 export 关键字在现代浏览器或 Node.js 中使用。

cjs：这是CommonJS格式。这种格式的模块可以通过 require 和 module.exports 在 Node.js 中使用。

umd：这是通用模块定义格式。这种格式的模块可以在各种环境中使用，包括浏览器（通过 <script> 标签引入）和` Node.js`

- plugins: 依赖的插件列表

- external: 忽略打包模块列表

- cache: 构建缓存，通过增量构建提高构建速度

环境变量的设置

plugins: [
    nodeResolve(),
    json(),
    postcss(),
    ts(),
    importExportPlugin(),
    babel(),
    commonjs(),
    isProduction ? terser() : null, // 生成环境启用压缩
    replace({
        'process.env.API_URL': JSON.stringify(getEnvApiUrl()),
        'process.env.API_URL_MAP': JSON.stringify(API_URL_MAP),
        'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV),
    })
]

环境变量的配置使用rollup-plugin-replace这个Rollup插件，它的作用是在源代码中查找并替换特定的字符串，我们常用它进行处理环境变量。

比如：要根据不通的环境，请求不同的服务，可以在代码中使用 process.env.API_URL 。在打包过程中，rollup-plugin-replace 插件，会根据当前的环境将这个字符串替换为实际的值。

注意点

做好入参校验，你不知道用户是否传递以及传递何种类型的参数，做好入参校验与错误提示。
对外API保持入参的数据结构统一。最好是都用对象来作为入参，便于后续扩展更多参数
有些方法要有onCompleted 回调，比如init初始化完成后，有回调，便于用户处理一些其他逻辑
下面是两个自动写注释的Vscode插件

发布、维护、更新

发布到CDN或是NPM

为了便于用户使用，SDK要发布CDN与NPM上，打包完成后，js 文件要有一定的命名规范：

[名称]_[prod/test]_[版本].js

将打包好的js文件进行发布到CDN，用户通过引入链接的形式进行访问

Npm发布
需要注意的是，如果要将包发布到npm上，需要设置package.json 的几个关键参数：
• name: 名称
• version：版本：遵循Major. Minor. Patch规范
• description：描述
• main：主文件
• keywords：SDK搜索关键词
• maintainers: 列表，维护者信息可以是多个
最后执行：
```
npm login
npm publish
```
进行包的发布

维护与更新

SDK的维护更新关键是要做好两个关键文档的书写：SDK接入文档与SDK维护文档，这两个文档一个是对外的，便于开发者接入的文档，一个是对内的，便于项目开发者的维护文档，这两个文档需要包含一下内容：

SDK 接入文档（对外）
• SDK简介
• SDK支持的平台
• SDK接入方式：cdn & npm
• SDK API的介绍：API简介&示例&参数说明
• 示例代码：example
SDK维护更新文档（对内）
• SDK目录文件说明
• 如何运行调试SDK
• 打包发布SDK
• SDK更新记录：版本&发布时间&cdn地址&更新内容