在 Web 应用的运行时实现多分支并存和切换

一般来说，SaaS 服务商提供的是标准化的产品服务，体现的是所有客户的共性需求。然而，部分客户（尤其是大客户），会提出功能、UI 等方面的定制需求。针对这些定制需求，大体上有两个解决方案。,第一个方案是提供应用程序 SDK，由客户的开发团队完成整个定制应用的开发和部署，SaaS 服务商提供必要的技术支持即可。此方案要求客户的开发团队具备较强的 IT 专业能力。,第二个方案则是由 SaaS 服务商的开发团队在 SaaS 应用的基础上进行二次开发，并部署。此方案主要面向 IT 专业能力较弱，或者仅需在 SaaS 应用的基础上进行少量定制的客户。然而，要支持这种定制方式，相当于要求 SaaS 服务商在 同一个应用中，针对不同的客户运行不同分支的代码 。要达到这个目的，应用程序的架构也要进行相应的改造。本文主要讲述改造的方案及其代码实现。,对于前后端分离的项目来说，经过构建，最终会生成 html、js、css 三种代码文件。以基于 Vue.js 框架的项目为例，其构建出来的 index.html，内容与下面的代码相似：,实际上，index.html 只是访问入口，主要作用就是加载 css 和 js 资源。换句话说： 任何的 html 页面，只要加载了上述 css 和 js 资源，都可以运行这个应用 。,既然如此，只要 做一个应用入口页，并根据客户配置加载相应代码分支构建出来的 css 和 js 资源即可 。整体流程如下图所示：,,入口页要加载对应分支的 css 和 js 资源，首先需要一个资源列表。我们可以在构建流程增加一个步骤，把 js 和 css 的引用提取到一个 资源目录文件（index-assets.json） 中：,执行脚本后，就会生成资源目录文件，其内容为：,在提取资源的过程中，移除了通过 link 标签 preload 的资源，并把 prefetch 的资源放到了资源列表的末尾。具体原因会在后文说明。,此外，因为多个分支构建出来的代码都要上传到 OSS，为了避免放在同一个目录下互相覆盖，就得再加一层分支目录。,https://cdn.my-app.net/sample/ ${branch}/,所以，代码分支对应的资源目录文件路径就是：,https://cdn.my-app.net/sample/ ${branch}/index-assets.json,,加载流程如上图所示，接下来针对每一步详述。,进入页面后，携带客户信息（客户标识、内容标识等）请求后端接口，该接口会返回代码分支名。实现如下：,除了实现基本的流程，以上代码还做了降级处理—— 如果后端接口超时或响应异常，就加载主分支，避免页面白屏 。,加载指定分支名的资源目录。实现如下：,同样地，以上代码也做了降级处理—— 如果特定分支名的资源目录文件加载失败，就会加载主分支的资源目录文件，避免页面白屏 。,遍历资源列表，把 css 和 js 都加载到页面上。代码实现如下：,需要注意的是，对于动态创建的 script 节点来说，它的 async 属性默认为 true。也就是说，这些 script 会被并行请求，并尽快解析和执行， 执行顺序是未知的 。然而，资源目录中的 js 是有依赖关系的，后面的 js 依赖于前面的 js。因此，必须把 script 节点的 async 设为 false，让其按顺序解析和执行。,脚本顺利执行后，应用就会初始化。,为了让读者更好地理解整个过程，上述加载分支资源的代码是用 ES6 编写的，并且会用到如 fetch、Promise、async、await 等特性。从兼容性的角度考虑，这段代码需要经过 Babel 的转译，转译的过程中会插入一些额外的代码。然而，这段代码会阻塞后续的流程，应尽可能轻量化。因此，实际开发的时候是采用 ES5 编写，fetch 也替换为 XMLHttpRequest。此外，由于代码量比较少，还可以通过 Webpack 的 inline-source-webpack-plugin，把构建后的 js 代码以行内脚本的形式输出到页面上，减少一个 js 文件请求。,由于资源目录文件的路径是固定的，所以该文件要禁用 HTTP 的强缓存，或者仅配置短时间的强缓存。,否则，一旦用户使用的浏览器长时间缓存了该文件，那么在缓存期间，不管更新了多少个版本，用户访问的仍然是缓存下来的那个版本。,定制客户毕竟是少数，大部分客户用的仍然是标准的 SaaS 应用。也就是说，大部分情况下加载的是主分支的资源目录文件。因此，可以在入口页提前加载这个资源：,link 标签支持两种方式的预加载：,preload 是提前加载，但是不阻塞 onload，主要用于预加载当前页面会用到的资源；,prefetch 是闲时加载，主要用于加载将来可能会用到的资源。,以前文的 index.html 为例，app.2dd9bc59.css、vendors~app.f1dba939.js、app.f7eb55ca.js 这三个资源都在页面中通过 link 或 script 标签引用，所以会通过 preload 去提前加载。而其他资源则是将来可能会用到的资源（比如在某个时机才会动态 import 的资源），所以是通过 prefetch 闲时加载。,然而，在前文讲到提取页面 css 和 js 资源的时候，我们把 preload 的资源移除了，并且把 prefetch 的资源移到了末尾。为什么要这么做呢？我们从入口页加载流程去分析这个问题。,,如上图所示：,总地来说，本文所述的方案有以下优势：,然而，也具备一定的局限性：