淺談vue.use()方法從源碼到使用

關于 vue.use 我們都知道些什么？

在做 vue 開發(fā)的時候大家一定經(jīng)常接觸 Vue.use() 方法，官網(wǎng)給出的解釋是: 通過全局方法 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() 方法至少傳入一個參數(shù)，該參數(shù)類型必須是 Object 或 Function，如果是 Object 那么這個 Object 需要定義一個 install 方法，如果是 Function 那么這個函數(shù)就被當做 install 方法。在 Vue.use() 執(zhí)行時 install 會默認執(zhí)行，當 install 執(zhí)行時第一個參數(shù)就是 Vue，其他參數(shù)是 Vue.use() 執(zhí)行時傳入的其他參數(shù)。

官網(wǎng)說 Vue.use() 是用來使用插件的，那么傳入的 Router 和 Vuex 就是這里指的插件，而這個插件本質上又是一個 install 方法。至于 install 方法內部實現(xiàn)了什么邏輯就由插件自身的業(yè)務決定了。

源碼分析

首先說一下 Flow，vue源碼中那些奇怪的寫法 Vue.use = function (plugin: Function | Object) 是 Flow 的語法，F(xiàn)low 是 facebook 出品的 JavaScript 靜態(tài)類型檢查工具。JavaScript 是動態(tài)類型語言，它的靈活性有目共睹，但是過于靈活的副作用是很容易就寫出非常隱蔽的隱患代碼，在編譯期甚至看上去都不會報錯，但在運行階段就可能出現(xiàn)各種奇怪的 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
 }
}

上面源碼中使用了工具函數(shù) toArray ，該函數(shù)定義在 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
}

了解一下源碼實現(xiàn)了什么邏輯

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

在全局api Vue 上定義了 use 方法，接收一個 plugin 參數(shù)可以是 Function 也可以是 Object，這就和前面官方規(guī)定的 Vue.use() 第一個參數(shù)要求的類型對應上了。

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


用來判斷該插件是不是已經(jīng)注冊過，防止重復注冊。

const args = toArray(arguments, 1)

arguments是 Vue.use() 方法的參數(shù)列表是一個類數(shù)組，后面的 1 先理解成一個常量，toArray 方法的作用就是把第一個 Array 參數(shù)從下標為1截取到最后。也就拿到了 Vue.use() 方法除去第一個之外的其他參數(shù)，這些參數(shù)準備在調用 instll 方法的時候傳入。

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


這里的if語句是判斷 Vue.use() 傳入的第一個參數(shù)是 Object 還是 Function。

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

判斷完之后執(zhí)行那個對應的 install 方法，用 apply 改變 this 指向，并把 toArray 得到的剩余參數(shù)傳入。

installedPlugins.push(plugin)

最后記錄該組件已經(jīng)注冊過了

現(xiàn)在我們發(fā)現(xiàn) Vue.use() 的注冊本質上就是執(zhí)行了一個 install 方法，install 里的內容由開發(fā)者自己定義，通俗講就是一個鉤子可能更貼近語義化而已。

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({
 ...
})

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。