Vue组件通信主要归为两类:
今天对vue组件通信方式进行下总结,如写的有不足之处还请大家不吝赐教。
1. props/$emit
props和$emit相信大家十分的熟悉了,这是我们最常用的vue通信方式。
props:props可以是数组或对象,用于接收来自父组件通过v-bind传递的数据。当props为数组时,直接接收父组件传递的属性;当 props 为对象时,可以通过type、default、required、validator等配置来设置属性的类型、默认值、是否必传和校验规则。
$emit
:在父子组件通信时,我们通常会使用$emit来触发父组件v-on在子组件上绑定相应事件的监听。
:msgFromParent="msg"
将父组件 msg 值传递给子组件,当父组件的 input 标签输入时,子组件p标签中的内容就会相应改变。@on-receive="receive"
在子组件上绑定了 receive 事件的监听,子组件 input 标签输入时,会触发 receive 回调函数, 通过this.$emit('on-receive', this.msg)
将子组件 msg 的值赋值给父组件 msgFromChild ,改变父组件p标签的内容。// 子组件A
这是子组件
收到来自父组件的消息:{{ msgFromParent }}
// 父组件
这是父组件
收到来自组件的消息:{{ msgFromChild }}
2. v-slot
v-slot是 Vue2.6 版本中新增的用于统一实现插槽和具名插槽的api,用于替代slot(2.6.0废弃)
、slot-scope(2.6.0废弃)
、scope(2.5.0废弃)
等api。
v-slot在 template 标签中用于提供具名插槽或需要接收 prop 的插槽,如果不指定 v-slot ,则取默认值 default
{{ msg }}
将父组件的 msg 值传递给子组件,子组件通过
接收到相应内容,实现了父向子传值。// 子组件A
这是子组件
收到来自父组件的消息:
// 父组件
这是父组件
{{ msg }}
3. $refs/$parent/$children/$root
我们也同样可以通过 $refs/$parent/$children/$root
等方式获取 Vue 组件实例,得到实例上绑定的属性及方法等,来实现组件之间的通信。
$refs: 我们通常会将 refs 绑定在子组件上,从而获取子组件实例。
$parent:我们可以在中直接通过parent`来获取当前组件的父组件实例(如果有的话)。
$children来获取当前组件的子组件实例的数组。但是需要注意的是,
this.$children`数组中的元素下标并不一定对用父组件引用的子组件的顺序,例如有异步加载的子组件,可能影响其在 children 数组中的顺序。所以使用时需要根据一定的条件例如子组件的name去找到相应的子组件。
$root: 获取当前组件树的根 Vue 实例。如果当前实例没有父实例,此实例将会是其自己。通过 $root ,我们可以实现组件之间的跨级通信。
下面来看一个 和children 使用的实例(由于这几个api的使用方式大同小异,所以关于 和root 的使用就不在这里展开了,在这个实例中实现了:
$parent.msg
获取到父组件中 msg 的值。$children
获取子组件实例的数组,在通过对数组进行遍历,通过实例的 name 获取到对应 ChildA 子组件实例将其赋值给 childA,然后通过childA.msg
获取到 ChildA 子组件的 msg。// 子组件A
这是子组件
收到来自父组件的消息:{{ $parent.msg }}
// 父组件
这是父组件
收到来自子组件的消息:{{ childA.msg }}
4.attrs/listener
attrs 和 listener 都是 Vue2.4 中新增加的属性,主要是用来供使用者用来开发高级组件的。
$attrs:
用来接收父作用域中不作为 prop 被识别的 attribute 属性,并且可以通过v-bind="$attrs"
传入内部组件——在创建高级别的组件时非常有用。
试想一下,当你创建了一个组件,你要接收 param1 、param2、param3 …… 等数十个参数,如果通过 props,那你需要通过props: ['param1', 'param2', 'param3', ……]
等声明一大堆。如果这些 props 还有一些需要往更深层次的子组件传递,那将会更加麻烦。
而使用 $attrs
,你不需要任何声明,直接通过$attrs.param1
、$attrs.param2
……就可以使用,而且向深层子组件传递上面也给了示例,十分方便。
$listeners
:包含了父作用域中的 v-on 事件监听器。它可以通过 v-on="$listeners"
传入内部组件——在创建更高层次的组件时非常有用,这里在传递时的使用方法和 $attrs 十分类似。
:msgFromA="msg"
将 msg 属性传递给2级组件B,2级组件B通过$attrs.msgFromA
获取到1级组件A的 msg。:msgFromA="msg"
将 msg属性传递给2级组件B,2级组件B再通过v-bind="$attrs"
将其传递给3级组件C,3级组件C通过$attrs.msgFromA
获取到1级组件A的 msg 。@keyup="receive"
在子孙组件上绑定keyup事件的监听,2级组件B在通过v-on="$listeners"
来将 keyup 事件绑定在其 input 标签上。当2级组件B input 输入框输入时,便会触发1级组件A的receive回调,将2级组件B的 input 输入框中的值赋值给1级组件A的 msgFromComp ,从而实现子向父传值。@keyup="receive"
在子孙组件上绑定keyup事件的监听,2级组件B在通过
将其继续传递给C。3级组件C在通过v-on="$listeners"
来将 keyup 事件绑定在其 input 标签上。当3级组件C input 输入框输入时,便会触发1级组件A的receive回调,将3级组件C的 input 输入框中的值赋值给1级组件A的 msgFromComp ,从而实现跨级向上传值。// 3级 子组件C
这是子组件C
收到来自A组件的消息:{{ $attrs.msgFromA }}
// 2级 子组件B
这是子组件B
收到来自A组件的消息:{{ $attrs.msgFromA }}
// 子组件A
这是子组件A
收到来自{{ comp }}的消息:{{msgFromComp }}
5.provide/inject
provide/inject这对选项需要一起使用,以允许一个祖先组件向其所有子孙后代注入一个依赖,不论组件层次有多深,并在其上下游关系成立的时间里始终生效。
provide: 是一个对象,或者是一个返回对象的函数。该对象包含可注入其子孙的 property ,即要传递给子孙的属性和属性值。
injcet: 一个字符串数组,或者是一个对象。当其为字符串数组时,使用方式和props十分相似,只不过接收的属性由data变成了provide中的属性。当其为对象时,也和props类似,可以通过配置default和from等属性来设置默认值,在子组件中使用新的命名属性等。
这个实例中有三个组件,1级组件A,2级组件B,3级组件C:[ A [ B [C] ] ],A是B的父组件,B是C的父组件。实例中实现了:
inject: ['msgFromA']
来接收1级组件A中的msg,并通过msgFromA.content
获取1级组件A中 msg 的content属性值。inject: ['msgFromA']
来接收1级组件A中的msg,并通过msgFromA.content
获取1级组件A中msg的content属性值,实现跨级向下传值。// 1级组件A
这是组件A
// 2级组件B
这是组件B
收到来自A组件的消息:{{ msgFromA && msgFromA.content }}
// 3级组件C
这是组件C
收到来自A组件的消息:{{ msgFromA && msgFromA.content }}
注意点:
6. eventBus
eventBus又称事件总线,通过注册一个新的Vue实例,通过调用这个实例的和on等来监听和触发这个实例的事件,通过传入参数从而实现组件的全局通信。它是一个不具备 DOM 的组件,有的仅仅只是它实例方法而已,因此非常的轻便。
我们可以通过在全局Vue实例上注册:
// main.js
Vue.prototype.$Bus = new Vue()
但是当项目过大时,我们最好将事件总线抽象为单个文件,将其导入到需要使用的每个组件文件中。这样,它不会污染全局命名空间:
// bus.js,使用时通过import引入
import Vue from 'vue'
export const Bus = new Vue()
eventBus的原理其实比较简单,就是使用订阅-发布模式,实现 emit 和 on 两个方法即可:
// eventBus原理
export default class Bus {
constructor() {
this.callbacks = {}
}
$on(event, fn) {
this.callbacks[event] = this.callbacks[event] || []
this.callbacks[event].push(fn)
}
$emit(event, args) {
this.callbacks[event].forEach((fn) => {
fn(args)
})
}
}
// 在main.js中引入以下
// Vue.prototype.$bus = new Bus()
在这个实例中,共包含了4个组件:[ A [ B [ C、D ] ] ],1级组件A,2级组件B,3级组件C和3级组件D。我们通过使用eventBus实现了:
this.$bus.$emit('sendMsg', obj)
触发sendMsg事件回调,将sender和msg封装成对象作为参数传入;同时通过this.$bus.$on('sendMsg', obj)
监听其他组件的sendMsg事件,实例当前组件示例sender和msg的值。这样任一组件input输入框值改变时,其他组件都能接收到相应的信息,实现全局通信。// main.js
Vue.prototype.$bus = new Vue()
// 1级组件A
这是组件A
收到{{ sender }}的消息:{{ msgFromBus }}
// 2级组件B
这是组件B
收到{{ sender }}的消息:{{ msgFromBus }}
// 3级组件C
这是组件C
收到{{ sender }}的消息:{{ msgFromBus }}
// 3级组件D
这是组件D
收到{{ sender }}的消息:{{ msgFromBus }}
7. Vuex
当项目庞大以后,在多人维护同一个项目时,如果使用事件总线进行全局通信,容易让全局的变量的变化难以预测。于是有了Vuex的诞生。
Vuex 是一个专为 Vue.js 应用程序开发的状态管理模式。它采用集中式存储管理应用的所有组件的状态,并以相应的规则保证状态以一种可预测的方式发生变化。
有关Vuex的内容,可以参考Vuex官方文档,我就不在这里班门弄斧了,直接看代码。
Vuex的实例和事件总线类似,同样是包含了4个组件:[ A [ B [ C、D ] ] ],1级组件A,2级组件B,3级组件C和3级组件D。我们在这个实例中实现了:
全局通信:代码的内容和eventBus也类似,不过要比eventBus使用方便很多。每个组件通过watch监听input输入框的变化,把input的值通过vuex的commit触发mutations,从而改变store的值。然后每个组件都通过computed动态获取store中的数据,从而实现全局通信。
// store.js
import Vue from 'vue'
import Vuex from 'vuex'
Vue.use(Vuex)
export default new Vuex.Store({
state: {
msg: {
sender: '',
content: '',
},
},
mutations: {
sendMsg(state, obj) {
state.msg = {
sender: obj.sender,
content: obj.content,
}
},
},
})
// 组件A
这是组件A
收到{{ sender }}的消息:{{ msgFromStore }}
同样和eventBus中一样,B,C,D组件中的代码除了引入子组件的不同,script部分都是一样的,就不再往上写了。
总结
上面总共提到了7种Vue的组件通信方式,他们能够进行的通信种类如下图所示: