浅谈vue.use()方法从源码到使用


Posted in Javascript onMay 12, 2019

关于 vue.use 我们都知道些什么?

在做 vue 开发的时候大家一定经常接触 Vue.use() 方法,官网给出的解释是: 通过全局方法 Vue.use() 使用插件;我觉得把使用理解成注册更合适一些,首先看下面常见的注册场景。

import Router from 'vue-router'
Vue.use(Router)

import Vuex from 'vuex'
Vue.use(Vuex)

import Echarts from 'echarts'
Vue.prototype.$echarts = Echarts

关于 echarts 的注册很简单,直接挂在 Vue 方法的原型上,通过原型链继承的关系可以在任意一个组件里通过 this.$echarts 访问到 echarts 实例,我们来写一个简单的例子证明一下。

function myVue(title){
 this.title = title
}
myVue.prototype.myUse = '在原型上添加公共属性'
const A = new myVue('我是实例A')
const B = new myVue('我是实例B')
console.log(A.title, B.title, A.myVue, B.myVue, )
// 我是实例A 我是实例B 在原型上添加公共属性 在原型上添加公共属性

而 Router 和 Vuex 的注册就要去分析 Vue.use() 的源码了,在分析源码之前先总结一下官方对 Vue.use() 方法的说明:

  • 通过全局方法 Vue.use() 使用插件
  • Vue.use 会自动阻止多次注册相同插件
  • 它需要在你调用 new Vue() 启动应用之前完成
  • Vue.use() 方法至少传入一个参数,该参数类型必须是 Object 或 Function,如果是 Object 那么这个 Object 需要定义一个 install 方法,如果是 Function 那么这个函数就被当做 install 方法。在 Vue.use() 执行时 install 会默认执行,当 install 执行时第一个参数就是 Vue,其他参数是 Vue.use() 执行时传入的其他参数。

官网说 Vue.use() 是用来使用插件的,那么传入的 Router 和 Vuex 就是这里指的插件,而这个插件本质上又是一个 install 方法。至于 install 方法内部实现了什么逻辑就由插件自身的业务决定了。

源码分析

首先说一下 Flow,vue源码中那些奇怪的写法 Vue.use = function (plugin: Function | Object) 是 Flow 的语法,Flow 是 facebook 出品的 JavaScript 静态类型检查工具。JavaScript 是动态类型语言,它的灵活性有目共睹,但是过于灵活的副作用是很容易就写出非常隐蔽的隐患代码,在编译期甚至看上去都不会报错,但在运行阶段就可能出现各种奇怪的 bug。

下面我们正式开始分析源码,Vue.use() 的源码很简单30行都不到,首先看 src/core/global-api/use.js 下 Vue.use() 方法的定义:

import { toArray } from '../util/index'
export function initUse (Vue: GlobalAPI) {
 Vue.use = function (plugin: Function | Object) {
  const installedPlugins = (this._installedPlugins || (this._installedPlugins = []))
  if (installedPlugins.indexOf(plugin) > -1) {
   return this
  }
  const args = toArray(arguments, 1)
  args.unshift(this)
  if (typeof plugin.install === 'function') {
   plugin.install.apply(plugin, args)
  } else if (typeof plugin === 'function') {
   plugin.apply(null, args)
  }
  installedPlugins.push(plugin)
  return this
 }
}

上面源码中使用了工具函数 toArray ,该函数定义在 src/shared/util.js

export function toArray (list: any, start?: number): Array<any> {
 start = start || 0
 let i = list.length - start
 const ret: Array<any> = new Array(i)
 while (i--) {
  ret[i] = list[i + start]
 }
 return ret
}

了解一下源码实现了什么逻辑

Vue.use = function (plugin: Function | Object) {

在全局api Vue 上定义了 use 方法,接收一个 plugin 参数可以是 Function 也可以是 Object,这就和前面官方规定的 Vue.use() 第一个参数要求的类型对应上了。

if (installedPlugins.indexOf(plugin) > -1) {

用来判断该插件是不是已经注册过,防止重复注册。

const args = toArray(arguments, 1)

arguments是 Vue.use() 方法的参数列表是一个类数组,后面的 1 先理解成一个常量,toArray 方法的作用就是把第一个 Array 参数从下标为1截取到最后。也就拿到了 Vue.use() 方法除去第一个之外的其他参数,这些参数准备在调用 instll 方法的时候传入。

if (typeof plugin.install === 'function') {
} else if (typeof plugin === 'function') {

这里的if语句是判断 Vue.use() 传入的第一个参数是 Object 还是 Function。

plugin.install.apply(plugin, args)
plugin.apply(null, args)

判断完之后执行那个对应的 install 方法,用 apply 改变 this 指向,并把 toArray 得到的剩余参数传入。

installedPlugins.push(plugin)

最后记录该组件已经注册过了

现在我们发现 Vue.use() 的注册本质上就是执行了一个 install 方法,install 里的内容由开发者自己定义,通俗讲就是一个钩子可能更贴近语义化而已。

Vue.use()有什么用

在 install 里我们可以拿到 Vue 那么和 Vue 相关的周边工作都可以考虑放在 Vue.use() 方法里,比如:

  • directive注册
  • mixin注册
  • filters注册
  • components注册
  • prototype挂载
  • ...

echarts 用 Vue.use() 来注册

main.js

import Vue from 'vue'
import echarts from './echarts.js'
Vue.use(echarts)

new Vue({
 ...
})

echarts.js

import Echarts from 'echarts'
export default {
 install(Vue){
  Vue.prototype.$echarts = Echarts
 }
}

这样写的好处是可以在 install 的文件里做更多配置相关的工作,main.js 不会变的臃肿,更方便管理。

全局组件用 Vue.use() 来注册

base.js

import a from './a'
import b from './b'
let components = { a, b }
const installBase = {
 install (Vue) {
  Object.keys(components).map(key => Vue.component(key, components[key]))
 }
}

main.js

import Vue from 'vue'
import base from './base.js'
Vue.use(base)

new Vue({
 ...
})

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
jquery选择器的选择使用及性能介绍
Jan 16 Javascript
获取表单控件原始(初始)值的方法
Aug 21 Javascript
纯JavaScript实现的分页插件实例
Jul 14 Javascript
js中对函数设置默认参数值的3种方法
Oct 23 Javascript
MUI 上拉刷新/下拉加载功能实例代码
Apr 13 Javascript
JS实现异步上传压缩图片
Apr 22 Javascript
vue项目关闭eslint校验
Mar 21 Javascript
JS实现DOM删除节点操作示例
Apr 04 Javascript
Node中对非阻塞I/O、事件循环的知识点总结
Jan 05 Javascript
vue-router重写push方法,解决相同路径跳转报错问题
Aug 07 Javascript
Vue仿Bibibili首页的问题
Jan 21 Vue.js
vue+element ui实现锚点定位
Jun 29 Vue.js
Vue安装浏览器开发工具的步骤详解
May 12 #Javascript
微信小程序缓存过期时间的使用详情
May 12 #Javascript
从0到1搭建element后台框架优化篇(打包优化)
May 12 #Javascript
Vue项目服务器部署之子目录部署方法
May 12 #Javascript
vue配置接口域名方法总结
May 12 #Javascript
详解babel升级到7.X采坑总结
May 12 #Javascript
babel7.x和webpack4.x配置vue项目的方法步骤
May 12 #Javascript
You might like
将OICQ数据转成MYSQL数据
2006/10/09 PHP
PHP开发过程中常用函数收藏
2009/12/14 PHP
php实现cc攻击防御和防止快速刷新页面示例
2014/02/13 PHP
浅析Laravel5中队列的配置及使用
2016/08/04 PHP
php插入含有特殊符号数据的处理方法
2016/11/24 PHP
Yii2设置默认控制器的两种方法
2017/05/19 PHP
php中pcntl_fork创建子进程的方法实例
2019/03/14 PHP
IE6不能修改NAME问题的解决方法
2010/09/03 Javascript
JS获取整个页面文档的实现代码
2011/12/15 Javascript
javascript中传统事件与现代事件
2015/06/23 Javascript
js仿苹果iwatch外观的计时器代码分享
2015/08/26 Javascript
详解jQuery移动页面开发中的ui-grid网格布局使用
2015/12/03 Javascript
JS中作用域和变量提升(hoisting)的深入理解
2016/10/31 Javascript
完美解决jQuery fancybox ie 无法显示关闭按钮的问题
2016/11/29 Javascript
JS返回顶部实例代码
2020/08/09 Javascript
vue绑定的点击事件阻止冒泡的实例
2018/02/08 Javascript
vue实现点击隐藏与显示实例分享
2019/02/13 Javascript
vue-test-utils初使用详解
2019/05/23 Javascript
python发送arp欺骗攻击代码分析
2014/01/16 Python
python实现360皮肤按钮控件示例
2014/02/21 Python
python实现根据ip地址反向查找主机名称的方法
2015/04/29 Python
sublime text 3配置使用python操作方法
2017/06/11 Python
python中matplotlib实现最小二乘法拟合的过程详解
2017/07/11 Python
Python3数据库操作包pymysql的操作方法
2018/07/16 Python
pthon贪吃蛇游戏详细代码
2019/01/27 Python
Python解压 rar、zip、tar文件的方法
2019/11/19 Python
Python 的 __str__ 和 __repr__ 方法对比
2020/09/02 Python
python基于openpyxl生成excel文件
2020/12/23 Python
python pygame 愤怒的小鸟游戏示例代码
2021/02/25 Python
德国消费电子产品购物网站:Guter Kauf
2020/09/15 全球购物
单位承诺书格式
2014/05/21 职场文书
小学亲子活动总结
2014/07/01 职场文书
应届生面试求职信
2014/07/02 职场文书
黑暗中的舞者观后感
2015/06/18 职场文书
运动会跳远广播稿
2015/08/19 职场文书
《怀念母亲》教学反思
2016/02/19 职场文书