vue3中template使用ref无需.value原因解析_Vue.js

前言

众所周知，vue3的template中使用ref变量无需使用.value。还可以在事件处理器中进行赋值操作时，无需使用.value就可以直接修改ref变量的值，比如：<button @click="msg = 'hello vue3'">change msg</button>。你猜vue是在编译时就已经在代码中生成了.value，还是运行时使用proxy拦截的方式去实现的呢？注：本文中使用的vue版本为3.4.19。

看个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函数打一个断点，刷新页面，此时代码走到了断点里面，如下图：

右边的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方法打一个断点。刷新页面，此时代码会走到断点中，如下图：

同理在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。