什么是Mixin?
想要使用一个事物或者工具,我们首要先了解它是什么,这样我们才好对症下药。
其实Mixin
不是Vue
专属的,可以说它是一种思想
,也可以说它就是混入
的意思,在很多开发框架中都实现了Mixin(混入)
,我们这里主要讲解的是Vue中的Mixin
。
老规矩,先看 官方文档。
官方解释:
混入
(mixin)
提供了一种非常灵活的方式,来分发 Vue 组件中的可复用功能。一个混入对象可以包含任意组件选项。当组件使用混入对象时,所有混入对象的选项将被“混合”进入该组件本身的选项。
官方的解释通常都是晦涩难懂的,因为要专业和准确嘛!
我们可以用我们自己容易理解的话来说说Vue
中的Mixin
是什么。
民间解释:
将组件的公共逻辑或者配置提取出来,哪个组件需要用到时,直接将提取的这部分混入到组件内部即可。这样既可以减少代码冗余度,也可以让后期维护起来更加容易。
这里需要注意的是:提取的是逻辑或配置,而不是HTML代码和CSS代码
。其实大家也可以换一种想法,mixin
就是组件中的组件,Vue
组件化让我们的代码复用性更高,那么组件与组件之间还有重复部分,我们使用Mixin
再抽离一遍。
Mixin和Vuex的区别?
上面一点说Mixin
就是一个抽离公共部分的作用。在Vue
中,Vuex
状态管理似乎也是做的这一件事,它也是将组件之间可能共享的数据抽离出来。两者看似一样,实则还是有细微的区别,区别如下:
Vuex
公共状态管理,如果在一个组件中更改了Vuex
中的某个数据,那么其它所有引用了Vuex
中该数据的组件也会跟着变化。Mixin中的数据和方法都是独立的,组件之间使用后是互相不影响的。
如何使用?
我们了解了Mixin
的概念,那么如何使用它呢?这才是我们的重点。
准备工作
接下来我们的mixin
就放在Vue2.x
的脚手架项目中演示。
利用Vue-cli
初始化一个最简单的项目:
找到你要创建项目的文件夹 例如 这个 Vue 文件夹
输入cmd
指令 弹出命令行
命令:
vue create 项目名称
这里会弹出提示 创建的是Vue3还是Vue2的项目,这里我用到的是Vue2 看自身条件自行参考
正在安装Vue项目
在你创建的文件夹下就可以找到你的项目了
输入
npm run serve
启动项目
mixin定义
定义mixin
也非常简单,它就是一个对象而已,只不过这个对象里面可以包含Vue
组件中的一些常见配置,如data、methods、created
等等。
在我们的项目src
目录下新建mixin
文件夹,然后新建index.js
文件,该文件存放我们的mixin
代码。
代码如下:
// src/mixin/index.js
export const mixins = {
data() {
return {};
},
computed: {},
created() {},
mounted() {},
methods: {},
};
可以看到我们的mixin
非常的简单,主要包含了一个Vue
组件的常见的逻辑结构。
接下来让我们在mixin
中简单的写点东西,代码如下:
export const mixins = {
data() {
return {
msg: "我是mixins",
};
},
computed: {},
created() {
console.log("我是mixin中的created生命周期函数");
},
mounted() {
console.log("我是mixin中的mounted生命周期函数");
},
methods: {
clickMe() {
console.log("我是mixin中的点击事件");
},
},
};
局部混入
我们的公共mixin
定义好后,最重要就是如何使用它。根据不同的业务场景,我们可以分为两种:局部混入和全局混入。顾名思义,局部混入和组件的按需加载有点类似,就是需要用到mixin中的代码时,我们再在组件章引入它。全局混入的话,则代表我在项目的任何组件中都可以使用mixin。
组件中引入mixin
也非常简单,我们稍微改造下App.vue
组件。
代码如下:
<template>
<img alt="Vue logo" src="./assets/logo.png">
<button @click="clickMe">点击我</button>
</template>
<script>
import { mixins } from "./mixin/index";
export default {
name: 'App',
mixins: [mixins],
components: {},
created(){
console.log("组件调用minxi数据",this.msg);
},
mounted(){
console.log("我是组件的mounted生命周期函数")
}
}
</script>
效果如下:
上段代码中引入mixin
的方法也非常简单,直接使用vue
提供给我们的mixins
属性:mixins:[mixins]
。
通过上面的代码和效果我们可以得出以下几点:
mixin
中的生命周期函数会和组件的生命周期函数一起合并执行。mixin
中的data
数据在组件中也可以使用。mixin
中的方法在组件内部可以直接调用。- 生命周期函数合并后执行顺序:先执行mixin中的,后执行组件的。
问题提出:
这里我们就提出了一个问题:一个组件中改动了mixin
中的数据,另一个引用了mixin
的组件会受影响吗?
答案是不会的!
我们可以尝试一下:
在src
下的components
文件夹下新建Demo
组件,代码如下:
<!--src/components/Demo.vue -->
<template>
<div>mixin中的数据:{{ msg }}</div>
</template>
<script>
import { mixins } from "../mixin/index";
export default {
mixins: [mixins],
};
</script>
然后在App.vue
组件中引入Demo
组件,代码如下:
<template>
<img alt="Vue logo" src="./assets/logo.png">
<button @click="changeMsg">更改mixin数据</button>
<Demo></Demo>
</template>
<script>
import Demo from "./components/Demo.vue";
import { mixins } from "./mixin/index";
export default {
name: 'App',
mixins: [mixins],
components: {Demo},
created(){
console.log("组件调用minxi数据",this.msg);
},
mounted(){
console.log("我是组件的mounted生命周期函数")
},
methods:{
changeMsg() {
this.msg = "我是修改后是msg";
console.log("更改后的msg:", this.msg);
},
}
}
</script>
代码解释:
- 我们在
Demo
组件中引入了mixin
,且使用了mixin
中的msg
数据。 - 在
App.vue
中同样引入了mixin
,且设置了点击事件更改msg
- 点击按钮,更改
msg
,查看Demo
组件中显示是否有变化。
在组件命名的时候未按照 ESLint
的官方代码规范进行命名可以关闭eslint校验
配置 vue.config.js
文件
在根目录下找到 vue.config.js 文件(如果没有则新建一个,按照示例中的代码进行添加;用 vue-cli 脚手架进行创建的项目都会有 vue.config.js 文件),添加下面的代码在 vue.config.js 文件下,加入以下代码
// 关闭eslint校验
lintOnSave: false
全局混入
上一点我们使用mixin
是在需要的组件中引入它,我们也可以在全局先把它注册好,这样我们就可以在任何组件中直接使用了。
修改main.js
,代码如下:
import Vue from "vue";
import App from "./App.vue";
import { mixins } from "./mixin/index";
Vue.mixin(mixins);
Vue.config.productionTip = false;
new Vue({
render: (h) => h(App),
}).$mount("#app");
然后把App.vue
中引入mixin
的代码注释掉,代码如下:
<template>
<div id="app">
<img alt="Vue logo" src="./assets/logo.png" />
<button @click="clickMe">点击我</button>
<button @click="changeMsg">更改mixin数据</button>
<Demo></Demo>
</div>
</template>
<script>
// import { mixins } from "./mixin/index";
import Demo from "./components/Demo.vue";
export default {
name: "App",
// mixins: [mixins],
components: { Demo },
created() {
console.log("组件调用minxi数据", this.msg);
},
mounted() {
console.log("我是组件的mounted生命周期函数");
},
methods: {
changeMsg() {
this.msg = "我是修改后的msg";
console.log("更改后的msg:", this.msg);
},
},
};
</script>
效果如下:
可以发现效果上和局部混入没有任何区别,这就是全局混入的特点。
虽然这样做很方便,但是我们不推荐,来看看官方的一段话:
请谨慎使用全局混入,因为它会影响每个单独创建的
Vue
实例 (包括第三方组件)。大多数情况下,只应当应用于自定义选项,就像上面示例一样。推荐将其作为插件发布,以避免重复应用混入。
选项合并
上面的列子中我们仔细看会发现一个问题:mixin
中定义的属性或方法的名称与组件中定义的名称没有冲突!
那么我们不禁会想,如果命名有冲突了怎么办?
我们使用git
合并代码的时候经常会有冲突,有冲突了不要怕,我们合并就好了。这里的冲突主要分为以下几种情况:
(1)生命周期函数
确切来说,这种不算冲突,因为生命周期函数的名称都是固定的,默认的合并策略如下:
先执行mixin
中生命周期函数中的代码,然后在执行组件内部的代码,上面的例子其实就很好的证明了。
(2)data数据冲突
当mixin
中的data
数据与组件中的data
数据冲突时,组件中的data
数据会覆盖mixin
中数据,借用官方的一段代码:
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" }
}
})
可以看到最终打印的message是组件中message的值,其它没有冲突的数据自然合并了。
(3)方法冲突
这种冲突很容易遇到,毕竟大家命名方法的名字很容易一样,这里同样借用官方的一段代码:
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"
上段代码中mixin
和组件中都有conficting
方法,但是最终在组件中调用时,实际调用的是组件中的conflicting
方法。
当然,如果你要自定义合并规则也不是不可以,但是我觉得没有必要,项目中无需做这么复杂。
mixin的优缺点
从上面的例子看来,使用mixin
的好处多多,但是凡是都有两面性,这里总结几点优缺点供大家参考:
优点
- 提高代码复用性
- 无需传递状态
- 维护方便,只需要修改一个地方即可
缺点
- 命名冲突
- 滥用的话后期很难维护
- 不好追溯源,排查问题稍显麻烦
- 不能轻易的重复代码
总结
mixin
给我们提供了方便的同时也给我们带来了灾难,所以有很多时候不建议滥用它,但是在有些场景下使用它又是非常合适的,这就得根据自己来取舍了。所以在很多时候我们需要考虑用公共组件还是使用mixin
。