詳解vue3的沙箱機(jī)制

更新時(shí)間：2021年04月15日 10:19:32 作者：不知道寫(xiě)啥筆名

這篇文章主要介紹了vue3的沙箱機(jī)制的相關(guān)資料，幫助大家更好的理解和學(xué)習(xí)使用vue框架，感興趣的朋友可以了解下

前言

vue3 沙箱主要分兩種

瀏覽器編譯版本，瀏覽器版本是使用with語(yǔ)法加上proxy代理攔截
本地預(yù)編譯版本，通過(guò)在模版預(yù)編譯階段轉(zhuǎn)換階段，使用轉(zhuǎn)換插件transformExpression將非白名單標(biāo)識(shí)符掛在在組件代理對(duì)象下

瀏覽器編譯版本

render 函數(shù)編譯結(jié)果

<div>{{test}}</div>
<div>{{Math.floor(1)}}</div>

to

const _Vue = Vue;

return function render(_ctx, _cache, $props, $setup, $data, $options) {
  with (_ctx) {
    const {
      toDisplayString: _toDisplayString,
      createVNode: _createVNode,
      Fragment: _Fragment,
      openBlock: _openBlock,
      createBlock: _createBlock,
    } = _Vue;

    return (
      _openBlock(),
      _createBlock(
        _Fragment,
        null,
        [
          _createVNode("div", null, _toDisplayString(test), 1 /* TEXT */),
          _createVNode(
            "div",
            null,
            _toDisplayString(Math.floor(1)),
            1 /* TEXT */
          ),
        ],
        64 /* STABLE_FRAGMENT */
      )
    );
  }
};

從上面的代碼，我們能發(fā)現(xiàn)，變量標(biāo)識(shí)符沒(méi)有增加前綴，只是用with語(yǔ)法包裹了一下，延長(zhǎng)作用域鏈，那么是如何做到 js 沙箱攔截的呢？例如變量test，理論上說(shuō)，當(dāng)前作用域鏈沒(méi)有test變量，變量會(huì)從上一層作用域查找，直到查找到全局作用域，但是，實(shí)際上只會(huì)在_ctx上查找，原理很簡(jiǎn)單，_ctx是一個(gè)代理對(duì)象，那么我們?nèi)绾问褂肞roxy做攔截，示例代碼如下：

const GLOBALS_WHITE_LISTED =
  "Infinity,undefined,NaN,isFinite,isNaN,parseFloat,parseInt,decodeURI," +
  "decodeURIComponent,encodeURI,encodeURIComponent,Math,Number,Date,Array," +
  "Object,Boolean,String,RegExp,Map,Set,JSON,Intl,BigInt";

const isGloballyWhitelisted = (key) => {
  return GLOBALS_WHITE_LISTED.split(",").includes(key);
};

const hasOwn = (obj, key) => {
  return Object.prototype.hasOwnProperty.call(obj, key);
};

const origin = {};
const _ctx = new Proxy(origin, {
  get(target, key, reciever) {
    if (hasOwn(target, key)) {
      Reflect.get(target, key, reciever);
    } else {
      console.warn(
        `Property ${JSON.stringify(key)} was accessed during render ` +
          `but is not defined on instance.`
      );
    }
  },
  has(target, key) {
    // 如果是 全局對(duì)象 返回false，不觸發(fā)get 攔截，從上一層作用域查找變量
    // 如果不是 全局對(duì)象 返回true，觸發(fā)get 攔截
    return !isGloballyWhitelisted(key);
  },
});

代碼很簡(jiǎn)單，為什么這么簡(jiǎn)單的代碼就能做到攔截？因?yàn)?with 語(yǔ)句會(huì)觸發(fā) has 攔截，當(dāng) has 返回 true，就會(huì) 觸發(fā)代理對(duì)象 get 攔截，如果返回 false，則代理對(duì)象 get 攔截不會(huì)觸發(fā)，變量不在當(dāng)前代理對(duì)象查找，直接查找更上一層作用域

本地預(yù)編譯版本

<div>{{test}}</div>
<div>{{Math.floor(1)}}</div>

to

import {
  toDisplayString as _toDisplayString,
  createVNode as _createVNode,
  Fragment as _Fragment,
  openBlock as _openBlock,
  createBlock as _createBlock,
} from "vue";

export function render(_ctx, _cache, $props, $setup, $data, $options) {
  return (
    _openBlock(),
    _createBlock(
      _Fragment,
      null,
      [
        _createVNode("div", null, _toDisplayString(_ctx.a), 1 /* TEXT */),
        _createVNode(
          "div",
          null,
          _toDisplayString(Math.floor(1)),
          1 /* TEXT */
        ),
      ],
      64 /* STABLE_FRAGMENT */
    )
  );
}

從上面的代碼我們可以發(fā)現(xiàn)，非白名單標(biāo)識(shí)符都添加了_ctx 變量前綴，那么是如何做到的呢？當(dāng)本地編譯 template 時(shí)，處于轉(zhuǎn)換階段時(shí)會(huì)對(duì) 變量表達(dá)式節(jié)點(diǎn)NodeTypes.SIMPLE_EXPRESSION進(jìn)行添加前綴處理，示例代碼如下：

const GLOBALS_WHITE_LISTED =
  "Infinity,undefined,NaN,isFinite,isNaN,parseFloat,parseInt,decodeURI," +
  "decodeURIComponent,encodeURI,encodeURIComponent,Math,Number,Date,Array," +
  "Object,Boolean,String,RegExp,Map,Set,JSON,Intl,BigInt";

const isGloballyWhitelisted = (key) => {
  return GLOBALS_WHITE_LISTED.split(",").includes(key);
};
const isLiteralWhitelisted = (key)=>{
  return 'true,false,null,this'.split(',').includes(key)
}
export function processExpression(
  node
) {
  const rewriteIdentifier = (raw) => {
    return `_ctx.${raw}`
  }
  const rawExp = node.content
  if (isSimpleIdentifier(rawExp)) {
    const isAllowedGlobal = isGloballyWhitelisted(rawExp)
    const isLiteral = isLiteralWhitelisted(rawExp)
    if (!isAllowedGlobal && !isLiteral) {
      node.content = rewriteIdentifier(rawExp)
    }
    return node
  }

當(dāng)然上面的代碼只是簡(jiǎn)化版本，原版插件還做了精確到了__props $setup，減短變量查詢(xún)路徑，提高性能，還有通過(guò)babel編譯復(fù)雜表達(dá)式比如：箭頭函數(shù)。