VueJS mixins (混入)



  • 定义和用法

    混入 (mixins) 提供了一种非常灵活的方式,来分发 Vue 组件中的可复用功能。一个混入对象可以包含任意组件选项。当组件使用混入对象时,所有混入对象的选项将被 “混合” 进入该组件本身的选项。
    下面示例演示了混入一个对象:
    // 定义一个混入对象
    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!"
    
  • 选项合并

    当组件和混入对象含有同名选项时,这些选项将以恰当的方式进行“合并”。
    比如,数据对象在内部会进行递归合并,并在发生冲突时以组件数据优先。
    <div id="app">
       <h1 id="arr"></h1>
    </div>
    <script>
      var mixin = {
          data: function () {
             return {
                message: 'hello',
                foo: 'abc'
             }
          }
       }
       new Vue({
          el: "#app",
          mixins: [mixin],
          data: function () {
             return {
                message: 'goodbye',
                bar: 'def'
             }
          },
          created: function () {
             document.getElementById("arr").innerHTML = this.$data.foo;
             // => { foo: "abc" }
          }
       });
    </script>
    
    同名钩子函数将合并为一个数组,因此都将被调用。另外,混入对象的钩子将在组件自身钩子之前调用。
    var mixin = {
       created: function () {
          console.log('混入对象的钩子被调用')
       }
    }
       
    new Vue({
       mixins: [mixin],
       created: function () {
          console.log('组件钩子被调用')
       }
    })
       
    // => "混入对象的钩子被调用"
    // => "组件钩子被调用"
    
    值为对象的选项,例如 methodscomponentsdirectives,将被合并为同一个对象。两个对象键名冲突时,取组件对象的键值对。
    <div id="app2">
       <div id="fn1"></div>
       <div id="fn2"></div>
       <div id="fn3"></div>
       <div id="fn4"></div>
    </div>
    <script>
       var mixin = {
          methods: {
             foo: function () {
                document.getElementById("fn1").innerHTML="foo"
             },
             conflicting: function () {
                document.getElementById("fn2").innerHTML="from mixin"
             }
          }
       }
          
       var vm = new Vue({
          el: "#app2"
          mixins: [mixin],
          methods: {
             bar: function () {
                document.getElementById("fn3").innerHTML="bar"
             },
             conflicting: function () {
                document.getElementById("fn4").innerHTML="from self"
             }
          }
       });
       vm.foo() // => "foo"
       vm.bar() // => "bar"
       vm.conflicting() // => "from self"
    </script>
    
    注意:Vue.extend() 也使用同样的策略进行合并。
  • 全局混入

    混入也可以进行全局注册。使用时格外小心!一旦使用全局混入,它将影响每一个之后创建的 Vue 实例。使用恰当时,这可以用来为自定义选项注入处理逻辑。
    // 为自定义的选项 'myOption' 注入一个处理器。
    Vue.mixin({
       created: function () {
          var myOption = this.$options.myOption
          if (myOption) {
            console.log(myOption)
          }
       }
    })
    
    new Vue({
       myOption: 'hello!'
    })
    // => "hello!"
    
    请谨慎使用全局混入,因为它会影响每个单独创建的 Vue 实例 (包括第三方组件)。大多数情况下,只应当应用于自定义选项,就像上面示例一样。推荐将其作为插件发布,以避免重复应用混入。
  • 自定义选项合并策略

    自定义选项将使用默认策略,即简单地覆盖已有值。如果想让自定义选项以自定义逻辑合并,可以向 Vue.config.optionMergeStrategies 添加一个函数:
    Vue.config.optionMergeStrategies.myOption = function (toVal, fromVal) {
      // 返回合并后的值
    }
    
    对于多数值为对象的选项,可以使用与 methods 相同的合并策略:
    var strategies = Vue.config.optionMergeStrategies
    strategies.myOption = strategies.methods