Vue 学习笔记(十六):可复用性 & 组合:混入

可复用性 & 组合:混入
Reusability & Composition: Mixins

基础 Basics

混入 (mixin) 提供了一种非常灵活的方式,来分发 Vue 组件中的可复用功能。一个混入对象可以包含任意组件选项。当组件使用混入对象时,所有混入对象的选项将被“混合”进入该组件本身的选项。

例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// 定义一个混入对象
var myMixin = {
created: function () {
this.hello()
},
methods: {
hello: function () {
console.log('hello from mixin!')
}
}
}
// 定义一个使用混入对象的组件
var Component = Vue.extend({
mixins: [myMixin]
})
var component = new Component() // => "hello from mixin!"

选项合并 Option Merging

当组件和混入对象含有同名选项时,这些选项将以恰当的方式进行“合并”。

比如,数据对象在内部会进行递归合并,并在发生冲突时以组件数据优先。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
var mixin = {
data: function () {
return {
message: 'hello', // 冲突了,被覆盖
foo: 'abc' // 不冲突,自动合并
}
}
}
new Vue({
mixins: [mixin],
data: function () {
return {
message: 'goodbye', // 冲突了,以此优先
bar: 'def' // 不冲突,自动合并
}
},
created: function () {
console.log(this.$data)
// => { message: "goodbye", foo: "abc", bar: "def" }
}
})

同名钩子函数将合并为一个数组,都会被调用。
混入对象的钩子将在组件自身钩子之前调用。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
var mixin = {
created: function () {
console.log('混入对象的钩子被调用') // 混入对象先调用
}
}
new Vue({
mixins: [mixin],
created: function () {
console.log('组件钩子被调用') // 晚于混入对象调用
}
})
// => "混入对象的钩子被调用"
// => "组件钩子被调用"

值为对象的选项,例如 methodscomponentsdirectives,将被合并为同一个对象。
两个对象键名冲突时,取组件对象的键值对。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
var mixin = {
methods: {
foo: function () { // 键名不冲突,合并
console.log('foo')
},
conflicting: function () { // 键名冲突,被组件覆盖
console.log('from mixin')
}
}
}
var vm = new Vue({
mixins: [mixin],
methods: {
bar: function () { // 键名不冲突,合并
console.log('bar')
},
conflicting: function () { // 键名冲突,以此优先
console.log('from self')
}
}
})
vm.foo() // => "foo"
vm.bar() // => "bar"
vm.conflicting() // => "from self"

Vue.extend() 也使用同样的策略进行合并。

全局混入 Global Mixin

混入也可以进行全局注册。慎重使用,一旦使用全局混入,它将影响每一个之后创建的 Vue 实例。使用恰当时,这可以用来为自定义选项注入处理逻辑。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 为自定义的选项 'myOption' 注入一个处理器。
Vue.mixin({
created: function () {
var myOption = this.$options.myOption
if (myOption) {
console.log(myOption)
}
}
})
new Vue({
myOption: 'hello!'
})
// => "hello!"

谨慎使用全局混入,它会影响每个单独创建的 Vue 实例 (包括第三方组件)。大多数情况下,只应当应用于自定义选项,如上例。推荐将其作为插件发布,以避免重复应用混入。

自定义选项合并策略 Custom Option Merge Strategies

自定义选项将使用默认策略,即简单地覆盖已有值。如果想自定义选项以自定义逻辑合并,可以向 Vue.config.optionMergeStrategies 添加一个函数:

1
2
3
Vue.config.optionMergeStrategies.myOption = function (toVal, fromVal) {
// 返回合并后的值
}

对于多数值为对象的选项,可以使用与 methods 相同的合并策略:

1
2
var strategies = Vue.config.optionMergeStrategies
strategies.myOption = strategies.methods

一个更高级的例子:

1
2
3
4
5
6
7
8
9
10
const merge = Vue.config.optionMergeStrategies.computed
Vue.config.optionMergeStrategies.vuex = function (toVal, fromVal) {
if (!toVal) return fromVal
if (!fromVal) return toVal
return {
getters: merge(toVal.getters, fromVal.getters),
state: merge(toVal.state, fromVal.state),
actions: merge(toVal.actions, fromVal.actions)
}
}

混入就是用来对vue组件中的公共部分,包括数据对象、钩子函数、方法等所有选项,进行提取封装,以达到代码的复用。