目錄前言iframe實現沙箱diff方式實現沙箱基于代理(Proxy)實現單實例沙箱基于代理(Proxy)實現多實例沙箱結束語參考前言

在微前端領域當中，沙箱是很重要的一件事情。像微前端框架single-spa沒有實現js沙箱，我們在構建大型微前端應用的時候，很容易造成一些變量的沖突，對應用的可靠性面臨巨大的風險。在微前端當中，有一些全局對象在所有的應用中需要共享，如document,location,等對象。子應用開發的過程中可能是多個團隊在做，很難約束他們使用全局變量。有些頁面可能會有多個不同的子應用，需要我們支持多沙箱，每個沙箱需要有加載，卸載，在恢復的能力。

iframe實現沙箱

在前端中，有一個比較重要的html標簽iframe，實際上，我們可以通過iframe對象，把原生瀏覽器對象通過contentWindow取出來，這個對象天然具有所有的屬性，而且與主應用的環境隔離。下面我們通過代碼看下

let iframe = document.createElement(’iframe’,{src:’about:blank’});document.body.appendChild(iframe);const sandboxGlobal = iframe.contentWindow;

注意：只有同域的ifame才能取出對應的contentWindow, iframe的src設置為about:blank,可以保證一定是同域的，也不會發生資源加載，參考iframe src

在前言中我們提到，微前端除了有一個隔離的window環境外，其實還需要共享一些全局對象,這時候我們可以用代理去實現。下面我們通過代碼看下

class SandboxWindow { /** * 構造函數 * @param {*} context 需要共享的對象 * @param {*} frameWindow iframe的window */ constructor(context, frameWindow) {return new Proxy(frameWindow, { get(target, name) {if (name in context) { // 優先使用共享對象 return context[name];}return target[name]; }, set(target, name, value) {if (name in context) { // 修改共享對象的值 return context[name] = value;}target[name] = value; }}) }}// 需要全局共享的變量const context = { document:window.document, history: window.history }// 創建沙箱const newSandboxWindow = new SandboxWindow(context, sandboxGlobal); // 判斷沙箱上的對象和全局對象是否相等console.log(’equal’,newSandboxWindow.document === window.document)newSandboxWindow.abc = ’1’; //在沙箱上添加屬性console.log(window.abc); // 在全局上查看屬性console.log(newSandboxWindow.abc) //在沙箱上查看屬性

我們運行起來，看下結果

以上我們利用iframe沙箱可以實現以下特性：

全局變量隔離，如setTimeout、location、react不同版本隔離 路由隔離，應用可以實現獨立路由，也可以共享全局路由 多實例，可以同時存在多個獨立的微應用同時運行diff方式實現沙箱

在不支持代理的瀏覽器中，我們可以通過diff的方式實習沙箱。在應用運行的時候保存一個快照window對象，將當前window對象的全部屬性都復制到快照對象上，子應用卸載的時候將window對象修改做個diff，將不同的屬性用個modifyMap保存起來，再次掛載的時候再加上這些修改的屬性。代碼如下：

class DiffSandbox { constructor(name) { this.name = name; this.modifyMap = {}; // 存放修改的屬性 this.windowSnapshot = {}; } active() { // 緩存active狀態的沙箱 this.windowSnapshot = {}; for (const item in window) { this.windowSnapshot[item] = window[item]; } Object.keys(this.modifyMap).forEach(p => { window[p] = this.modifyMap[p]; }) } inactive() { for (const item in window) { if (this.windowSnapshot[item] !== window[item]) {// 記錄變更this.modifyMap[item] = window[item];// 還原windowwindow[item] = this.windowSnapshot[item]; } } }}const diffSandbox = new DiffSandbox(’diff沙箱’);diffSandbox.active(); // 激活沙箱window.a = ’1’console.log(’開啟沙箱：’,window.a);diffSandbox.inactive(); //失活沙箱console.log(’失活沙箱：’, window.a);diffSandbox.active(); // 重新激活console.log(’再次激活’, window.a);

我們運行一下，查看結果

這種方式也無法支持多實例，因為運行期間所有的屬性都是保存在window上的。

基于代理(Proxy)實現單實例沙箱

在ES6當中，我們可以通過代理(Proxy)實現對象的劫持?；緦嶄浺彩峭ㄟ^window對象的修改進行記錄，在卸載時刪除這些記錄，在應用再次激活時恢復這些記錄，來達到模擬沙箱環境的目的。代碼如下

// 修改window屬性的公共方法const updateWindowProp = (prop, value, isDel) => { if (value === undefined || isDel) {delete window[prop]; } else {window[prop] = value; }}class ProxySandbox { active() {// 根據記錄還原沙箱this.currentUpdatedPropsValueMap.forEach((v, p) => updateWindowProp(p, v)); } inactive() {// 1 將沙箱期間修改的屬性還原為原先的屬性this.modifiedPropsMap.forEach((v, p) => updateWindowProp(p, v));// 2 將沙箱期間新增的全局變量消除this.addedPropsMap.forEach((_, p) => updateWindowProp(p, undefined, true)); } constructor(name) {this.name = name;this.proxy = null;// 存放新增的全局變量this.addedPropsMap = new Map(); // 存放沙箱期間更新的全局變量this.modifiedPropsMap = new Map();// 存在新增和修改的全局變量，在沙箱激活的時候使用this.currentUpdatedPropsValueMap = new Map();const { addedPropsMap, currentUpdatedPropsValueMap, modifiedPropsMap } = this;const fakeWindow = Object.create(null);const proxy = new Proxy(fakeWindow, { set(target, prop, value) {if (!window.hasOwnProperty(prop)) { // 如果window上沒有的屬性，記錄到新增屬性里 // debugger; addedPropsMap.set(prop, value);} else if (!modifiedPropsMap.has(prop)) { // 如果當前window對象有該屬性，且未更新過，則記錄該屬性在window上的初始值 const originalValue = window[prop]; modifiedPropsMap.set(prop, originalValue);}// 記錄修改屬性以及修改后的值currentUpdatedPropsValueMap.set(prop, value);// 設置值到全局window上updateWindowProp(prop, value);return true; }, get(target, prop) {return window[prop]; },});this.proxy = proxy; }}const newSandBox = new ProxySandbox(’代理沙箱’);const proxyWindow = newSandBox.proxy;proxyWindow.a = ’1’console.log(’開啟沙箱：’, proxyWindow.a, window.a);newSandBox.inactive(); //失活沙箱console.log(’失活沙箱：’, proxyWindow.a, window.a);newSandBox.active(); //失活沙箱console.log(’重新激活沙箱：’, proxyWindow.a, window.a);

我們運行代碼，看下結果

這種方式同一時刻只能有一個激活的沙箱，否則全局對象上的變量會有兩個以上的沙箱更新，造成全局變量沖突。

基于代理(Proxy)實現多實例沙箱

在單實例的場景總，我們的fakeWindow是一個空的對象，其沒有任何儲存變量的功能，微應用創建的變量最終實際都是掛載在window上的，這就限制了同一時刻不能有兩個激活的微應用。

class MultipleProxySandbox { active() {this.sandboxRunning = true; } inactive() {this.sandboxRunning = false; } /** * 構造函數 * @param {*} name 沙箱名稱 * @param {*} context 共享的上下文 * @returns */ constructor(name, context = {}) {this.name = name;this.proxy = null;const fakeWindow = Object.create({});const proxy = new Proxy(fakeWindow, { set: (target, name, value) => {if (this.sandboxRunning) { if (Object.keys(context).includes(name)) {context[name] = value; } target[name] = value;} }, get: (target, name) => {// 優先使用共享對象if (Object.keys(context).includes(name)) { return context[name];}return target[name]; }})this.proxy = proxy; }}const context = { document: window.document };const newSandBox1 = new MultipleProxySandbox(’代理沙箱1’, context);newSandBox1.active();const proxyWindow1 = newSandBox1.proxy;const newSandBox2 = new MultipleProxySandbox(’代理沙箱2’, context);newSandBox2.active();const proxyWindow2 = newSandBox2.proxy;console.log(’共享對象是否相等’, window.document === proxyWindow1.document, window.document === proxyWindow2.document);proxyWindow1.a = ’1’; // 設置代理1的值proxyWindow2.a = ’2’; // 設置代理2的值window.a = ’3’; // 設置window的值console.log(’打印輸出的值’, proxyWindow1.a, proxyWindow2.a, window.a);newSandBox1.inactive(); newSandBox2.inactive(); // 兩個沙箱都失活proxyWindow1.a = ’4’; // 設置代理1的值proxyWindow2.a = ’4’; // 設置代理2的值window.a = ’4’; // 設置window的值console.log(’失活后打印輸出的值’, proxyWindow1.a, proxyWindow2.a, window.a);newSandBox1.active(); newSandBox2.active(); // 再次激活proxyWindow1.a = ’4’; // 設置代理1的值proxyWindow2.a = ’4’; // 設置代理2的值window.a = ’4’; // 設置window的值console.log(’失活后打印輸出的值’, proxyWindow1.a, proxyWindow2.a, window.a);

運行代碼，結果如下：

這種方式同一時刻只能有一個激活的多個沙箱，從而實現多實例沙箱。

結束語

以上是微前端比較常用的沙箱實現方式，想要在生產中使用，需要我們做很多的判斷和約束。下篇我們通過源碼看下微前端框架qiankun是怎么實現沙箱的。上面的代碼在github，如需查看，請移步js-sandbox

參考

iframe src ES6 Proxy

到此這篇關于淺談前端JS沙箱實現的幾種方式的文章就介紹到這了,更多相關JS 沙箱內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網！