混入

基础

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

例子:

  1. // define a mixin object
  2. const myMixin = {
  3. created() {
  4. this.hello()
  5. },
  6. methods: {
  7. hello() {
  8. console.log('hello from mixin!')
  9. }
  10. }
  11. }
  12. // define an app that uses this mixin
  13. const app = Vue.createApp({
  14. mixins: [myMixin]
  15. })
  16. app.mount('#mixins-basic') // => "hello from mixin!"

选项合并

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

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

  1. const myMixin = {
  2. data() {
  3. return {
  4. message: 'hello',
  5. foo: 'abc'
  6. }
  7. }
  8. }
  9. const app = Vue.createApp({
  10. mixins: [myMixin],
  11. data() {
  12. return {
  13. message: 'goodbye',
  14. bar: 'def'
  15. }
  16. },
  17. created() {
  18. console.log(this.$data) // => { message: "goodbye", foo: "abc", bar: "def" }
  19. }
  20. })

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

  1. const myMixin = {
  2. created() {
  3. console.log('mixin hook called')
  4. }
  5. }
  6. const app = Vue.createApp({
  7. mixins: [myMixin],
  8. created() {
  9. console.log('component hook called')
  10. }
  11. })
  12. // => "混入对象的钩子被调用"
  13. // => "组件钩子被调用"

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

  1. const myMixin = {
  2. methods: {
  3. foo() {
  4. console.log('foo')
  5. },
  6. conflicting() {
  7. console.log('from mixin')
  8. }
  9. }
  10. }
  11. const app = Vue.createApp({
  12. mixins: [myMixin],
  13. methods: {
  14. bar() {
  15. console.log('bar')
  16. },
  17. conflicting() {
  18. console.log('from self')
  19. }
  20. }
  21. })
  22. const vm = app.mount('#mixins-basic')
  23. vm.foo() // => "foo"
  24. vm.bar() // => "bar"
  25. vm.conflicting() // => "from self"

全局混入

你还可以为 Vue 应用程序全局应用 mixin:

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

混入也可以进行全局注册。使用时格外小心!一旦使用全局混入,它将影响每一个之后创建的组件 (例如,每个子组件)。

  1. const app = Vue.createApp({
  2. myOption: 'hello!'
  3. })
  4. // 为自定义的选项 'myOption' 注入一个处理器。
  5. app.mixin({
  6. created() {
  7. const myOption = this.$options.myOption
  8. if (myOption) {
  9. console.log(myOption)
  10. }
  11. }
  12. })
  13. // 将myOption也添加到子组件
  14. app.component('test-component', {
  15. myOption: 'hello from component!'
  16. })
  17. app.mount('#mixins-global')
  18. // => "hello!"
  19. // => "hello from component!"

大多数情况下,只应当应用于自定义选项,就像上面示例一样。推荐将其作为插件发布,以避免重复应用混入。

自定义选项合并策略

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

  1. const app = Vue.createApp({})
  2. app.config.optionMergeStrategies.customOption = (toVal, fromVal) => {
  3. // return mergedVal
  4. }

合并策略接收在父实例和子实例上定义的该选项的值,分别作为第一个和第二个参数。让我们来检查一下使用 mixin 时,这些参数有哪些:

  1. const app = Vue.createApp({
  2. custom: 'hello!'
  3. })
  4. app.config.optionMergeStrategies.custom = (toVal, fromVal) => {
  5. console.log(fromVal, toVal)
  6. // => "goodbye!", undefined
  7. // => "hello", "goodbye!"
  8. return fromVal || toVal
  9. }
  10. app.mixin({
  11. custom: 'goodbye!',
  12. created() {
  13. console.log(this.$options.custom) // => "hello!"
  14. }
  15. })

如你所见,在控制台中,我们先从 mixin 打印 toValfromVal,然后从 app 打印。如果存在,我们总是返回 fromVal,这就是为什么 this.$options.custom 设置为 你好! 最后。让我们尝试将策略更改为始终从子实例返回值:

  1. const app = Vue.createApp({
  2. custom: 'hello!'
  3. })
  4. app.config.optionMergeStrategies.custom = (toVal, fromVal) => toVal || fromVal
  5. app.mixin({
  6. custom: 'goodbye!',
  7. created() {
  8. console.log(this.$options.custom) // => "goodbye!"
  9. }
  10. })

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

  • mixin 很容易发生冲突:因为每个特性的属性都被合并到同一个组件中,所以为了避免 property 名冲突和调试,你仍然需要了解其他每个特性。

  • 可重用性是有限的:我们不能向 mixin 传递任何参数来改变它的逻辑,这降低了它们在抽象逻辑方面的灵活性

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