終於搞懂了！原來vue3中template使用ref無需.value是因為這個

前端欧阳發表於2024-06-07
Vue

前言

眾所周知，vue3的template中使用ref變數無需使用.value。還可以在事件處理器中進行賦值操作時，無需使用.value就可以直接修改ref變數的值，比如：<button @click="msg = 'Hello Vue3'">change msg</button>。你猜vue是在編譯時就已經在程式碼中生成了.value，還是執行時使用Proxy攔截的方式去實現的呢？注：本文中使用的vue版本為3.4.19。

關注公眾號：【前端歐陽】，給自己一個進階vue的機會

看個demo

看個簡單的demo，程式碼如下：

<template>
  <p>{{ msg }}</p>
  <button @click="msg = 'Hello Vue3'">change msg</button>
</template>

<script setup lang="ts">
import { ref } from "vue";

const msg = ref("Hello World");

console.log(msg.value);
</script>

上面的程式碼很簡單，在script中想要訪問msg變數的值需要使用msg.value。但是在template中將msg變數渲染到p標籤上面時就是直接使用{{ msg }}，在click的事件處理器中給msg變數賦新的值時也沒有使用到.value。

然後在瀏覽器中找到上面這個vue檔案編譯後的樣子，在之前的文章中已經講過很多次如何在瀏覽器中檢視編譯後的vue檔案，這篇文章就不贅述了。編譯後的程式碼如下：

import {
  Fragment as _Fragment,
  createElementBlock as _createElementBlock,
  createElementVNode as _createElementVNode,
  defineComponent as _defineComponent,
  openBlock as _openBlock,
  toDisplayString as _toDisplayString,
  ref,
} from "/node_modules/.vite/deps/vue.js?v=23bfe016";

const _sfc_main = _defineComponent({
  __name: "index",
  setup() {
    const msg = ref("Hello World");
    console.log(msg.value);
    const __returned__ = { msg };
    return __returned__;
  },
});

function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
  return (
    _openBlock(),
    _createElementBlock(
      _Fragment,
      null,
      [
        _createElementVNode("p", null, _toDisplayString($setup.msg), 1),
        _createElementVNode(
          "button",
          {
            onClick:
              _cache[0] ||
              (_cache[0] = ($event) => ($setup.msg = "Hello Vue3")),
          },
          "change msg"
        ),
      ],
      64
    )
  );
}
_sfc_main.render = _sfc_render;
export default _sfc_main;

vue檔案編譯後的程式碼主要分為兩塊：_sfc_main和_sfc_render。

  • _sfc_main中主要是setup方法，這個是vue的<script setup lang="ts">部分編譯後的樣子。從上面可以看到在編譯後的setup方法中，訪問msg變數時依然使用了msg.value，並且在setup方法中return了{ msg }物件。

  • _sfc_render就是我們熟悉的render函式，在render函式中渲染p標籤部分的內容是：_toDisplayString($setup.msg)。很明顯這個toDisplayString就是一個將輸入值轉換為字串的函式，並沒有處理.value。

    $setup.msg中的$setup.，我想你猜到了應該和前面這個setup方法中return的{ msg }物件有關，但是又不是直接使用setup方法中return的{ msg }物件，因為使用setup中的msg變數需要使用.value，在編譯後的render函式中並沒有幫我們自動生成一個.value，比如這樣的程式碼：$setup.msg.value。

    同樣的在render函式中，button的click事件給msg變數賦值時也沒有幫我們生成一個類似於這樣的程式碼：$setup.msg.value = "Hello Vue3"，而是$setup.msg = "Hello Vue3"。

    從render函式中可以看出在template中使用ref變數無需使用.value，並不是編譯時就已經在程式碼中生成了.value，比如$setup.msg.value，而是透過Proxy的方式去實現的。

render函式

在render函式中讀和寫msg變數都變成了$setup.msg，而這個$setup物件又是呼叫render函式時傳入的第四個引數。現在我們需要搞清楚呼叫render函式時傳入的第四個引數到底是什麼？給render函式打一個斷點，重新整理頁面，此時程式碼走到了斷點裡面，如下圖：
render-debug

右邊的Call Stack表示當前函式的呼叫鏈，從呼叫鏈中可以看到render函式是由一個名為renderComponentRoot的函式呼叫的。

點選Call Stack中的renderComponentRoot，程式碼會跳轉到renderComponentRoot函式中，在我們這個場景中簡化後的renderComponentRoot函式程式碼如下：

function renderComponentRoot(instance) {
  const {
    props,
    data,
    setupState,
    render: render2,
    // 省略...
  } = instance;

  render2.call(
    thisProxy,
    proxyToUse,
    renderCache,
    props,
    setupState,
    data,
    ctx
  );
}

這裡的render2也就是我們的render函式，由於使用了.call，所以呼叫render函式時傳入的第四個引數為setupState物件。而setupState物件的值又是從instance.setupState而來的。

透過debug除錯render函式我們發現，在render函式中渲染msg變數是使用$setup.msg，而$setup物件的值是從instance.setupState物件上面來的。

前面講過了編譯後的setup方法會返回一個包含msg屬性的物件，而這個$setup物件也就是instance.setupState肯定是和setup方法返回的物件有關係的。所以接下來我們需要去debug除錯setup方法搞清楚他們到底是什麼關係。

setup方法

將render函式中的斷點去掉，然後給setup方法打一個斷點。重新整理頁面，此時程式碼會走到斷點中，如下圖：
setup-debug

同理在Call Stack中可以看到呼叫setup方法的是callWithErrorHandling函式，點選Call Stack中的callWithErrorHandling，程式碼會跳轉到callWithErrorHandling函式中。程式碼如下：

function callWithErrorHandling(fn, instance, type, args) {
  try {
    return args ? fn(...args) : fn();
  } catch (err) {
    handleError(err, instance, type);
  }
}

從上面可以看到在callWithErrorHandling函式中只是進行了錯誤處理，並不是我們想要找的。

setupStatefulComponent函式

從Call Stack中可以看到呼叫callWithErrorHandling函式的是setupStatefulComponent函式，點選Call Stack中的setupStatefulComponent，程式碼會跳轉到setupStatefulComponent函式中。在我們這個場景中簡化後的setupStatefulComponent函式程式碼如下：

function setupStatefulComponent(instance) {
  const Component = instance.type;
  const { setup } = Component;
  const setupResult = callWithErrorHandling(setup, instance);
  handleSetupResult(instance, setupResult);
}

從上面的程式碼可以看到確實是使用callWithErrorHandling函式執行了setup方法，並且還將setup方法的返回值物件賦值給了setupResult變數。然後以instance（vue例項）和setupResult（setup方法的返回值）為引數，呼叫了handleSetupResult函式。

handleSetupResult函式

將斷點走進handleSetupResult函式，在我們這個場景中簡化後的handleSetupResult函式程式碼如下：

function handleSetupResult(instance, setupResult) {
  instance.setupState = proxyRefs(setupResult);
}

我們在render函式中渲染msg變數是使用$setup.msg，而$setup物件的值是從instance.setupState物件上面來的。

現在我們已經找到了instance.setupState是在這裡賦值的，它的值是proxyRefs函式的返回結果。

proxyRefs函式

將斷點走進proxyRefs函式，程式碼如下：

function proxyRefs(objectWithRefs) {
  return isReactive(objectWithRefs)
    ? objectWithRefs
    : new Proxy(objectWithRefs, shallowUnwrapHandlers);
}

這個isReactive函式是vue暴露出來的一個API，它的作用是檢查一個物件是否是由 reactive() 或 shallowReactive() 建立的代理。

這裡的objectWithRefs物件就是setup方法的返回值物件，透過前面我們知道setup方法的返回值物件就是一個普通的js物件，並不是reactive的。所以proxyRefs函式會返回三目運算子冒號（:）後面的表示式，也就是使用Proxy建立的setup方法返回值物件代理。

我們接著來看shallowUnwrapHandlers裡面做了哪些事情，程式碼如下：

const shallowUnwrapHandlers = {
  get: (target, key, receiver) => unref(Reflect.get(target, key, receiver)),
  set: (target, key, value, receiver) => {
    const oldValue = target[key];
    if (isRef(oldValue) && !isRef(value)) {
      oldValue.value = value;
      return true;
    } else {
      return Reflect.set(target, key, value, receiver);
    }
  },
};

這個handler包含get和set方法，會對setup的返回值物件進行攔截。

當在render函式中渲染p標籤時會去讀$setup.msg，就會走到get的攔截中。在get方法中使用到了Reflect.get方法和unref函式。

  • Reflect.get(target, key, receiver)的作用是獲取target物件的key屬性，在我們這裡就是獲取setup返回值物件的msg屬性，也就是我們定義的msg變數。並且這個msg變數是一個ref。

  • 將Reflect.get方法拿到的msg變數傳給unref函式，這個unref函式同樣是暴露出來的一個API。如果引數是 ref，則返回內部值，否則返回引數本身。這是 val = isRef(val) ? val.value : val 計算的一個語法糖。

    經過unref函式的處理後，在get攔截中return的就是.value後的內容，也就是msg.value。

    所以在template中使用ref變數無需使用.value，是因為在Proxy的get攔截中已經幫我們自動處理了.value。
    當在render函式中去對ref變數進行賦值，比如：<button @click="msg = 'Hello Vue3'">change msg</button>。
    就會走到set攔截中，首先會執行const oldValue = target[key]。這裡的key就是"msg"，target就是setup函式返回值物件。使用oldValue就是msg變數，是一個ref。

由於我們在click事件中要將msg賦值成'Hello Vue3'字串，所以在set攔截中拿到的新value為'Hello Vue3'字串。

接著執行if (isRef(oldValue) && !isRef(value))判斷，這裡的oldValue前面已經講過了是一個名為msg的ref變數，所以isRef(oldValue) 為true。value為'Hello Vue3'字串，所以!isRef(value)也是為true。

程式碼就會走進if判斷中執行oldValue.value = value，也就是在執行msg.value = 'Hello Vue3'。

所以在template中給ref變數賦值無需使用.value，是因為在Proxy的set攔截中也幫我們自動處理了.value。

總結

整個流程圖如下：
full-progress

在vue3的template中使用ref變數無需使用.value，是因為有個Proxy的get攔截，在get攔截中會自動幫我們去取ref變數的.value屬性。

同樣的在template中對ref變數進行賦值也無需使用.value，也是有個Proxy的set攔截，在set攔截中會自動幫我們去給ref變數的.value屬性進行賦值。

關注公眾號：【前端歐陽】，給自己一個進階vue的機會

相關文章