JavaScript中模块的导入和导出

简介

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

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

ECMAScript 2015 规范引入了允许使用 import 和 export 语句的 modules 概念。在本教程中,你将学习什么是 JavaScript 模块以及如何使用 import 和export 管理代码结构。

模块化编程

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

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

 
 
 
 
  1.  
  2.  
  3.    
  4.      
  5.      
  6.  
  7.     JavaScript Modules 
  8.    
  9.  
  10.    
  11.     

    Answers

     
  12.     

     and 

     
  13.  
  14.     

    Addition

     
  15.     

     
  16.  
  17.     

    Subtraction

     
  18.     

     
  19.  
  20.     

    Multiplication

     
  21.     

     
  22.  
  23.     

    Division

     
  24.     

     
  25.  
  26.      
  27.      
  28.    
  29.  

该 HTML 将在 h2 标签中显示变量 x 和 y 的值,并在其下 p 元素中显示这些变量的运算值。元素id 属性为了方便 script.js 文件中的 DOM 操作,script.js 文件还会设置 x 和 y 的值。更多 HTML 相关内容可以参考我的如何使用 HTML 创建网站系列文章。

functions.js 文件则提供第二个脚本中将要使用到的数学函数。打开 functions.js 文件并添加以下内容:

 
 
 
 
  1. function sum(x, y) { 
  2.   return x + y; 
  3.  
  4. function difference(x, y) { 
  5.   return x - y; 
  6.  
  7. function product(x, y) { 
  8.   return x * y; 
  9.  
  10. function quotient(x, y) { 
  11.   return x / y; 

最后,script.js 文件将计算出 x 和 y 的值,并显示结果:

 
 
 
 
  1. const x = 10; 
  2. const y = 5; 
  3.  
  4. document.getElementById("x").textContent = x; 
  5. document.getElementById("y").textContent = y; 
  6.  
  7. document.getElementById("addition").textContent = sum(x, y); 
  8. document.getElementById("subtraction").textContent = difference(x, y); 
  9. document.getElementById("multiplication").textContent = product(x, y); 
  10. document.getElementById("division").textContent = quotient(x, y); 

完成上述操作之后, 可以在浏览器中打开 index.html 查看运行结果:

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

  • 污染全局命名空间:在脚本中创建的所有变量包括 sum, difference 等等,都会存在全局 window对象中。如果试图在一个文件中使用一个名为 sum 的变量,那么就会很难知晓我们使用的是在哪个脚本中的 sum,因为它们都是使用的相同全局 window.sum 变量。将变量私有化的唯一方法就是将变量放入函数作用域中。DOM 中的名为 x 的 id 属性和 var id 的变量也会存在冲突(因为如果在 DOM 中使用了 id 属性,浏览器会声明一个同名的全局变量)。
  • 依赖管理:必须从上到下依次加载 script,以确保变量正确可用。将  
  •  
  • 刷新页面以重新加载代码,这时页面就会使用模块进行加载。虽然浏览器对模块的支持度很高,但是我们可以通过 caniuse 检查不同浏览器的支持度。请注意,如果将文件作为本地文件的的直链,就会遇到这个错误:

     
     
     
     
    1. 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)一起使用,以增加对浏览器的支持和一些附加功能,但它们也可以直接在浏览器中使用。

    接下来,我们将探索更多使用 import 和 export 语法的方式。

    按名称导出

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

     
     
     
     
    1. export function sum() {} 
    2. export function difference() {} 

    这将允许使用花括号按名称导入 sum 和 difference:

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

    也可以使用别名来重命名该函数以避免在同一模块中命名冲突。在此示例中,sum 将重命名为 add,difference 将重命名为 subtract。

     
     
     
     
    1. import { sum as add, difference as subtract } from "./functions.js"; 
    2.  
    3. add(1, 2); // 3 

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

    使用 * 语法,可以将整个模块的内容导入到一个对象中。在下面这种情况下,sum 和 difference 将成为 mathFunctions 对象上的方法。

     
     
     
     
    1. import * as mathFunctions from "./functions.js"; 
    2.  
    3. mathFunctions.sum(1, 2); // 3 
    4. mathFunctions.difference(10, 3); // 7 

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

     
     
     
     
    1. // 基础类型值 
    2. export const number = 100; 
    3. export const string = "string"; 
    4. export const undef = undefined; 
    5. export const empty = null; 
    6. export const obj = { name: "Homer" }; 
    7. export const array = ["Bart", "Lisa", "Maggie"]; 
    8.  
    9. // 函数表达式 
    10. export const sum = (x, y) => x + y; 
    11.  
    12. // 函数定义式 
    13. export function difference(x, y) { 
    14.   return x - y; 
    15.  
    16. // 箭头函数 
    17. export async function getBooks() {} 
    18.  
    19. // 类 
    20. export class Book { 
    21.   constructor(name, author) { 
    22.     this.name = name; 
    23.     this.author = author; 
    24.   } 
    25.  
    26. // 类的实例 
    27. export const book = new Book("Lord of the Rings", "J. R. R. Tolkien"); 

    所有这些 exports 都可以成功地 import。下一小节我们将探讨的另一种导出类型 —— 默认导出。

    默认导出

    在前面的示例中,我们进行了多个命名的导出,并将它们分别导入或者作为一个对象进行了导入,以及也尝试了将导出看做一个对象,每次导出均作为该对象的方法。模块也可以使用关键字 default 包含默认导出。默认导出不是使用大括号导入,而是直接导入到命名标识符中。

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

     
     
     
     
    1. export default function sum(x, y) { 
    2.   return x + y; 

    在 script.js 文件中,你可以使用以下命令将默认函数导入为 sum:

     
     
     
     
    1. import sum from "./functions.js"; 
    2.  
    3. sum(1, 2); // 3 

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

     
     
     
     
    1. import difference from "./functions.js"; 
    2.  
    3. difference(1, 2); // 3 

    因此,通常首选应该使用按命名导出。与按命名导出不同,默认导出不需要标识符 —— 基础类型的值或匿名函数都可以用作默认导出。下面是用作默认导出的对象的示例:

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

    你可以使用以下命令将其作为 book 导入:

     
     
     
     
    1. import book from "./functions.js"; 

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

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

    可以像下面这样引入 script.js 中的箭头函数:

     
     
     
     
    1. import anonymousFunction from "./functions.js"; 

    按命名导出和默认导出可以同时使用,比如在下面这个模块中,导出两个命名值和一个默认值:

     
     
     
     
    1. export const length = 10; 
    2. export const width = 5; 
    3.  
    4. export default function perimeter(x, y) { 
    5.   return 2 * (x + y); 

    我们可以使用以下代码导入这些变量和默认函数:

     
     
     
     
    1. import calculatePerimeter, { length, width } from "./functions.js"; 
    2.  
    3. calculatePerimeter(length, width); // 30 

    现在,默认值和命名值都可以在 script 中使用。

    总结

    模块化编程设计实践可以将代码拆分到单独的组件中,从而提高代码的复用率和一致性,同时还可以保护全局命名空间不被污染。模块化接口可以用原生 JavaScript 的关键字 import 和 export 来实现。

    通过本文的学习,你了解了 JavaScript 中模块的历史、如何将 JavaScript 文件分离为多个脚本以及如何使用模块化方法按命名的 import、export 和默认的 import、export 语法来更新这些文件。

    了解更多有关 JavaScript 中模块的信息,请阅读 Mozilla Modules。如果你想探索 Node.js 中的模块,可以阅读 How To Create a Node.js Module tutorial

    译者: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

    本文转载自微信公众号「前端铁蛋」,可以通过以下二维码关注。转载本文请联系前端铁蛋公众号。

    本文题目:JavaScript中模块的导入和导出
    分享地址:http://www.hantingmc.com/qtweb/news7/388857.html

    网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

    广告

    声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联