您会注意到,咱们将库代理为以美圆符号“$”为前缀的属性名。 你可能还看过其余的属性和方法,例如,$refs
, $on
, $mount
等等也都是以”$”开头。vue
虽然属性名上添加前缀不是必须的,可是这样作能够提醒糊涂的开发人员(多是你),这是一个公共API属性或方法,欢迎你使用,不像其余属性的实例,可能只是为了 Vue 的内部使用。ios
做为基于原型的语言,Javascript 中没有(真正的)类,所以也没有 “私有” 和 “公共” 变量或 “静态” 方法。 这个惯例是一种很好的替代品,咱们认为是值得遵照的约定。axios
将 JavaScript 第三方库 添加到项目中,最简单的办法是经过将其附加到 window
对象上,以使其成为全局变量:服务器
// entry.js 文件 window._ = require('lodash');
// MyComponent.vue 文件 export default { created() { console.log(_.isEmpty() ? 'Lodash everywhere!' : 'Uh oh..'); } }
这种状况会使 window
变量不断增加,可是最关键的是,他们不能使用服务器渲染。当应用程序在服务端运行时,window
对象是 undefined
的,所以尝试访问 window
下的属性将会抛出一个错误。dom
另外一种二流的方法是将库导入到每一个文件中:函数
// MyComponent.vue 文件 import _ from 'lodash'; export default { created() { console.log(_.isEmpty() ? 'Lodash is available here!' : 'Uh oh..'); } }
这是有效的,可是你须要重复手动导入和移除,这是一个痛点:你必须记住将这个库导入到每一个文件中,而后当你的某个文件不用这个库的时候, 记得要将它从这个文件中移除。若是你没有正确地设置你的构建工具,则可能会最终致使在构建包中存在同一个库的多个副本。工具
在Vue项目中使用Javascript库的最干净,最健壮的方法是将其代理为 Vue 原型对象的属性。咱们用这种方式,将 Moment日期和时间库添加到咱们的项目中:ui
// entry.js 文件 import moment from 'moment'; Object.definePrototype(Vue.prototype, '$moment', { value: moment });
因为全部组件都会继承 Vue 原型对象上方法,这将使 Moment 自动可用于任何组件,没有全局变量或任何须要手动导入的组件。它能够在任何 实例/组件 中简单地经过 this.$moment
访问被访问:this
// MyComponent.vue 文件 export default { created() { console.log('The time is ' . this.$moment().format("HH:mm")); } }
如今让咱们花点时间了解一下这是如何工做的。spa
咱们一般会像这样设置一个对象属性:
Vue.prototype.$moment = moment;
你能够这么作,可是经过使用 Object.defineProperty
,咱们可使用 描述符 来定义咱们的属性。描述符容许咱们设置一些低级细节,例如咱们的属性是否可写,以及在 for
循环中枚举期间是否显示。
咱们一般不会在平常使用 Javascript 中使用到描述符,由于 99% 的时间咱们不须要这么细致的属性分配。但这里给咱们一个明显的优点:默认状况下,使用描述符建立的属性是只读的。
这意味着,一些糊涂的开发人员(多是你)不能在组件内去作一些很愚蠢的事情, 而且破坏一切.
this.$http = 'Assign some random thing to the instance method'; this.$http.get('/'); // TypeError: this.$http.get is not a function
相反, 咱们的只读实例则能很好的保护咱们的库, 由于若是有人试图去覆盖它, 将会得到一个错误: TypeError: Cannot assign to read only property
.
你还会注意到,你可使用 this.libraryName
来使用这个库 ,可是这样作会有个小小的问题,由于它如今是一个实例方法。
然而,这样作的结果是,与全局变量不一样,您在使用库时必须确保处于正确的做用域中。内部的回调方法不能经过 this
来访问你的库。
幸亏,ES6中的箭头函数是一个不错的解决方案, 它能确保你在正确的做用域中:
若是您打算在多个 Vue 项目中使用 JavaScript 第三方库,或者您想与世界分享你的库,您能够将其构建成插件!
插件提取复杂性的部分,容许你在项目中简单地执行如下操做来添加你选择的库:
使用这两行,咱们能够在任何组件中使用 JavaScript 第三方库,就像咱们可使用 Vue Router ,Vuex 和其余使用 Vue.use 的插件同样。
首先,为您的插件建立一个文件。在这个例子中,我将建立一个插件,将 Axios 添加到你全部的 Vue 实例和组件中,所以我将调用文件 axios.js。
要了解的主要内容是:插件必须公开一个 install
方法,而且将 Vue 构造函数做为第一个参数:
如今咱们可使用以前介绍的方法将库添加到原型对象中:
咱们如今须要作的事情是 use
实例方法将咱们的库添加到一个项目。例如,咱们如今能够轻松地添加 Axios 库:
你插件里的 install
方法容许接受可选参数。 一些开发人员可能不是很喜欢使用 axios 实例的方法名 $http
,由于 Vue Resource 已经使用了这个名字,因此让咱们使用一个可选参数来让它们变成你所喜欢的方法名: