资讯专栏INFORMATION COLUMN

在 Vue.js 中使用任意 JavaScript 第三方库

SexySix / 2760人阅读

摘要:一个更好的方式在项目中使用库的最干净,最健壮的方法是将其代理为原型对象的属性。然而,这样做的结果是,与全局变量不同,您在使用库时必须确保处于正确的作用域中。

如何在 Vue.js 项目中 引入 JavaScript 第三方库

全局变量

将 JavaScript 第三方库 添加到项目中,最简单的办法是通过将其附加到 window 对象上,以使其成为全局变量:

// entry.js 文件
window._ = require("lodash"); 
JavaScript 代码:
// MyComponent.vue 文件
export default {
  created() {
    console.log(_.isEmpty() ? "Lodash everywhere!" : "Uh oh..");
  }
}

这种情况会使 window 变量不断增长,但是最关键的是,他们不能使用服务器渲染。当应用程序在服务端运行时,window 对象是 undefined 的,因此尝试访问 window 下的属性将会抛出一个错误。

在每个文件中导入

另一种二流的方法是将库导入到每个文件

// MyComponent.vue 文件
import _ from "lodash";
export default {
  created() {
    console.log(_.isEmpty() ? "Lodash is available here!" : "Uh oh..");
  }
}

这是有效的,但是你需要重复手动导入和移除,这是一个痛点:你必须记住将这个库导入到每个文件中,然后当你的某个文件不用这个库的时候, 记得要将它从这个文件中移除。如果你没有正确地设置你的构建工具,则可能会最终导致在构建包中存在同一个库的多个副本。

一个更好的方式

在Vue项目中使用Javascript库的最干净,最健壮的方法是将其代理为 Vue 原型对象的属性。我们用这种方式,将 Moment日期和时间库添加到我们的项目中:

JavaScript 代码:
// entry.js 文件
import moment from "moment";
Object.definePrototype(Vue.prototype, "$moment", { value: moment });
由于所有组件都会继承 Vue 原型对象上方法,这将使 Moment 自动可用于任何组件,没有全局变量或任何需要手动导入的组件。它可以在任何 实例/组件 中简单地通过 this.$moment 访问被访问:

JavaScript 代码:
// MyComponent.vue 文件
export default {
  created() {
    console.log("The time is " . this.$moment().format("HH:mm"));
  }
}

现在让我们花点时间了解一下这是如何工作的。

Object.defineProperty
我们通常会像这样设置一个对象属性:

JavaScript 代码:
Vue.prototype.$moment = moment;

你可以这么做,但是通过使用 Object.defineProperty ,我们可以使用 描述符 来定义我们的属性。描述符允许我们设置一些低级细节,例如我们的属性是否可写,以及在 for 循环中枚举期间是否显示。

我们通常不会在日常使用 Javascript 中使用到描述符,因为 99% 的时间我们不需要这么细致的属性分配。但这里给我们一个明显的优势:默认情况下,使用描述符创建的属性是只读的。

这意味着,一些糊涂的开发人员(可能是你)不能在组件内去做一些很愚蠢的事情, 并且破坏一切.

JavaScript 代码:
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.

$

您会注意到,我们将库代理为以美元符号“$”为前缀的属性名。 你可能还看过其他的属性和方法,例如,$refs, $on, $mount等等也都是以”$”开头。

虽然属性名上添加前缀不是必须的,但是这样做可以提醒糊涂的开发人员(可能是你),这是一个公共API属性或方法,欢迎你使用,不像其他属性的实例,可能只是为了 Vue 的内部使用。

作为基于原型的语言,Javascript 中没有(真正的)类,因此也没有 “私有” 和 “公共” 变量或 “静态” 方法。 这个惯例是一种很好的替代品,我们认为是值得遵守的约定。

this

你还会注意到,你可以使用 this.libraryName 来使用这个库 ,但是这样做会有个小小的问题,因为它现在是一个实例方法。

然而,这样做的结果是,与全局变量不同,您在使用库时必须确保处于正确的作用域中。内部的回调方法不能通过 this 来访问你的库。

幸好,ES6中的箭头函数是一个不错的解决方案, 它能确保你在正确的作用域中:

JavaScript 代码:
// script.js
this.$http.get("/").then(res => {
  if (res.status !== 200) {
    this.$http.get("/") // etc
    // 只在箭头回调函数中起作用。愚人码头注:你也可以使用ES5 的 bind();
  }
});

为什么不使它成为一个插件?

如果您打算在多个 Vue 项目中使用 JavaScript 第三方库,或者您想与世界分享你的库,您可以将其构建成插件!

插件提取复杂性的部分,允许你在项目中简单地执行以下操作来添加你选择的库:

JavaScript 代码:
// script.js
import MyLibraryPlugin from "my-library-plugin";
Vue.use(MyLibraryPlugin);

使用这两行,我们可以在任何组件中使用 JavaScript 第三方库,就像我们可以使用 Vue Router ,Vuex 和其他使用 Vue.use 的插件一样。

编写一个插件
首先,为您的插件创建一个文件。在这个例子中,我将创建一个插件,将 Axios 添加到你所有的 Vue 实例和组件中,因此我将调用文件 axios.js。

要了解的主要内容是:插件必须公开一个 install 方法,并且将 Vue 构造函数作为第一个参数:

JavaScript 代码:
// axios.js
export default {
  install: function(Vue) {
    // Do stuff
  }
}

现在我们可以使用之前介绍的方法将库添加到原型对象中:

JavaScript 代码:
// axios.js
import axios from "axios";
export default {
  install: function(Vue,) {
    Object.defineProperty(Vue.prototype, "$http", { value: axios });
  }
}

我们现在需要做的事情是 use 实例方法将我们的库添加到一个项目。例如,我们现在可以轻松地添加 Axios 库:

JavaScript 代码:
// entry.js
import AxiosPlugin from "./axios.js";
Vue.use(AxiosPlugin);
new Vue({
  created() {
    console.log(this.$http ? "Axios works!" : "Uh oh..");
  }
})

彩蛋: 插件可选参数

你插件里的 install 方法允许接受可选参数。 一些开发人员可能不是很喜欢使用 axios 实例的方法名 $http ,因为 Vue Resource 已经使用了这个名字,所以让我们使用一个可选参数来让它们变成你所喜欢的方法名:

JavaScript 代码:
// axios.js
import axios from "axios";
export default {
  install: function(Vue, name = "$http") {
    Object.defineProperty(Vue.prototype, name, { value: axios });
  }
}
JavaScript 代码:
// entry.js
import AxiosPlugin from "./axios.js";
Vue.use(AxiosPlugin, "$axios");
new Vue({
  created() {
    console.log(this.$axios ? "Axios works!" : "Uh oh..");
  }
})

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/96481.html

相关文章

  • 后端开发者的Vue学习之路(一)

    摘要:如果我们作为一个后端开发者想掌握一个前端框架,是一个好选择,因为它足够的易学。是语言的下一代标准。数据方法生命周期钩子函数其他有些内容比较重要,留到后面讲定义数据定义数据定义了数据,那么就可以在管理的区域中使用的获取数据的语法来获取数据。目录 前言: iview组件库示例 element组件库示例 ...

    番茄西红柿 评论0 收藏0
  • 三方

    摘要:微信支付,支付宝支付,银联支付三大支付总结支付宝植入总结支付宝的植基于和百度地图的组件库基于百度地图封装的组件库,使用这个库最好需要先了解和百度地图。 Commento - 多说 & Disqus 开源替代品 Commento - 多说 & Disqus 开源替代品 anime.js 简单入门教程 强大轻量的动画库 anime.js 入门教程 来自B站的开源的MagicaSakura源...

    seanHai 评论0 收藏0
  • 三方

    摘要:微信支付,支付宝支付,银联支付三大支付总结支付宝植入总结支付宝的植基于和百度地图的组件库基于百度地图封装的组件库,使用这个库最好需要先了解和百度地图。 Commento - 多说 & Disqus 开源替代品 Commento - 多说 & Disqus 开源替代品 anime.js 简单入门教程 强大轻量的动画库 anime.js 入门教程 来自B站的开源的MagicaSakura源...

    gityuan 评论0 收藏0
  • vue开发看这篇文章就够了

    摘要:注意此处获取的数据是更新后的数据,但是获取页面中的元素是更新之前的钩子函数说明组件已经更新,所以你现在可以执行依赖于的操作。钩子函数说明实例销毁 Vue -渐进式JavaScript框架 介绍 vue 中文网 vue github Vue.js 是一套构建用户界面(UI)的渐进式JavaScript框架 库和框架的区别 我们所说的前端框架与库的区别? Library 库,本质上是一...

    fsmStudy 评论0 收藏0
  • 用WijmoJS玩转您的Web应用 —— Vue.js

    摘要:相反,我们将专注于将添加到用编写的简单应用程序中。使用创建应用程序。示例应用程序有两个组件应用程序和。除在全球率先支持外,现已全面应用于等主流框架中。 showImg(https://segmentfault.com/img/bVbcvaQ?w=500&h=278); 概述 在本文中,我们将展示如何将WijmoJS与NPM和Webpack一起使用来创建最流行的基于JavaScript应...

    OnlyMyRailgun 评论0 收藏0

发表评论

0条评论

SexySix

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<