ES6 Module 的語(yǔ)法

2020-06-11 14:49 更新

1. 概述

歷史上,JavaScript 一直沒(méi)有模塊(module)體系,無(wú)法將一個(gè)大程序拆分成互相依賴的小文件,再用簡(jiǎn)單的方法拼裝起來(lái)。其他語(yǔ)言都有這項(xiàng)功能,比如 Ruby 的 require 、Python 的 import ,甚至就連 CSS 都有 @import ,但是 JavaScript 任何這方面的支持都沒(méi)有,這對(duì)開(kāi)發(fā)大型的、復(fù)雜的項(xiàng)目形成了巨大障礙。

在 ES6 之前,社區(qū)制定了一些模塊加載方案,最主要的有CommonJSAMD兩種。前者用于服務(wù)器,后者用于瀏覽器。ES6 在語(yǔ)言標(biāo)準(zhǔn)的層面上,實(shí)現(xiàn)了模塊功能,而且實(shí)現(xiàn)得相當(dāng)簡(jiǎn)單,完全可以取代 CommonJS 和 AMD 規(guī)范,成為瀏覽器和服務(wù)器通用的模塊解決方案。

ES6 模塊的設(shè)計(jì)思想是盡量的靜態(tài)化,使得編譯時(shí)就能確定模塊的依賴關(guān)系,以及輸入和輸出的變量。CommonJS 和 AMD 模塊,都只能在運(yùn)行時(shí)確定這些東西。比如,CommonJS 模塊就是對(duì)象,輸入時(shí)必須查找對(duì)象屬性。

// CommonJS模塊
let { stat, exists, readfile } = require('fs');


// 等同于
let _fs = require('fs');
let stat = _fs.stat;
let exists = _fs.exists;
let readfile = _fs.readfile;

上面代碼的實(shí)質(zhì)是整體加載 fs 模塊(即加載 fs 的所有方法),生成一個(gè)對(duì)象( _fs ),然后再?gòu)倪@個(gè)對(duì)象上面讀取 3 個(gè)方法。這種加載稱為“運(yùn)行時(shí)加載”,因?yàn)橹挥羞\(yùn)行時(shí)才能得到這個(gè)對(duì)象,導(dǎo)致完全沒(méi)辦法在編譯時(shí)做“靜態(tài)優(yōu)化”。

ES6 模塊不是對(duì)象,而是通過(guò) export 命令顯式指定輸出的代碼,再通過(guò) import 命令輸入。

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

上面代碼的實(shí)質(zhì)是從 fs 模塊加載 3 個(gè)方法,其他方法不加載。這種加載稱為“編譯時(shí)加載”或者靜態(tài)加載,即 ES6 可以在編譯時(shí)就完成模塊加載,效率要比 CommonJS 模塊的加載方式高。當(dāng)然,這也導(dǎo)致了沒(méi)法引用 ES6 模塊本身,因?yàn)樗皇菍?duì)象。

由于 ES6 模塊是編譯時(shí)加載,使得靜態(tài)分析成為可能。有了它,就能進(jìn)一步拓寬 JavaScript 的語(yǔ)法,比如引入宏(macro)和類型檢驗(yàn)(type system)這些只能靠靜態(tài)分析實(shí)現(xiàn)的功能。

除了靜態(tài)加載帶來(lái)的各種好處,ES6 模塊還有以下好處。

  • 不再需要 UMD 模塊格式了,將來(lái)服務(wù)器和瀏覽器都會(huì)支持 ES6 模塊格式。目前,通過(guò)各種工具庫(kù),其實(shí)已經(jīng)做到了這一點(diǎn)。
  • 將來(lái)瀏覽器的新 API 就能用模塊格式提供,不再必須做成全局變量或者 navigator 對(duì)象的屬性。
  • 不再需要對(duì)象作為命名空間(比如 Math 對(duì)象),未來(lái)這些功能可以通過(guò)模塊提供。

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

2. 嚴(yán)格模式

ES6 的模塊自動(dòng)采用嚴(yán)格模式,不管你有沒(méi)有在模塊頭部加上 "use strict"; 。

嚴(yán)格模式主要有以下限制。

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

上面這些限制,模塊都必須遵守。由于嚴(yán)格模式是 ES5 引入的,不屬于 ES6,所以請(qǐng)參閱相關(guān) ES5 書(shū)籍,本書(shū)不再詳細(xì)介紹了。

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

3. export 命令

模塊功能主要由兩個(gè)命令構(gòu)成:exportimport 。 export 命令用于規(guī)定模塊的對(duì)外接口, import 命令用于輸入其他模塊提供的功能。

一個(gè)模塊就是一個(gè)獨(dú)立的文件。該文件內(nèi)部的所有變量,外部無(wú)法獲取。如果你希望外部能夠讀取模塊內(nèi)部的某個(gè)變量,就必須使用 export 關(guān)鍵字輸出該變量。下面是一個(gè) JS 文件,里面使用 export 命令輸出變量。

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

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

export 的寫(xiě)法,除了像上面這樣,還有另外一種。

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


export { firstName, lastName, year };

上面代碼在 export 命令后面,使用大括號(hào)指定所要輸出的一組變量。它與前一種寫(xiě)法(直接放置在 var 語(yǔ)句前)是等價(jià)的,但是應(yīng)該優(yōu)先考慮使用這種寫(xiě)法。因?yàn)檫@樣就可以在腳本尾部,一眼看清楚輸出了哪些變量。

export 命令除了輸出變量,還可以輸出函數(shù)或類(class)。

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

上面代碼對(duì)外輸出一個(gè)函數(shù) multiply 。

通常情況下, export 輸出的變量就是本來(lái)的名字,但是可以使用 as 關(guān)鍵字重命名。

function v1() { ... }
function v2() { ... }


export {
  v1 as streamV1,
  v2 as streamV2,
  v2 as streamLatestVersion
};

上面代碼使用 as 關(guān)鍵字,重命名了函數(shù) v1 和 v2 的對(duì)外接口。重命名后, v2 可以用不同的名字輸出兩次。

需要特別注意的是, export 命令規(guī)定的是對(duì)外的接口,必須與模塊內(nèi)部的變量建立一一對(duì)應(yīng)關(guān)系。

// 報(bào)錯(cuò)
export 1;


// 報(bào)錯(cuò)
var m = 1;
export m;

上面兩種寫(xiě)法都會(huì)報(bào)錯(cuò),因?yàn)闆](méi)有提供對(duì)外的接口。第一種寫(xiě)法直接輸出 1,第二種寫(xiě)法通過(guò)變量 m ,還是直接輸出 1。 1 只是一個(gè)值,不是接口。正確的寫(xiě)法是下面這樣。

// 寫(xiě)法一
export var m = 1;


// 寫(xiě)法二
var m = 1;
export {m};


// 寫(xiě)法三
var n = 1;
export {n as m};

上面三種寫(xiě)法都是正確的,規(guī)定了對(duì)外的接口 m 。其他腳本可以通過(guò)這個(gè)接口,取到值 1 。它們的實(shí)質(zhì)是,在接口名與模塊內(nèi)部變量之間,建立了一一對(duì)應(yīng)的關(guān)系。

同樣的, function 和 class 的輸出,也必須遵守這樣的寫(xiě)法。

// 報(bào)錯(cuò)
function f() {}
export f;


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


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

另外, export 語(yǔ)句輸出的接口,與其對(duì)應(yīng)的值是動(dòng)態(tài)綁定關(guān)系,即通過(guò)該接口,可以取到模塊內(nèi)部實(shí)時(shí)的值。

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

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

這一點(diǎn)與 CommonJS 規(guī)范完全不同。CommonJS 模塊輸出的是值的緩存,不存在動(dòng)態(tài)更新,詳見(jiàn)下文《Module 的加載實(shí)現(xiàn)》一節(jié)。

最后, export 命令可以出現(xiàn)在模塊的任何位置,只要處于模塊頂層就可以。如果處于塊級(jí)作用域內(nèi),就會(huì)報(bào)錯(cuò),下一節(jié)的 import 命令也是如此。這是因?yàn)樘幱跅l件代碼塊之中,就沒(méi)法做靜態(tài)優(yōu)化了,違背了 ES6 模塊的設(shè)計(jì)初衷。

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

上面代碼中, export 語(yǔ)句放在函數(shù)之中,結(jié)果報(bào)錯(cuò)。

4. import 命令

使用export 命令定義了模塊的對(duì)外接口以后,其他JS文件就可以通過(guò)import命令加載這個(gè)模塊。

// main.js
import { firstName, lastName, year } from './profile.js';


function setName(element) {
  element.textContent = firstName + ' ' + lastName;
}

上面代碼的 import 命令,用于加載 profile.js 文件,并從中輸入變量。 import 命令接受一對(duì)大括號(hào),里面指定要從其他模塊導(dǎo)入的變量名。大括號(hào)里面的變量名,必須與被導(dǎo)入模塊( profile.js )對(duì)外接口的名稱相同。

如果想為輸入的變量重新取一個(gè)名字, import 命令要使用 as 關(guān)鍵字,將輸入的變量重命名。

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

import 命令輸入的變量都是只讀的,因?yàn)樗谋举|(zhì)是輸入接口。也就是說(shuō),不允許在加載模塊的腳本里面,改寫(xiě)接口。

import {a} from './xxx.js'


a = {}; // Syntax Error : 'a' is read-only;

上面代碼中,腳本加載了變量 a ,對(duì)其重新賦值就會(huì)報(bào)錯(cuò),因?yàn)?a 是一個(gè)只讀的接口。但是,如果 a 是一個(gè)對(duì)象,改寫(xiě) a 的屬性是允許的。

import {a} from './xxx.js'


a.foo = 'hello'; // 合法操作

上面代碼中, a 的屬性可以成功改寫(xiě),并且其他模塊也可以讀到改寫(xiě)后的值。不過(guò),這種寫(xiě)法很難查錯(cuò),建議凡是輸入的變量,都當(dāng)作完全只讀,不要輕易改變它的屬性。

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

import {myMethod} from 'util';

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

注意, import 命令具有提升效果,會(huì)提升到整個(gè)模塊的頭部,首先執(zhí)行。

foo();


import { foo } from 'my_module';

上面的代碼不會(huì)報(bào)錯(cuò),因?yàn)?import 的執(zhí)行早于 foo 的調(diào)用。這種行為的本質(zhì)是, import 命令是編譯階段執(zhí)行的,在代碼運(yùn)行之前。

由于 import 是靜態(tài)執(zhí)行,所以不能使用表達(dá)式和變量,這些只有在運(yùn)行時(shí)才能得到結(jié)果的語(yǔ)法結(jié)構(gòu)。

// 報(bào)錯(cuò)
import { 'f' + 'oo' } from 'my_module';


// 報(bào)錯(cuò)
let module = 'my_module';
import { foo } from module;


// 報(bào)錯(cuò)
if (x === 1) {
  import { foo } from 'module1';
} else {
  import { foo } from 'module2';
}

上面三種寫(xiě)法都會(huì)報(bào)錯(cuò),因?yàn)樗鼈冇玫搅吮磉_(dá)式、變量和 if 結(jié)構(gòu)。在靜態(tài)分析階段,這些語(yǔ)法都是沒(méi)法得到值的。

最后, import 語(yǔ)句會(huì)執(zhí)行所加載的模塊,因此可以有下面的寫(xiě)法。

import 'lodash';

上面代碼僅僅執(zhí)行 lodash 模塊,但是不輸入任何值。

如果多次重復(fù)執(zhí)行同一句 import 語(yǔ)句,那么只會(huì)執(zhí)行一次,而不會(huì)執(zhí)行多次。

import 'lodash';
import 'lodash';

上面代碼加載了兩次 lodash ,但是只會(huì)執(zhí)行一次。

import { foo } from 'my_module';
import { bar } from 'my_module';


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

上面代碼中,雖然 foo 和 bar 在兩個(gè)語(yǔ)句中加載,但是它們對(duì)應(yīng)的是同一個(gè) my_module 實(shí)例。也就是說(shuō), import 語(yǔ)句是 Singleton 模式。

目前階段,通過(guò) Babel 轉(zhuǎn)碼,CommonJS 模塊的 require 命令和 ES6 模塊的 import 命令,可以寫(xiě)在同一個(gè)模塊里面,但是最好不要這樣做。因?yàn)?import 在靜態(tài)解析階段執(zhí)行,所以它是一個(gè)模塊之中最早執(zhí)行的。下面的代碼可能不會(huì)得到預(yù)期結(jié)果。

require('core-js/modules/es6.symbol');
require('core-js/modules/es6.promise');
import React from 'React';

5. 模塊的整體加載

除了指定加載某個(gè)輸出值,還可以使用整體加載,即用星號(hào)( * )指定一個(gè)對(duì)象,所有輸出值都加載在這個(gè)對(duì)象上面。

下面是一個(gè) circle.js 文件,它輸出兩個(gè)方法 area 和 circumference 。

// circle.js


export function area(radius) {
  return Math.PI * radius * radius;
}


export function circumference(radius) {
  return 2 * Math.PI * radius;
}

現(xiàn)在,加載這個(gè)模塊。

// main.js


import { area, circumference } from './circle';


console.log('圓面積:' + area(4));
console.log('圓周長(zhǎng):' + circumference(14));

上面寫(xiě)法是逐一指定要加載的方法,整體加載的寫(xiě)法如下。

import * as circle from './circle';


console.log('圓面積:' + circle.area(4));
console.log('圓周長(zhǎng):' + circle.circumference(14));

注意,模塊整體加載所在的那個(gè)對(duì)象(上例是 circle ),應(yīng)該是可以靜態(tài)分析的,所以不允許運(yùn)行時(shí)改變。下面的寫(xiě)法都是不允許的。

import * as circle from './circle';


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

6. export default 命令

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

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

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

上面代碼是一個(gè)模塊文件 export-default.js ,它的默認(rèn)輸出是一個(gè)函數(shù)。

其他模塊加載該模塊時(shí), import 命令可以為該匿名函數(shù)指定任意名字。

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

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

export default 命令用在非匿名函數(shù)前,也是可以的。

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


// 或者寫(xiě)成


function foo() {
  console.log('foo');
}


export default foo;

上面代碼中, foo 函數(shù)的函數(shù)名 foo ,在模塊外部是無(wú)效的。加載的時(shí)候,視同匿名函數(shù)加載。

下面比較一下默認(rèn)輸出和正常輸出。

// 第一組
export default function crc32() { // 輸出
  // ...
}


import crc32 from 'crc32'; // 輸入


// 第二組
export function crc32() { // 輸出
  // ...
};


import {crc32} from 'crc32'; // 輸入

上面代碼的兩組寫(xiě)法,第一組是使用 export default 時(shí),對(duì)應(yīng)的 import 語(yǔ)句不需要使用大括號(hào);第二組是不使用 export default 時(shí),對(duì)應(yīng)的 import 語(yǔ)句需要使用大括號(hào)。

export default 命令用于指定模塊的默認(rèn)輸出。顯然,一個(gè)模塊只能有一個(gè)默認(rèn)輸出,因此 export default 命令只能使用一次。所以,import命令后面才不用加大括號(hào),因?yàn)橹豢赡芪ㄒ粚?duì)應(yīng) export default 命令。

本質(zhì)上, export default 就是輸出一個(gè)叫做 default 的變量或方法,然后系統(tǒng)允許你為它取任意名字。所以,下面的寫(xiě)法是有效的。

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


// app.js
import { default as foo } from 'modules';
// 等同于
// import foo from 'modules';

正是因?yàn)?export default 命令其實(shí)只是輸出一個(gè)叫做 default 的變量,所以它后面不能跟變量聲明語(yǔ)句。

// 正確
export var a = 1;


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


// 錯(cuò)誤
export default var a = 1;

上面代碼中, export default a 的含義是將變量 a 的值賦給變量 default 。所以,最后一種寫(xiě)法會(huì)報(bào)錯(cuò)。

同樣地,因?yàn)?export default 命令的本質(zhì)是將后面的值,賦給 default 變量,所以可以直接將一個(gè)值寫(xiě)在 export default 之后。

// 正確
export default 42;


// 報(bào)錯(cuò)
export 42;

上面代碼中,后一句報(bào)錯(cuò)是因?yàn)闆](méi)有指定對(duì)外的接口,而前一句指定對(duì)外接口為 default 。

有了 export default 命令,輸入模塊時(shí)就非常直觀了,以輸入 lodash 模塊為例。

import _ from 'lodash';

如果想在一條 import 語(yǔ)句中,同時(shí)輸入默認(rèn)方法和其他接口,可以寫(xiě)成下面這樣。

import _, { each, forEach } from 'lodash';

對(duì)應(yīng)上面代碼的 export 語(yǔ)句如下。

export default function (obj) {
  // ···
}


export function each(obj, iterator, context) {
  // ···
}


export { each as forEach };

上面代碼的最后一行的意思是,暴露出 forEach 接口,默認(rèn)指向 each 接口,即 forEach 和 each 指向同一個(gè)方法。

export default 也可以用來(lái)輸出類。

// MyClass.js
export default class { ... }


// main.js
import MyClass from 'MyClass';
let o = new MyClass();

7. export 與 import 的復(fù)合寫(xiě)法

如果在一個(gè)模塊之中,先輸入后輸出同一個(gè)模塊, import 語(yǔ)句可以與export 語(yǔ)句寫(xiě)在一起。

export { foo, bar } from 'my_module';


// 可以簡(jiǎn)單理解為
import { foo, bar } from 'my_module';
export { foo, bar };

上面代碼中, export 和 import 語(yǔ)句可以結(jié)合在一起,寫(xiě)成一行。但需要注意的是,寫(xiě)成一行以后, foo 和 bar 實(shí)際上并沒(méi)有被導(dǎo)入當(dāng)前模塊,只是相當(dāng)于對(duì)外轉(zhuǎn)發(fā)了這兩個(gè)接口,導(dǎo)致當(dāng)前模塊不能直接使用 foo 和 bar 。

模塊的接口改名和整體輸出,也可以采用這種寫(xiě)法。

// 接口改名
export { foo as myFoo } from 'my_module';


// 整體輸出
export * from 'my_module';

默認(rèn)接口的寫(xiě)法如下。

export { default } from 'foo';

具名接口改為默認(rèn)接口的寫(xiě)法如下。

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


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

同樣地,默認(rèn)接口也可以改名為具名接口。

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

ES2020 之前,有一種 import 語(yǔ)句,沒(méi)有對(duì)應(yīng)的復(fù)合寫(xiě)法。

import * as someIdentifier from "someModule";

ES2020補(bǔ)上了這個(gè)寫(xiě)法。

export * as ns from "mod";


// 等同于
import * as ns from "mod";
export {ns};

8. 模塊的繼承

模塊之間也可以繼承。

假設(shè)有一個(gè) circleplus 模塊,繼承了 circle 模塊。

// circleplus.js


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

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

這時(shí),也可以將 circle 的屬性或方法,改名后再輸出。

// circleplus.js


export { area as circleArea } from 'circle';

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

加載上面模塊的寫(xiě)法如下。

// main.js


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

上面代碼中的 import exp 表示,將 circleplus 模塊的默認(rèn)方法加載為 exp 方法。

9. 跨模塊常量

本書(shū)介紹 const 命令的時(shí)候說(shuō)過(guò), const 聲明的常量只在當(dāng)前代碼塊有效。如果想設(shè)置跨模塊的常量(即跨多個(gè)文件),或者說(shuō)一個(gè)值要被多個(gè)模塊共享,可以采用下面的寫(xiě)法。

// 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

如果要使用的常量非常多,可以建一個(gè)專門(mén)的 constants 目錄,將各種常量寫(xiě)在不同的文件里面,保存在該目錄下。

// 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';

使用的時(shí)候,直接加載 index.js 就可以了。

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

10. import()

簡(jiǎn)介

前面介紹過(guò),import命令會(huì)被JavaScript 引擎靜態(tài)分析,先于模塊內(nèi)的其他語(yǔ)句執(zhí)行( import 命令叫做“連接” binding 其實(shí)更合適)。所以,下面的代碼會(huì)報(bào)錯(cuò)。

// 報(bào)錯(cuò)
if (x === 2) {
  import MyModual from './myModual';
}

上面代碼中,引擎處理 import 語(yǔ)句是在編譯時(shí),這時(shí)不會(huì)去分析或執(zhí)行 if 語(yǔ)句,所以 import 語(yǔ)句放在 if 代碼塊之中毫無(wú)意義,因此會(huì)報(bào)句法錯(cuò)誤,而不是執(zhí)行時(shí)錯(cuò)誤。也就是說(shuō), import 和 export 命令只能在模塊的頂層,不能在代碼塊之中(比如,在 if 代碼塊之中,或在函數(shù)之中)。

這樣的設(shè)計(jì),固然有利于編譯器提高效率,但也導(dǎo)致無(wú)法在運(yùn)行時(shí)加載模塊。在語(yǔ)法上,條件加載就不可能實(shí)現(xiàn)。如果 import 命令要取代 Node 的 require 方法,這就形成了一個(gè)障礙。因?yàn)?require 是運(yùn)行時(shí)加載模塊, import 命令無(wú)法取代 require 的動(dòng)態(tài)加載功能。

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

上面的語(yǔ)句就是動(dòng)態(tài)加載, require 到底加載哪一個(gè)模塊,只有運(yùn)行時(shí)才知道。 import 命令做不到這一點(diǎn)。

ES2020提案 引入 import() 函數(shù),支持動(dòng)態(tài)加載模塊。

import(specifier)

上面代碼中, import 函數(shù)的參數(shù) specifier ,指定所要加載的模塊的位置。 import 命令能夠接受什么參數(shù), import() 函數(shù)就能接受什么參數(shù),兩者區(qū)別主要是后者為動(dòng)態(tài)加載。

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

const main = document.querySelector('main');


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

import() 函數(shù)可以用在任何地方,不僅僅是模塊,非模塊的腳本也可以使用。它是運(yùn)行時(shí)執(zhí)行,也就是說(shuō),什么時(shí)候運(yùn)行到這一句,就會(huì)加載指定的模塊。另外, import() 函數(shù)與所加載的模塊沒(méi)有靜態(tài)連接關(guān)系,這點(diǎn)也是與 import 語(yǔ)句不相同。 import() 類似于 Node 的 require 方法,區(qū)別主要是前者是異步加載,后者是同步加載。

適用場(chǎng)合

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

(1)按需加載。

import() 可以在需要的時(shí)候,再加載某個(gè)模塊。

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

上面代碼中, import() 方法放在 click 事件的監(jiān)聽(tīng)函數(shù)之中,只有用戶點(diǎn)擊了按鈕,才會(huì)加載這個(gè)模塊。

(2)條件加載

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

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

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

(3)動(dòng)態(tài)的模塊路徑

import() 允許模塊路徑動(dòng)態(tài)生成。

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

上面代碼中,根據(jù)函數(shù) f 的返回結(jié)果,加載不同的模塊。

注意點(diǎn)

import() 加載模塊成功以后,這個(gè)模塊會(huì)作為一個(gè)對(duì)象,當(dāng)作 then 方法的參數(shù)。因此,可以使用對(duì)象解構(gòu)賦值的語(yǔ)法,獲取輸出接口。

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

上面代碼中, export1 和 export2 都是 myModule.js 的輸出接口,可以解構(gòu)獲得。

如果模塊有 default 輸出接口,可以用參數(shù)直接獲得。

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

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

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

如果想同時(shí)加載多個(gè)模塊,可以采用下面的寫(xiě)法。

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

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

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();
以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)