关于javascript:JavaScript-中模块的导入和导出最最最简明教程

34次阅读

共计 7294 个字符,预计需要花费 19 分钟才能阅读完成。

简介

晚期的 Web 网站次要由 HTML 和 CSS 组成。如果有任何 JavaScript 的代码须要在页面中执行,通常是以小的代码片段的模式来提供性能和交互性。后果就是通常 JavaScript 的代码都会被编写在一个文件中,而后通过 script 标签加载到页面中。开发人员能够将 JavaScript 代码拆分成多个 js 文件,然而所有 JavaScript 变量和函数 >)都会被增加到全局作用域中。

然而随着 Angular、React 以及 Vue 等 Web 框架技术的倒退,并且大部分公司都在开发高级 Web 利用而非桌面利用,JavaScript 就变得越来越重要了。将可能复用的代码逻辑封装成公共代码,并且在防止全局命名空间净化的前提下,将其模块化,这一需要就成为了必要。

ECMAScript 2015 标准引入了容许应用 importexport 语句的 modules 概念。在本教程中,你将学习什么是 JavaScript 模块以及如何应用 import export 治理代码构造。

模块化编程

在 JavaScript 引入模块化概念之前,当开发人员想要将代码封装时,须要创立多个文件并将这些文件链接为独自的脚本。作者为了阐明这一点,创立了一个示例:index.html 文件和两个 JavaScript 文件,functions.jsscript.js

index.html 文件将显示两个数字的和,差,乘积和商的后果,并在脚本标签中链接到两个 JavaScript 文件。在文本编辑器中新建 index.html 并增加以下代码:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />

    <title>JavaScript Modules</title>
  </head>

  <body>
    <h1>Answers</h1>
    <h2><strong id="x"></strong> and <strong id="y"></strong></h2>

    <h3>Addition</h3>
    <p id="addition"></p>

    <h3>Subtraction</h3>
    <p id="subtraction"></p>

    <h3>Multiplication</h3>
    <p id="multiplication"></p>

    <h3>Division</h3>
    <p id="division"></p>

    <script src="functions.js"></script>
    <script src="script.js"></script>
  </body>
</html>

该 HTML 将在 h2 标签中显示变量 xy 的值,并在其下 p 元素中显示这些变量的运算值。元素 id 属性为了不便 script.js 文件中的 DOM 操作,script.js 文件还会设置 xy 的值。更多 HTML 相干内容能够参考我的如何应用 HTML 创立网站系列文章。

functions.js 文件则提供第二个脚本中将要应用到的数学函数。关上 functions.js 文件并增加以下内容:

function sum(x, y) {return x + y;}

function difference(x, y) {return x - y;}

function product(x, y) {return x * y;}

function quotient(x, y) {return x / y;}

最初,script.js 文件将计算出 xy 的值,并显示后果:

const x = 10;
const y = 5;

document.getElementById("x").textContent = x;
document.getElementById("y").textContent = y;

document.getElementById("addition").textContent = sum(x, y);
document.getElementById("subtraction").textContent = difference(x, y);
document.getElementById("multiplication").textContent = product(x, y);
document.getElementById("division").textContent = quotient(x, y);

实现上述操作之后, 能够在浏览器中关上 index.html 查看运行后果:

对于只有大量 script 文件的网站利用,这是个很高效的代码拆分计划。然而,这种做法会存在一些问题:

  • 净化全局命名空间:在脚本中创立的所有变量包含 sum, difference 等等,都会存在全局 window 对象中。如果试图在一个文件中应用一个名为 sum 的变量,那么就会很难通晓咱们应用的是在哪个脚本中的 sum,因为它们都是应用的雷同全局 window.sum 变量。将变量私有化的惟一办法就是将变量放入函数作用域中。DOM 中的名为 xid 属性和 var id 的变量也会存在抵触(因为如果在 DOM 中应用了 id 属性,浏览器会申明一个同名的全局变量)。
  • 依赖治理:必须从上到下顺次加载 script,以确保变量正确可用。将 <script> 分成不同文件顺次引入会给人拆散的错觉,但实质上这种形式与在浏览器页面中应用单个 <script> 来引入脚本代码是雷同成果的。

在 ES6 将原生模块概念增加到 JavaScript 语言之前,社区尝试了几种解决方案。第一个解决方案就是通过一般的 JavaScript 对象实现的,比方将所有代码写在 objects 或者立刻调用的函数表达式(IIFE)并将它们放在全局中作用域中的单个对象中。这是对多脚本办法的一种改良,然而依然会存在将至多一个对象放入全局名称空间的雷同问题,并且始终没有解决多个脚本之间共享代码的问题。

之后,呈现了一些模块化解决方案:CommonJS,是在 Node.js 实现的同步加载模块的办法,异步模块定义(AMD)则是非同步加载模块,还有通用模块定义(UMD),旨在成为可能反对两种加载模式的通用的解决方案

这些解决方案的呈现使得开发人员更容易地以 package 的模式共享和重用代码,这些模块也能够被转发和共享,例如一些能在 npm 上找到的 packages。然而, 因为有如此多的解决方案并且没有一个是 JavaScript 原生的,所以为了能在浏览其中应用模块,一些相应的工具呈现了,比方 Babel、Webpack 以及 Browserify。

因为多文件计划存在许多问题,并且所提出的解决方案很简单,因而开发人员对将模块化编程引入 JavaScript 语言很感兴趣。因而,ECMAScript 2015 反对 JavaScript 模块的应用。

一个 模块 是一段能够为其余模块提供函数性能的代码块,同时也能够依赖别的模块里的性能。模块中 exports 用以导出,imports 用来援用。模块之所以有用,是因为它们容许开发人员复用代码,它们提供许多开发人员能够应用的稳固、统一的接口,并且它们还不会净化全局命名空间。

模块(有时称为 ECMAScript 模块或 ES 模块)当初能够在 JavaScript 中间接应用,在本教程的残余局部中,你将摸索如何在代码中应用和实现它们。

原生 JavaScript 模块

JavaScript 中的模块应用 importexport 关键字:

  • import: 用于读取从另一个模块导出的代码。
  • export: 用于向其余模块提供代码。

为了演示如何应用模块的导入导出,请将 functions.js 文件中函数应用模块导出。在每个函数的后面增加 export 关键字,这能够让导出的函数在其余模块应用。

将以下的代码增加到文件中:

export function sum(x, y) {return x + y;}

export function difference(x, y) {return x - y;}

export function product(x, y) {return x * y;}

export function quotient(x, y) {return x / y;}

当初,在 script.js 中,你能够在 functions.js 文件的顶部应用 import 从其余模块引入代码。

留神import 必须始终位于文件的顶部。在这个例子中并且还必须应用相对路径(本示例为 ./)。

将以下代码增加到 script.js 中:

import {sum, difference, product, quotient} from "./functions.js";

const x = 10;
const y = 5;

document.getElementById("x").textContent = x;
document.getElementById("y").textContent = y;

document.getElementById("addition").textContent = sum(x, y);
document.getElementById("subtraction").textContent = difference(x, y);
document.getElementById("multiplication").textContent = product(x, y);
document.getElementById("division").textContent = quotient(x, y);

请留神,通过在花括号中命名单个函数来导入它们。

为了确保此代码作为模块而不是惯例脚本加载,请在 index.html 中的 script 标签中增加 type ="module"。任何应用 importexport 的代码都必须应用这个属性:

...
<script type="module" src="functions.js"></script>
<script type="module" src="script.js"></script>

刷新页面以从新加载代码,这时页面就会应用模块进行加载。尽管浏览器对模块的反对度很高,然而咱们能够通过 caniuse 查看不同浏览器的反对度。请留神,如果将文件作为本地文件的的直链,就会遇到这个谬误:

OutputAccess to script at 'file:///Users/your_file_path/script.js' from origin 'null' has been blocked by CORS policy: Cross-origin requests are only supported for protocol schemes: http, data, chrome, chrome-extension, chrome-untrusted, https.

因为跨域资源共享,模块必须在服务器环境中应用,能够本地应用 http-server 也能够通过托管服务提供商在 Internet 上进行设置。

模块与惯例脚本的区别:

  • 模块不会向全局(window)作用域增加任何内容。
  • 模块始终处于严格模式。
  • 在同一文件中援用同一模块屡次将有效,因为模块只会被执行一次。
  • 模块须要运行在服务器环境。

模块也会常常与打包工具(如 Webpack)一起应用,以减少对浏览器的反对和一些附加性能,但它们也能够间接在浏览器中应用。

接下来,咱们将摸索更多应用 importexport 语法的形式。

按名称导出

如前所述,应用 export 语法将容许别离导入按名称导出的值。例如,应用以下简化版本的 function.js

export function sum() {}
export function difference() {}

这将容许应用花括号按名称导入 sumdifference

import {sum, difference} from "./functions.js";

也能够应用别名来重命名该函数以防止在同一模块中命名抵触。在此示例中,sum 将重命名为 adddifference 将重命名为 subtract

import {sum as add, difference as subtract} from "./functions.js";

add(1, 2); // 3

在这里调用 add() 将产生 sum() 函数的后果。

应用 * 语法,能够将整个模块的内容导入到一个对象中。在上面这种状况下,sumdifference 将成为 mathFunctions 对象上的办法。

import * as mathFunctions from "./functions.js";

mathFunctions.sum(1, 2); // 3
mathFunctions.difference(10, 3); // 7

根底类型、函数表达式、函数定义式、异步函数、类以及类的实例也能够被导出,只有它们具备标识符即可:

// 根底类型值
export const number = 100;
export const string = "string";
export const undef = undefined;
export const empty = null;
export const obj = {name: "Homer"};
export const array = ["Bart", "Lisa", "Maggie"];

// 函数表达式
export const sum = (x, y) => x + y;

// 函数定义式
export function difference(x, y) {return x - y;}

// 箭头函数
export async function getBooks() {}

// 类
export class Book {constructor(name, author) {
    this.name = name;
    this.author = author;
  }
}

// 类的实例
export const book = new Book("Lord of the Rings", "J. R. R. Tolkien");

所有这些 exports 都能够胜利地 import。下一大节咱们将探讨的另一种导出类型 —— 默认导出。

默认导出

在后面的示例中,咱们进行了多个命名的导出,并将它们别离导入或者作为一个对象进行了导入,以及也尝试了将导出看做一个对象,每次导出均作为该对象的办法。模块也能够应用关键字 default 蕴含默认导出。默认导出不是应用大括号导入,而是间接导入到命名标识符中。

例如,将以下内容增加至 functions.js 文件:

export default function sum(x, y) {return x + y;}

script.js 文件中,你能够应用以下命令将默认函数导入为 sum

import sum from "./functions.js";

sum(1, 2); // 3

这很危险,因为在导入过程中对默认导出的命名没有任何限度。在上面这个例子中,默认函数被导入为 difference,只管它实际上是 sum 函数:

import difference from "./functions.js";

difference(1, 2); // 3

因而,通常首选应该应用按命名导出。与按命名导出不同,默认导出不须要标识符 —— 根底类型的值或匿名函数都能够用作默认导出。上面是用作默认导出的对象的示例:

export default {
  name: "Lord of the Rings",
  author: "J. R. R. Tolkien",
};

你能够应用以下命令将其作为 book 导入:

import book from "./functions.js";

同样地,上面例子展现了箭头函数的默认导出:

export default () => "This function is anonymous";

能够像上面这样引入 script.js 中的箭头函数:

import anonymousFunction from "./functions.js";

按命名导出和默认导出能够同时应用,比方在上面这个模块中,导出两个命名值和一个默认值:

export const length = 10;
export const width = 5;

export default function perimeter(x, y) {return 2 * (x + y);
}

咱们能够应用以下代码导入这些变量和默认函数:

import calculatePerimeter, {length, width} from "./functions.js";

calculatePerimeter(length, width); // 30

当初,默认值和命名值都能够在 script 中应用。

总结

模块化编程设计实际能够将代码拆分到独自的组件中,从而进步代码的复用率和一致性,同时还能够爱护全局命名空间不被净化。模块化接口能够用原生 JavaScript 的关键字 importexport 来实现。

通过本文的学习,你理解了 JavaScript 中模块的历史、如何将 JavaScript 文件拆散为多个脚本以及如何应用模块化办法按命名的 importexport 和默认的 importexport 语法来更新这些文件。

理解更多无关 JavaScript 中模块的信息,请浏览 Mozilla Modules。如果你想摸索 Node.js 中的模块,能够浏览 How To Create a Node.js Module tutorial。

???? 明天的文章分享就到这里啦,如果喜爱这篇文章的话请点赞、Star、关注我吧 ????

  • 译者:NieZhuZhu(弹铁蛋同学)
  • 校对者:zenblo、Qiaoj、lsvih
  • 原文地址:Understanding Modules and Import and Export Statements in JavaScript
  • 原文作者:Tania Rascia
  • 译文出自:掘金翻译打算
  • 本文永恒链接:https://github.com/xitu/gold-miner/blob/master/article/2020/understanding-modules-and-import-and-export-statements-in-javascript.md

正文完
 0