前端进阶之旅前端进阶之旅
基础篇
进阶篇
高频篇
精选篇
手写篇
面经篇
AI 篇
原理篇
每日一题
小程序题库
知识卡片
  • 场景篇按分类整理的大前端场景考点
  • 历年面经按年份追踪真实考点
  • 算法题库NEW在线编码即时判题
  • 专项自测100 题快速查漏
  • 前端基础
    • HTTP从报文一路讲到 HTTPS
    • 浏览器渲染、事件循环、进程
    • 计算机基础Linux、网络、操作系统
  • 进阶专项
    • 设计模式23 种模式怎么用
    • 前端系统进阶学习大型项目工程化
    • 前端综合文章长期沉淀的实践文
  • 工程与工具
    • Node学习指南从环境搭建到服务端
    • NPM工作流script、依赖与发布
    • Docker容器化部署上手
    • Canvas图形与动画实战
  • 路线与导图
    • 思维导图知识点全景图
    • 学习路线按图索骥不跑偏
  • 动态
    • 公众号动态公众号历史文章
    • 博客动态站长的技术博客
    • 开发者导航常用工具与文档站
  • AI 助手随时提问,即时解析
  • AI 模拟面试模拟真实面试 + 报告
  • AI 知识地图串起全站知识点
  • AI 定制路线按你的简历现排
AI 热点
旧版
基础篇
进阶篇
高频篇
精选篇
手写篇
面经篇
AI 篇
原理篇
每日一题
小程序题库
知识卡片
  • 场景篇按分类整理的大前端场景考点
  • 历年面经按年份追踪真实考点
  • 算法题库NEW在线编码即时判题
  • 专项自测100 题快速查漏
  • 前端基础
    • HTTP从报文一路讲到 HTTPS
    • 浏览器渲染、事件循环、进程
    • 计算机基础Linux、网络、操作系统
  • 进阶专项
    • 设计模式23 种模式怎么用
    • 前端系统进阶学习大型项目工程化
    • 前端综合文章长期沉淀的实践文
  • 工程与工具
    • Node学习指南从环境搭建到服务端
    • NPM工作流script、依赖与发布
    • Docker容器化部署上手
    • Canvas图形与动画实战
  • 路线与导图
    • 思维导图知识点全景图
    • 学习路线按图索骥不跑偏
  • 动态
    • 公众号动态公众号历史文章
    • 博客动态站长的技术博客
    • 开发者导航常用工具与文档站
  • AI 助手随时提问,即时解析
  • AI 模拟面试模拟真实面试 + 报告
  • AI 知识地图串起全站知识点
  • AI 定制路线按你的简历现排
AI 热点
旧版

Vue 实例属性与实例方法完全指南(十三)

首页2018-08-28 16:04:43Front-End
VueVue 实例nextTick

写 Vue 的人早晚会遇到这两个场景。一个是在 created 钩子里写 this.$refs.chart.init(),控制台直接报 Cannot read property 'init' of undefined;另一个是刚把 this.list 赋了新值,下一行马上去读 this.$el.querySelectorAll('li').length,拿到的还是旧的条数。这两个问题看着不搭边,根子却是同一个,就是你不知道 Vue 实例上那一堆带 $ 的东西各自在什么时刻才可用。这篇把实例属性和实例方法按「组件树、DOM、数据、事件」四类过一遍,说清每个的用途、可用时机和踩坑点,顺带把 2018 年那会儿文档里还留着的一批 Vue 1.x 遗留 API 挑出来单独标注。

在本篇文章中,我们将从浅入深,和大家一起学习以下知识:

  • $ 前缀到底是干什么用的,为什么 Vue 要把它和 data 分开
  • 组件树相关的 $parent、$root、$children、$refs,以及为什么不建议用前三个
  • $el 和 $data、$options 分别在什么时候可用
  • 事件方法 $on、$once、$emit、$off,以及已经消失的 $dispatch 和 $broadcast
  • $watch 的返回值和两个关键配置项
  • $nextTick 解决的到底是什么问题,什么时候必须用
  • 这些 API 在 Vue 3 里的存亡情况

# 一、$ 前缀是一条边界线

Vue 实例属性总览

Vue 实例暴露了一批有用的属性和方法,它们都带 $ 前缀,为的是和你自己写在 data 里的数据属性区分开。

这个设计不是为了好看。Vue 2 在初始化的时候会把 data 里的每个 key 代理到实例上,所以你写 this.message 实际访问的是 this._data.message。如果框架自己的属性不加前缀,你在 data 里定义一个叫 el 或者 options 的字段,就会直接把框架的东西盖掉。加了 $ 之后,两套命名空间互不打扰。

顺着这个说一句,Vue 保留的还不止 $,下划线 _ 开头的也是内部占用的,_data、_uid、_watchers 这些你能在实例上打印出来,但不要去动。真在 data 里写了 _foo,Vue 会拒绝代理它,你在模板里写 _foo 是取不到值的,得写 $data._foo。这一条很多人不知道,写下划线前缀的临时变量时会突然发现模板渲染不出来。

# 二、组件树上的四个属性

这一组用来在组件之间横向或纵向跳转。

  • $parent:访问组件实例的父实例
  • $root:访问当前组件树的根实例
  • $children:访问当前组件实例的直接子组件实例
  • $refs:访问模板里打了 ref 标记的子组件或 DOM 元素

先说结论,这四个里面只有 $refs 值得日常使用,另外三个能不用就不用。

$parent 和 $root 的问题在于把组件和它所处的位置绑死了。一个按钮组件里写了 this.$parent.submit(),那这个按钮就只能放在有 submit 方法的那个父组件里,换个地方就崩。组件之间要通信,往下用 props、往上用 $emit,跨层级的走状态管理,这条边界最好不要越。

$children 更麻烦一点,它返回的数组顺序不保证和你模板里的书写顺序一致,而且不包含通过 v-if 暂时没渲染的那些。想按顺序拿第几个子组件,写 this.$children[0] 迟早会翻车。

$refs 是这里面最实用的。有一点必须记住,$refs 只在组件渲染完成之后才被填充,而且它不是响应式的。

这就回到开头那个 created 里报 undefined 的问题。created 触发时组件的 render 函数还没跑,DOM 和子组件实例都不存在,this.$refs 是个空对象。要拿 ref,最早只能在 mounted 里。关于每个生命周期钩子分别在什么时候触发、里面能干什么,我在 Vue 生命周期 那篇里按顺序拆过一遍。

顺带提一句 v-ref。2018 年不少中文教程还写着「用 v-ref 指令标记子组件」,那是 Vue 1.x 的写法,Vue 2 已经把它降级成普通的 ref 特性了,写 ref="chart" 就行,不带 v-。

# 三、DOM 访问

  • $el:当前组件实例挂载的根 DOM 元素
  • $els:Vue 1.x 里用来访问 v-el 标记的 DOM 元素

$el 是最直观的一个,拿到它就等于拿到了这个组件在页面上的那个根节点:

<div id="app2">
    {{ message }}
</div>
<script>
    var vm2 = new Vue({
        el: "#app2",
        data: {
            message: "I am message."
        }
    });
    console.log(vm2.$el);          // vm2.$el 就是原生 js 里的 document.getElementById("app2")
    vm2.$el.style.color = "red";   // 变成红色
</script>
@前端进阶之旅: 代码已经复制到剪贴板

这段在演示的事情很简单,用 $el 直接拿到根元素然后改样式。能跑通,但真要在业务里这么写,得想清楚一件事,你手动改的这些 DOM 属性,在下一次 Vue 重新渲染这个节点时是有可能被覆盖掉的。所以 $el 的合理用途是那些 Vue 管不到的东西,比如量一下元素宽高、给它挂个第三方图表库、调 scrollIntoView。改样式和改内容还是交给 :style、:class 和模板。

上面列表里的 $els 要单独说一下。它和 v-el 指令一样,都是 Vue 1.x 的产物,Vue 2 里已经没有了。Vue 2 把 v-el 和 v-ref 合并成了统一的 ref,普通元素上的 ref 拿到的是 DOM 节点,组件上的 ref 拿到的是组件实例。原文这份清单是从早期资料抄下来的,这里保留原始条目,但要明确一句,$els 在 Vue 2 及之后的版本里不存在,别照着写。

# 四、数据访问

  • $data:组件实例观察的数据对象
  • $options:组件实例化时的初始化选项对象

$data 就是你写的那个 data 对象本身。用 new Vue() 并且传了一个外部对象进去时,vm.$data === data 是成立的,Vue 直接在原对象上做响应式改造,不会复制一份。这点在调试时挺有用,你在控制台改外部那个 data 对象,视图一样会更新。

$options 存的是初始化选项的合并结果,包括 el、data、methods,也包括你自己塞进去的自定义选项。有个常用小技巧是重置表单,Object.assign(this.$data, this.$options.data()) 可以把组件数据一把还原成初始值,不用一个个字段手写。注意组件里的 data 是函数,所以要加括号调用;根实例上如果 data 传的是对象,这招就不适用。

# 五、DOM 操作方法

原始资料里列了这么几个:

  • $appendTo(elementOrSelector, callback):将 el 所指的 DOM 元素插入目标元素
  • $before(elementOrSelector, callback):将 el 所指的 DOM 元素或片段插入目标元素之前
  • $after(elementOrSelector, callback):将 el 所指的 DOM 元素或片段插入目标元素之后
  • $remove(callback):将 el 所指的 DOM 元素或片段从 DOM 中删除
  • $nextTick(callback):在下一次 DOM 更新循环后执行指定的回调函数

这里有个坑要注意。前四个全是 Vue 1.x 的实例方法,Vue 2 重写渲染层引入虚拟 DOM 之后就把它们去掉了,只有 $nextTick 活了下来。原因不难理解,虚拟 DOM 的前提是「真实 DOM 的结构由 render 结果推导出来」,你在外面手动 append、remove,下一次 patch 就对不上了。

Vue 2 里想达到同样效果,思路是换成声明式的。要挂到别的容器里就自己 document.querySelector('#target').appendChild(vm.$el) 之后调 $mount();要卸载就调 vm.$destroy() 再手动移除 vm.$el。这些写法我只在弹窗、全局 toast 这类需要脱离父容器的组件里用过,普通业务组件没必要。

# 六、事件方法

这一组是 Vue 2 里实例通信的基础设施。

监听

  • $on(event, callback):监听实例的自定义事件
  • $once(event, callback):同上,但只触发一次

触发

  • $emit(event, args):在当前实例上触发事件
  • $dispatch(event, args):派发事件,先在当前实例触发,再沿父链一层层向上,对应的监听函数返回 false 就停止
  • $broadcast(event, args):广播事件,遍历当前实例的 $children 向下传播,对应的监听函数返回 false 就停止

同样得先纠一处。$dispatch 和 $broadcast 也是 Vue 1.x 的东西,Vue 2 把它们移除了,官方迁移指南给的替代方案就是集中式的状态管理或者一个独立的事件中心。这两个 API 被砍掉的理由写得很直白,基于组件树的事件冒泡和广播会让数据流向变得难以追踪,组件结构一调整,事件就断了。

留在 Vue 2 里能用的是 $on、$once、$emit、$off 这四个:

<div id="ap2">
    <p>{{ num }}</p>
    <button @click="increase1"> add </button>
</div>
<button onclick="reduce2()"> reduce2 </button> <button onclick="offReduce()"> off reduce </button>
<script>
    var ap2 = new Vue({
        el: "#ap2",
        data: {
            num: 5
        },
        methods: {
            increase1: function () {
                this.num++;
            }
        }
    });
    // $on 定义事件,$once 定义只触发一次的事件
    ap2.$on("reduce", function (diff) {
        ap2.num -= diff;
    });

    // $emit 触发事件
    function reduce2() {
        ap2.$emit("reduce", 2);
    }

    // $off 解除事件,解除后定义的 reduce 事件将不再执行
    function offReduce() {
        ap2.$off("reduce");
    }
</script>
@前端进阶之旅: 代码已经复制到剪贴板

这段代码在演示一件事,Vue 实例本身就是一个事件中心,你可以在外部往它身上挂监听器,再从任意地方触发。页面上两个原生 button 故意写在 #ap2 外面,就是为了说明触发方和 Vue 的模板没有关系。

正是这个特性催生了当年最流行的跨组件通信方案,也就是事件总线。做法是 var bus = new Vue(),然后一个组件 bus.$on 订阅,另一个组件 bus.$emit 发布,绕开了组件树的层级限制。

fe
  • 一、$ 前缀是一条边界线
  • 二、组件树上的四个属性
  • 三、DOM 访问
  • 四、数据访问
  • 五、DOM 操作方法
  • 六、事件方法
  • 七、$watch
  • 八、$nextTick 到底在解决什么
  • 九、这些 API 在 Vue 3 里还剩多少
  • 总结
  • 参考

← Vue 项目开发中的十个痛点与解法(十四)vue-axios封装请求实战 拦截器与错误统一处理(十二) →