Module 的語法

Module 的語法

1. 概述
2. 嚴格模式
3. export 命令
4. import 命令
5. 模塊的整體加載
6. export default 命令
7. export 與 import 的復合寫法
8. 模塊的繼承
9. 跨模塊常量
10. import()

概述

歷史上，JavaScript 一直沒有模塊（module）體系，無法將一個大程序拆分成互相依賴的小文件，再用簡單的方法拼裝起來。其他語言都有這項功能，比如 Ruby 的require、Python 的import，甚至就連 CSS 都有@import，但是 JavaScript 任何這方面的支持都沒有，這對開發大型的、復雜的項目形成了巨大障礙。

在 ES6 之前，社區制定了一些模塊加載方案，最主要的有 CommonJS 和 AMD 兩種。前者用于服務器，后者用于瀏覽器。ES6 在語言標準的層面上，實現了模塊功能，而且實現得相當簡單，完全可以取代 CommonJS 和 AMD 規范，成為瀏覽器和服務器通用的模塊解決方案。

ES6 模塊的設計思想，是盡量的靜態化，使得編譯時就能確定模塊的依賴關系，以及輸入和輸出的變量。CommonJS 和 AMD 模塊，都只能在運行時確定這些東西。比如，CommonJS 模塊就是對象，輸入時必須查找對象屬性。

// CommonJS模塊
let { stat, exists, readFile } = require('fs');  // 等同于 let _fs = require('fs'); let stat = _fs.stat; let exists = _fs.exists; let readfile = _fs.readfile; 

上面代碼的實質是整體加載fs模塊（即加載fs的所有方法），生成一個對象（_fs），然后再從這個對象上面讀取3個方法。這種加載稱為“運行時加載”，因為只有運行時才能得到這個對象，導致完全沒辦法在編譯時做“靜態優化”。

ES6 模塊不是對象，而是通過export命令顯式指定輸出的代碼，再通過import命令輸入。

// ES6模塊
import { stat, exists, readFile } from 'fs'; 

上面代碼的實質是從fs模塊加載3個方法，其他方法不加載。這種加載稱為“編譯時加載”或者靜態加載，即 ES6 可以在編譯時就完成模塊加載，效率要比 CommonJS 模塊的加載方式高。當然，這也導致了沒法引用 ES6 模塊本身，因為它不是對象。

由于 ES6 模塊是編譯時加載，使得靜態分析成為可能。有了它，就能進一步拓寬 JavaScript 的語法，比如引入宏（macro）和類型檢驗（type system）這些只能靠靜態分析實現的功能。

除了靜態加載帶來的各種好處，ES6 模塊還有以下好處。

• 不再需要UMD模塊格式了，將來服務器和瀏覽器都會支持 ES6 模塊格式。目前，通過各種工具庫，其實已經做到了這一點。
• 將來瀏覽器的新 API 就能用模塊格式提供，不再必須做成全局變量或者navigator對象的屬性。
• 不再需要對象作為命名空間（比如Math對象），未來這些功能可以通過模塊提供。

本章介紹 ES6 模塊的語法，下一章介紹如何在瀏覽器和 Node 之中，加載 ES6 模塊。

嚴格模式

ES6 的模塊自動采用嚴格模式，不管你有沒有在模塊頭部加上"use strict";。

嚴格模式主要有以下限制。

• 變量必須聲明后再使用
• 函數的參數不能有同名屬性，否則報錯
• 不能使用with語句
• 不能對只讀屬性賦值，否則報錯
• 不能使用前綴0表示八進制數，否則報錯
• 不能刪除不可刪除的屬性，否則報錯
• 不能刪除變量delete prop，會報錯，只能刪除屬性delete global[prop]
• eval不會在它的外層作用域引入變量
• eval和arguments不能被重新賦值
• arguments不會自動反映函數參數的變化
• 不能使用arguments.callee
• 不能使用arguments.caller
• 禁止this指向全局對象
• 不能使用fn.caller和fn.arguments獲取函數調用的堆棧
• 增加了保留字（比如protected、static和interface）

上面這些限制，模塊都必須遵守。由于嚴格模式是 ES5 引入的，不屬于 ES6，所以請參閱相關 ES5 書籍，本書不再詳細介紹了。

其中，尤其需要注意this的限制。ES6 模塊之中，頂層的this指向undefined，即不應該在頂層代碼使用this。

export 命令

模塊功能主要由兩個命令構成：export和import。export命令用于規定模塊的對外接口，import命令用于輸入其他模塊提供的功能。

一個模塊就是一個獨立的文件。該文件內部的所有變量，外部無法獲取。如果你希望外部能夠讀取模塊內部的某個變量，就必須使用export關鍵字輸出該變量。下面是一個 JS 文件，里面使用export命令輸出變量。

// profile.js
export var firstName = 'Michael'; export var lastName = 'Jackson'; export var year = 1958; 

上面代碼是profile.js文件，保存了用戶信息。ES6 將其視為一個模塊，里面用export命令對外部輸出了三個變量。

export的寫法，除了像上面這樣，還有另外一種。

// profile.js
var firstName = 'Michael'; var lastName = 'Jackson'; var year = 1958; export {firstName, lastName, year}; 

上面代碼在export命令后面，使用大括號指定所要輸出的一組變量。它與前一種寫法（直接放置在var語句前）是等價的，但是應該優先考慮使用這種寫法。因為這樣就可以在腳本尾部，一眼看清楚輸出了哪些變量。

export命令除了輸出變量，還可以輸出函數或類（class）。

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

上面代碼對外輸出一個函數multiply。

通常情況下，export輸出的變量就是本來的名字，但是可以使用as關鍵字重命名。

function v1() { ... } function v2() { ... } export { v1 as streamV1, v2 as streamV2, v2 as streamLatestVersion }; 

上面代碼使用as關鍵字，重命名了函數v1和v2的對外接口。重命名后，v2可以用不同的名字輸出兩次。

需要特別注意的是，export命令規定的是對外的接口，必須與模塊內部的變量建立一一對應關系。

// 報錯
export 1;
 // 報錯 var m = 1; export m; 

上面兩種寫法都會報錯，因為沒有提供對外的接口。第一種寫法直接輸出1，第二種寫法通過變量m，還是直接輸出1。1只是一個值，不是接口。正確的寫法是下面這樣。

// 寫法一
export var m = 1;  // 寫法二 var m = 1; export {m};  // 寫法三 var n = 1; export {n as m}; 

上面三種寫法都是正確的，規定了對外的接口m。其他腳本可以通過這個接口，取到值1。它們的實質是，在接口名與模塊內部變量之間，建立了一一對應的關系。

同樣的，function和class的輸出，也必須遵守這樣的寫法。

// 報錯
function f() {} export f;  // 正確 export function f() {};  // 正確 function f() {} export {f}; 

另外，export語句輸出的接口，與其對應的值是動態綁定關系，即通過該接口，可以取到模塊內部實時的值。

export var foo = 'bar'; setTimeout(() => foo = 'baz', 500); 

上面代碼輸出變量foo，值為bar，500毫秒之后變成baz。

這一點與 CommonJS 規范完全不同。CommonJS 模塊輸出的是值的緩存，不存在動態更新，詳見下文《ES6模塊加載的實質》一節。

最后，export命令可以出現在模塊的任何位置，只要處于模塊頂層就可以。如果處于塊級作用域內，就會報錯，下一節的import命令也是如此。這是因為處于條件代碼塊之中，就沒法做靜態優化了，違背了ES6模塊的設計初衷。

function foo() { export default 'bar' // SyntaxError } foo() 

上面代碼中，export語句放在函數之中，結果報錯。

import 命令

使用export命令定義了模塊的對外接口以后，其他 JS 文件就可以通過import命令加載這個模塊。

// main.js
import {firstName, lastName, year} from './profile'; function setName(element) { element.textContent = firstName + ' ' + lastName; } 

上面代碼的import命令，用于加載profile.js文件，并從中輸入變量。import命令接受一對大括號，里面指定要從其他模塊導入的變量名。大括號里面的變量名，必須與被導入模塊（profile.js）對外接口的名稱相同。

如果想為輸入的變量重新取一個名字，import命令要使用as關鍵字，將輸入的變量重命名。

import { lastName as surname } from './profile'; 

import后面的from指定模塊文件的位置，可以是相對路徑，也可以是絕對路徑，.js路徑可以省略。如果只是模塊名，不帶有路徑，那么必須有配置文件，告訴 JavaScript 引擎該模塊的位置。

import {myMethod} from 'util'; 

上面代碼中，util是模塊文件名，由于不帶有路徑，必須通過配置，告訴引擎怎么取到這個模塊。

注意，import命令具有提升效果，會提升到整個模塊的頭部，首先執行。

foo(); import { foo } from 'my_module'; 

上面的代碼不會報錯，因為import的執行早于foo的調用。這種行為的本質是，import命令是編譯階段執行的，在代碼運行之前。

由于import是靜態執行，所以不能使用表達式和變量，這些只有在運行時才能得到結果的語法結構。

// 報錯
import { 'f' + 'oo' } from 'my_module';  // 報錯 let module = 'my_module'; import { foo } from module;  // 報錯 if (x === 1) { import { foo } from 'module1'; } else { import { foo } from 'module2'; } 

上面三種寫法都會報錯，因為它們用到了表達式、變量和if結構。在靜態分析階段，這些語法都是沒法得到值的。

最后，import語句會執行所加載的模塊，因此可以有下面的寫法。

import 'lodash';

上面代碼僅僅執行lodash模塊，但是不輸入任何值。

如果多次重復執行同一句import語句，那么只會執行一次，而不會執行多次。

import 'lodash';
import 'lodash'; 

上面代碼加載了兩次lodash，但是只會執行一次。

import { foo } from 'my_module'; import { bar } from 'my_module';  // 等同于 import { foo, bar } from 'my_module'; 

上面代碼中，雖然foo和bar在兩個語句中加載，但是它們對應的是同一個my_module實例。也就是說，import語句是 Singleton 模式。

模塊的整體加載

除了指定加載某個輸出值，還可以使用整體加載，即用星號（*）指定一個對象，所有輸出值都加載在這個對象上面。

下面是一個circle.js文件，它輸出兩個方法area和circumference。

// circle.jsexport function area(radius) { return Math.PI * radius * radius; } export function circumference(radius) { return 2 * Math.PI * radius; } 

現在，加載這個模塊。

// main.jsimport { area, circumference } from './circle'; console.log('圓面積：' + area(4)); console.log('圓周長：' + circumference(14)); 

上面寫法是逐一指定要加載的方法，整體加載的寫法如下。

import * as circle from './circle';console.log('圓面積：' + circle.area(4)); console.log('圓周長：' + circle.circumference(14)); 

注意，模塊整體加載所在的那個對象（上例是circle），應該是可以靜態分析的，所以不允許運行時改變。下面的寫法都是不允許的。

import * as circle from './circle';
 // 下面兩行都是不允許的 circle.foo = 'hello'; circle.area = function () {}; 

export default 命令

從前面的例子可以看出，使用import命令的時候，用戶需要知道所要加載的變量名或函數名，否則無法加載。但是，用戶肯定希望快速上手，未必愿意閱讀文檔，去了解模塊有哪些屬性和方法。

為了給用戶提供方便，讓他們不用閱讀文檔就能加載模塊，就要用到export default命令，為模塊指定默認輸出。

// export-default.js
export default function () { console.log('foo'); } 

上面代碼是一個模塊文件export-default.js，它的默認輸出是一個函數。

其他模塊加載該模塊時，import命令可以為該匿名函數指定任意名字。

// import-default.js
import customName from './export-default';
customName(); // 'foo' 

上面代碼的import命令，可以用任意名稱指向export-default.js輸出的方法，這時就不需要知道原模塊輸出的函數名。需要注意的是，這時import命令后面，不使用大括號。

export default命令用在非匿名函數前，也是可以的。

// export-default.js
export default function foo() { console.log('foo'); }  // 或者寫成 function foo() { console.log('foo'); } export default foo; 

上面代碼中，foo函數的函數名foo，在模塊外部是無效的。加載的時候，視同匿名函數加載。

下面比較一下默認輸出和正常輸出。

// 第一組
export default function crc32() { // 輸出  // ... } import crc32 from 'crc32'; // 輸入  // 第二組 export function crc32() { // 輸出  // ... }; import {crc32} from 'crc32'; // 輸入 

上面代碼的兩組寫法，第一組是使用export default時，對應的import語句不需要使用大括號；第二組是不使用export default時，對應的import語句需要使用大括號。

export default命令用于指定模塊的默認輸出。顯然，一個模塊只能有一個默認輸出，因此export default命令只能使用一次。所以，import命令后面才不用加大括號，因為只可能對應一個方法。

本質上，export default就是輸出一個叫做default的變量或方法，然后系統允許你為它取任意名字。所以，下面的寫法是有效的。

// modules.js
function add(x, y) { return x * y; } export {add as default}; // 等同于 // export default add;  // app.js import { default as xxx } from 'modules'; // 等同于 // import xxx from 'modules'; 

正是因為export default命令其實只是輸出一個叫做default的變量，所以它后面不能跟變量聲明語句。

// 正確
export var a = 1;  // 正確 var a = 1; export default a;  // 錯誤 export default var a = 1; 

上面代碼中，export default a的含義是將變量a的值賦給變量default。所以，最后一種寫法會報錯。

同樣地，因為export default本質是將該命令后面的值，賦給default變量以后再默認，所以直接將一個值寫在export default之后。

// 正確
export default 42;
 // 報錯 export 42; 

上面代碼中，后一句報錯是因為沒有指定對外的接口，而前一句指定外對接口為default。

有了export default命令，輸入模塊時就非常直觀了，以輸入 lodash 模塊為例。

import _ from 'lodash';

如果想在一條import語句中，同時輸入默認方法和其他變量，可以寫成下面這樣。

import _, { each } from 'lodash'; 

對應上面代碼的export語句如下。

export default function (obj) {  // ··· } export function each(obj, iterator, context) {  // ··· } export { each as forEach }; 

上面代碼的最后一行的意思是，暴露出forEach接口，默認指向each接口，即forEach和each指向同一個方法。

export default也可以用來輸出類。

// MyClass.js
export default class { ... }  // main.js import MyClass from 'MyClass'; let o = new MyClass(); 

export 與 import 的復合寫法

如果在一個模塊之中，先輸入后輸出同一個模塊，import語句可以與export語句寫在一起。

export { foo, bar } from 'my_module';  // 等同于 import { foo, bar } from 'my_module'; export { foo, bar }; 

上面代碼中，export和import語句可以結合在一起，寫成一行。

模塊的接口改名和整體輸出，也可以采用這種寫法。

// 接口改名
export { foo as myFoo } from 'my_module';  // 整體輸出 export * from 'my_module'; 

默認接口的寫法如下。

export { default } from 'foo'; 

具名接口改為默認接口的寫法如下。

export { es6 as default } from './someModule';  // 等同于 import { es6 } from './someModule'; export default es6; 

同樣地，默認接口也可以改名為具名接口。

export { default as es6 } from './someModule'; 

下面三種import語句，沒有對應的復合寫法。

import * as someIdentifier from "someModule";
import someIdentifier from "someModule"; import someIdentifier, { namedIdentifier } from "someModule"; 

為了做到形式的對稱，現在有提案，提出補上這三種復合寫法。

export * as someIdentifier from "someModule";
export someIdentifier from "someModule"; export someIdentifier, { namedIdentifier } from "someModule"; 

模塊的繼承

模塊之間也可以繼承。

假設有一個circleplus模塊，繼承了circle模塊。

// circleplus.jsexport * from 'circle'; export var e = 2.71828182846; export default function(x) { return Math.exp(x); } 

上面代碼中的export *，表示再輸出circle模塊的所有屬性和方法。注意，export *命令會忽略circle模塊的default方法。然后，上面代碼又輸出了自定義的e變量和默認方法。

這時，也可以將circle的屬性或方法，改名后再輸出。

// circleplus.jsexport { area as circleArea } from 'circle'; 

上面代碼表示，只輸出circle模塊的area方法，且將其改名為circleArea。

加載上面模塊的寫法如下。

// main.jsimport * as math from 'circleplus'; import exp from 'circleplus'; console.log(exp(math.e)); 

上面代碼中的import exp表示，將circleplus模塊的默認方法加載為exp方法。

跨模塊常量

本書介紹const命令的時候說過，const聲明的常量只在當前代碼塊有效。如果想設置跨模塊的常量（即跨多個文件），或者說一個值要被多個模塊共享，可以采用下面的寫法。

// constants.js 模塊
export const A = 1; export const B = 3; export const C = 4;  // test1.js 模塊 import * as constants from './constants'; console.log(constants.A); // 1 console.log(constants.B); // 3  // test2.js 模塊 import {A, B} from './constants'; console.log(A); // 1 console.log(B); // 3 

如果要使用的常量非常多，可以建一個專門的constants目錄，將各種常量寫在不同的文件里面，保存在該目錄下。

// constants/db.js
export const db = {url: 'http://my.couchdbserver.local:5984', admin_username: 'admin', admin_password: 'admin password' };  // constants/user.js export const users = ['root', 'admin', 'staff', 'ceo', 'chief', 'moderator']; 

然后，將這些文件輸出的常量，合并在index.js里面。

// constants/index.js
export {db} from './db'; export {users} from './users'; 

使用的時候，直接加載index.js就可以了。

// script.js
import {db, users} from './constants'; 

import()

簡介

前面介紹過，import命令會被 JavaScript 引擎靜態分析，先于模塊內的其他模塊執行（叫做”連接“更合適）。所以，下面的代碼會報錯。

// 報錯
if (x === 2) { import MyModual from './myModual'; } 

上面代碼中，引擎處理import語句是在編譯時，這時不會去分析或執行if語句，所以import語句放在if代碼塊之中毫無意義，因此會報句法錯誤，而不是執行時錯誤。也就是說，import和export命令只能在模塊的頂層，不能在代碼塊之中（比如，在if代碼塊之中，或在函數之中）。

這樣的設計，固然有利于編譯器提高效率，但也導致無法在運行時加載模塊。從語法上，條件加載就不可能實現。如果import命令要取代 Node 的require方法，這就形成了一個障礙。因為require是運行時加載模塊，import命令無法取代require的動態加載功能。

const path = './' + fileName; const myModual = require(path); 

上面的語句就是動態加載，require到底加載哪一個模塊，只有運行時才知道。import語句做不到這一點。

因此，有一個提案，建議引入import()函數，完成動態加載。

import(specifier)

上面代碼中，import函數的參數specifier，指定所要加載的模塊的位置。import命令能夠接受什么參數，import()函數就能接受什么參數，兩者區別主要是后者為動態加載。

import()返回一個 Promise 對象。下面是一個例子。

const main = document.querySelector('main'); import(`./section-modules/${someVariable}.js`) .then(module => { module.loadPageInto(main); }) .catch(err => { main.textContent = err.message; }); 

import()函數可以用在任何地方，不僅僅是模塊，非模塊的腳本也可以使用。它是運行時執行，也就是說，什么時候運行到這一句，也會加載指定的模塊。另外，import()函數與所加載的模塊沒有靜態連接關系，這點也是與import語句不相同。

import()類似于 Node 的require方法，區別主要是前者是異步加載，后者是同步加載。

適用場合

下面是import()的一些適用場合。

（1）按需加載。

import()可以在需要的時候，再加載某個模塊。

button.addEventListener('click', event => { import('./dialogBox.js') .then(dialogBox => { dialogBox.open(); }) .catch(error => { /* Error handling */ }) }); 

上面代碼中，import()方法放在click事件的監聽函數之中，只有用戶點擊了按鈕，才會加載這個模塊。

（2）條件加載

import()可以放在if代碼塊，根據不同的情況，加載不同的模塊。

if (condition) { import('moduleA').then(...); } else { import('moduleB').then(...); } 

上面代碼中，如果滿足條件，就加載模塊 A，否則加載模塊 B。

（3）動態的模塊路徑

import()允許模塊路徑動態生成。

import(f()) .then(...); 

上面代碼中，根據函數f的返回結果，加載不同的模塊。

注意點

import()加載模塊成功以后，這個模塊會作為一個對象，當作then方法的參數。因此，可以使用對象解構賦值的語法，獲取輸出接口。

import('./myModule.js') .then(({export1, export2}) => {  // ...· }); 

上面代碼中，export1和export2都是myModule.js的輸出接口，可以解構獲得。

如果模塊有default輸出接口，可以用參數直接獲得。

import('./myModule.js') .then(myModule => { console.log(myModule.default); }); 

上面的代碼也可以使用具名輸入的形式。

import('./myModule.js') .then(({default: theDefault}) => { console.log(theDefault); }); 

如果想同時加載多個模塊，可以采用下面的寫法。

Promise.all([ import('./module1.js'), import('./module2.js'), import('./module3.js'), ]) .then(([module1, module2, module3]) => { ··· }); 

import()也可以用在 async 函數之中。

async function main() { const myModule = await import('./myModule.js'); const {export1, export2} = await import('./myModule.js'); const [module1, module2, module3] = await Promise.all([ import('./module1.js'), import('./module2.js'), import('./module3.js'), ]); } main();