如何“取巧”实现一个微前端沙箱？

2020 年 5 月 18 日 阿里技术

阿里妹导读：如今微前端已经成为前端领域比较火爆的话题，在技术方面，微前端有一个始终绕不过去的话题就是前端沙箱。本文将分享阿里云开放平台微前端方案的沙箱实现原理，具体探讨在微前端领域如何实现前端沙箱。

文末福利：下载《2020 前端工程师必读手册》电子书。

背景

应用沙箱可能是微前端技术体系里面最有意思的部分。一般来说沙箱是微前端技术体系中不是必须要做的事情，因为如果规范做的足够好，是能够避免掉一些变量冲突读写，CSS 样式冲突的情况。但是如果你在一个足够大的体系中，总不能仅仅通过规范来保证应用的可靠性，还是需要技术手段去治理运行时的一些冲突问题，这个也是沙箱方案成为微前端技术体系的一部分原因。

首先纵观各类技术方案，有一个大前提决定了这个沙箱如何做：最终微应用是单实例 or 多实例存在宿主应用中。这个直接决定了这个沙箱的复杂度和技术方案。

单实例：同一个时刻只有一个微应用实例存在，此刻浏览器所有浏览器资源都是这个应用独占的，方案要解决的很大程度是应用切换的时候的清理和现场恢复。比较轻量，实现起来也简单。

多实例：资源不是应用独占，就要解决资源共享的情况，比如路由，样式，全局变量读写，DOM。可能需要考虑的情况比较多，实现较为复杂。

最开始我们的想法是：

从业务场景：我们可能存在的情况是当用户操作一个产品 A 的同时和另一个产品 B 发生了关联操作，需要唤醒应用 B 做操作。虽然从产品维度可以规避掉，比如先切到 B，然后切回 A，但是从某种程度上因为技术的原因，我们限制了产品交互的发挥。

从技术角度：解决了多实例当然单实例的场景也不在话下，并且单实例的方案某种程度上给编码上带来了一定复杂度，比如业务代码需要自己做业务上下文的切换。

最近 qiankun 2 也转变了思路，从单实例的支持到开始支持多实例，多多少少也侧面说明了，多实例是一个值得投入和技术攻克的场景。

基于上面的考量，我们就开始了我们 Browser VM 沙箱的实现探索。总结起来可以用下图表示：

JavaScript 沙箱实现

沙箱环境构造

要实现沙箱，我们需要隔离掉浏览器的原生对象，但是如何隔离，建立一个沙箱环境呢？Node 中有 vm 模块，来实现类似的能力，但是浏览器就不行了，但是我们可以利用闭包的能力、利用变量作用域去模拟一个沙箱环境，比如下面的代码：

  
  
    
   
   
     
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
   
   
     
   
   
     function foo(window) {  console.log(window.document);}foo({    document: {};});

比如这段代码的输出一定是 {} ，而不是原生浏览器的 document。

所以 ConsoleOS（面向阿里云管体系的微前端方案）实现了一个 Wepback 的插件，在应用代码构建的时候给子应用代码加上一层 wrap 代码，创建一个闭包，把需要隔离的浏览器原生对象变成从下面函数闭包中获取，从而我们可以在应用加载的时候，传入模拟的 window、document 之类的对象。

  
  
    
   
   
     
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
   
   
     
   
   
     // 打包代码__CONSOLE_OS_GLOBAL_HOOK__(id, function (require, module, exports, {window, document, location, history}) {  /* 打包代码 */})function __CONSOLE_OS_GLOBAL_HOOK__(id, entry) {  entry(require, module, exports, {window, document, location, history})}

当然也可以不靠工程化的手段来实现，也可以通过请求脚本，然后在运行时拼接这段代码，然后 eval 或者 new Function 来达到相同的目的。

原生对象模拟

沙箱隔离能力有了，剩下的问题就是如何实现这一堆浏览器的原生对象了。最开始的想法是我们根据 ECMA 的规范实现（现在仍然有类似的想法），但是发现成本太高。不过在我们各种实验之后，发现了一个很“取巧”的做法，我们可以 new iframe 对象，把里面的原生浏览器对象通过 contentWindow 取出来，因为这些对象天然隔离，就省去了自己实现的成本。

  
  
    
   
   
     
    
    
      
   
   
     
   
   
     const iframe = document.createElement( 'iframe' );

当然里面有很多的细节需要考量，比如：只有同域的 iframe 才能取出对应的的 contentWindow 。所以需要提供一个宿主应用空的同域 URL 来作为这个 iframe 初始加载的 URL。当然根据 HTML 的规范，这个 URL 用了 about:blank 一定保证同域，也不会发生资源加载，但是会发生和这个 iframe 中关联的 history 不能被操作，这个时候路由的变换只能变成 hash 模式。

如下图所示，我们取出对应的 iframe 中原生的对象之后，就会对特定需要隔离的对象生成对应的 Proxy, 然后对一些属性获取和属性设置，做一些特定的设置，比如 window.document 需要返回特定的沙箱 document 而不是当前浏览器的 document。

  
  
    
   
   
     

  
  
    
  
  
    
   
   
     
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
   
   
     
   
   
     class Window {    constructor(options, context, frame) {    return new Proxy(frame.contentWindow, {        set(target, name, value) {        target[name] = value;        return true;      },            get(target, name) {        switch( name ) {          case 'document':            return context.document;          default:        }                if( typeof target[ name ] === 'function' && /^[a-z]/.test( name ) ){          return target[ name ].bind && target[ name ].bind( target );        }else{          return target[ name ];        }      }    });  }}

对于每一个对象的实现这里不讲细节了，有兴趣可以看看我们的开源之后的代码：

https://github.com/aliyun/alibabacloud-console-os/tree/master/packages/browser-vm

但是为了文档能够被加载在同一个 DOM 树上，对于 document，大部分的 DOM 操作的属性和方法还是直接用的宿主浏览器中的 document 的属性和方法。

由于子应用有自己的沙箱环境，之前所有独占式的资源现在都变成了应用独享（尤其是 location、history），所以子应用也能同时被加载。并且对于一些变量，我们还能在 proxy 中设置一些访问权限的事情，从而限制子应用的能力，比如 Cookie， LocalStoage 读写。

当这个 iframe 被移除时，写在 window 的变量和设置的一些 timeout 时间也会一并被移除（当然 DOM 事件需要沙箱记录，然后在宿主中移除）。

总结一下，我们的沙箱可以做到如下的特性：

CSS 隔离

CSS 隔离方案相对来说比较常规，常见的有：

CSS Module
添加 CSS 的 namespace
Dynamic StyleSheet
Shadow DOM

CSS Module or CSS Namespace

通过修改基础组件样式前缀来实现框架和微应用依赖基础组件样式的隔离性（依赖于工程上 CSS 的预处理器编译和运行时基础组件库配置），同时避免全局样式的书写（依赖于约定或工程 lint 手段）。

Dynamic StyleSheet

隔离方式是通过 JS 运行时动态加载卸载微应用样式表来避免样式的冲突，局限性一是对于站点框架本身或其部件（header/menu/footer）与当前运行的微应用间仍存在样式冲突的可能性，二是没有办法支持多个微应用同时运行显示的情况。

Shadow DOM

优点是浏览器级别提供的样式隔离能力，可以做到完全隔离。缺点在于，目前兼容性还是不太好，并且改造会涉及到旧应用的业务代码的改造，对子应用侵入性比较高。

最终经过实践，我们选择的方式是 CSS Module + 添加 CSS 的 namespace。CSS module 保证的是应用业务样式不冲突，Namespace 保证公共库不冲突。我们实现了一个 postcss 插件，会在应用构建的时候给所有的样式都加上应用前缀包括应用公共库的 CSS（这样方便做到同一个组件库新旧版本样式的兼容）。如下图所示：

  
  
    
   
   
     
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
   
   
     
   
   
     // 宿主 host app.next-btn {    color: #eee;}// 子应用 sub appaliyun-slb .next-btn {    color: #eee;}//宿主中生成的节点<aliyun-slb>    <!-- 子应用的节点 --></aliyun-slb>

这样实现的好处在于：

每个应用都有 namespace，可以多实例共存。
不依赖特定的 CSS 预处理器。
对于同一个库不同版本的 CSS（如 fusion1 和 fusion2），可以做到彻底隔离。
鉴于上面 JS 沙箱的存在，对于一些弹窗类的组件，这个微应用获取的 body 实际上是宿主生成的节点，所以弹窗会被添加到微应用的节点（也就是上面的 aliyun-slb）这个节点，样式不会失效。

不过也会有一些问题，比如：

嵌套应用组件样式优先级的问题。由于 CSS module 的存在，一般只会发生在公共 CSS 样式中，这个就是只能尽量避免嵌套。

fusion 不同版本库公用字体的问题。目前的解决办法：比较 hack，使用工程化的手段替换掉 next 字体的名字。

如何和其他体系结合

如果看完上面的文章，觉得这个沙箱方案不错，但是又已经有自己的微前端体系了，想套用咋办？

目前 ConsoleOS 的代码已经在 Github 上开源：

http://github.com/aliyun/alibabacloud-console-os ，这里不妨可以尝试试用一下。

JS 沙箱部分

如果看懂了上面关于原理的介绍可以看到其实沙箱实现包括两个层面：

原生浏览器对象的模拟（Browser-VM）
如何构建一个闭包环境

Browser-VM 可以直接用起来，这部分完全是通用普适的。但是涉及到闭包构建的这部分，每个微前端体系不太一致，可能需要改造，比如：

  
  
    
   
   
     
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
   
   
     
   
   
     import { createContext, removeContext } from '@alicloud/console-os-browser-vm';const context = await createContext();const run = window.eval(`  (() => function({window, history, locaiton, document}) {    window.test = 1;  })()`)run(context);console.log(context.window.test);console.log(window.test);// 操作虚拟化浏览器对象context.history.pushState(null, null, '/test');context.locaiton.hash = 'foo'// 销毁一个 contextawait removeContext( context );

当然可以直接选择沙箱提供好的 evalScripts 方法：

  
  
    
   
   
     
    
    
      
    
    
      
    
    
      
   
   
     
   
   
     import { evalScripts } from '@alicloud/console-os-browser-vm';const context = evalScripts('window.test = 1;')console.log(window.test === undefined) // true

CSS 沙箱

如果用 Webpack 构建，可以直接配置如下：

  
  
    
   
   
     
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
   
   
     
   
   
     const postcssWrap = require('@alicloud/console-toolkit-plugin-os/lib/postcssWrap')// 下面是 webpack config{  test: /\.css$/,  use: [    'style-loader',    {      loader: 'postcss-loader',      options: {        plugins: [          // 加入插件          postcssWrap({            stackableRoot: '.prefix',            repeat: 1            })        ],      },    },    'css-loader',  ],  exclude: /^node_modules$/,}