混入

基础

对于 Vue 组件来说，混入（mixins）是一种灵活分发可复用性功能的方式。一个混入对象可以包含任意组件选项（options）。当组件使用混入对象时，所有混入对象的选项将被“混进”该组件本身的选项中。

例子：

// 定义一个 mixin 对象
const myMixin = {
  created() {
    this.hello()
  },
  methods: {
    hello() {
      console.log('hello from mixin!')
    }
  }
}

// 定义一个使用了该 mixin 的应用
const app = Vue.createApp({
  mixins: [myMixin]
})

app.mount('#mixins-basic') // => "hello from mixin!"

选项合并

当混入对象和组件本身含有重复选项时，这些选项将以合适的策略进行“合并”。

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

const myMixin = {
  data() {
    return {
      message: 'hello',
      foo: 'abc'
    }
  }
}

const app = Vue.createApp({
  mixins: [myMixin],
  data() {
    return {
      message: 'goodbye',
      bar: 'def'
    }
  },
  created() {
    console.log(this.$data) // => { message: "goodbye", foo: "abc", bar: "def" }
  }
})

同名钩子函数将合并进一个数组里，以便它们都能被调用。另外，混入对象的钩子函数会在组件自身钩子函数之前被调用。

const myMixin = {
  created() {
    console.log('mixin hook called')
  }
}

const app = Vue.createApp({
  mixins: [myMixin],
  created() {
    console.log('component hook called')
  }
})

// => "mixin hook called"
// => "component hook called"

值为对象的选项，例如 methods、components 和 directives，将被合并为同一个对象。两个对象键名冲突时，取组件对象的键值对。

const myMixin = {
  methods: {
    foo() {
      console.log('foo')
    },
    conflicting() {
      console.log('from mixin')
    }
  }
}

const app = Vue.createApp({
  mixins: [myMixin],
  methods: {
    bar() {
      console.log('bar')
    },
    conflicting() {
      console.log('from self')
    }
  }
})

const vm = app.mount('#mixins-basic')

vm.foo() // => "foo"
vm.bar() // => "bar"
vm.conflicting() // => "from self"

全局混入

你还可以为 Vue 应用申请一个全局 mixin：

const app = Vue.createApp({
  myOption: 'hello!'
})

// 为自定义的选项 'myOption' 注入一个处理器。
app.mixin({
  created() {
    const myOption = this.$options.myOption
    if (myOption) {
      console.log(myOption)
    }
  }
})

app.mount('#mixins-global') // => "hello!"

请格外注意！一旦使用全局混入，它将影响每一个之后在应用内部创建的组件实例 (例如，每个子组件)。

const app = Vue.createApp({
  myOption: 'hello!'
})

// 为自定义的选项 'myOption' 注入一个处理器。
app.mixin({
  created() {
    const myOption = this.$options.myOption
    if (myOption) {
      console.log(myOption)
    }
  }
})

// 将 myOption 也添加到子组件
app.component('test-component', {
  myOption: 'hello from component!'
})

app.mount('#mixins-global')

// => "hello!"
// => "hello from component!"

大多数情况下，你应该就像上述实例中一样只在自定义选项处理中使用混入。将这个准则作为插件发布，以避免重复的应用混入也是一个好方法。

自定义选项合并策略

当自定义选项做合并时，它们使用的是简单重写已有值的策略。如果想让自定义选项以自定义逻辑合并，你需要向 app.config.optionMergeStrategies 添加一个函数：

const app = Vue.createApp({})

app.config.optionMergeStrategies.customOption = (toVal, fromVal) => {
  // 返回合并后的值
}

合并策略接收到父实例和子实例上定义的选项值，分别作为第一个和第二个参数传入。让我们来检查一下使用 mixin 时，这些参数是什么：

const app = Vue.createApp({
  custom: 'hello!'
})

app.config.optionMergeStrategies.custom = (toVal, fromVal) => {
  console.log(fromVal, toVal)
  // => "goodbye!", undefined
  // => "hello", "goodbye!"
  return fromVal || toVal
}

app.mixin({
  custom: 'goodbye!',
  created() {
    console.log(this.$options.custom) // => "hello!"
  }
})

如你所见，在控制台中，我们打印的是先从 mixin 得到的 toVal 和 fromVal，然后是 app 。如果存在，我们总是返回 fromVal，这就是为什么 this.$options.custom 最后被设置为 hello 。让我们尝试将策略更改为始终从子实例返回值：

const app = Vue.createApp({
  custom: 'hello!'
})

app.config.optionMergeStrategies.custom = (toVal, fromVal) => toVal || fromVal

app.mixin({
  custom: 'goodbye!',
  created() {
    console.log(this.$options.custom) // => "goodbye!"
  }
})

在 Vue 2 中，mixin 是将部分组件逻辑抽象成可重用块的主要工具。但是，他们有几个问题：

mixin 很容易发生冲突：因为每个特性的属性都被合并到同一个组件中，所以为了避免 property 名冲突和便于调试，你仍然需要了解其他每个特性。
可重用的局限性：我们不能向 mixin 传递任何参数来改变它的逻辑，这降低了它们在抽象逻辑方面的灵活性

为了解决这些问题，我们添加了一种通过逻辑关注点组织代码的新方法：Composition API。

笔者知乎同步文档：Vue3 文档阅读 —— Mixins 混入