ECMAScript——Module的语法

Posted 2022-09-30 layabox

 

1.简介

在 ES6 之前，社区制定了一些模块加载方案，最主要的有 CommonJS 和 AMD 两种。前者用于服务器，后者用于浏览器

1 // CommonJS模块
2 let  stat, exists, readFile  = require(‘fs‘);
3 
4 // 等同于
5 let _fs = require(‘fs‘);
6 let stat = _fs.stat;
7 let exists = _fs.exists;
8 let readfile = _fs.readfile;

上面代码的实质是整体加载fs模块（即加载fs的所有方法），生成一个对象（_fs），然后再从这个对象上面读取 3 个方法。这种加载称为“运行时加载”，因为只有运行时才能得到这个对象，导致完全没办法在编译时做“静态优化”

 

ES6 可以在编译时就完成模块加载，效率要比 CommonJS 模块的加载方式高

// ES6模块
import  stat, exists, readFile  from ‘fs‘;

上面代码的实质是从fs模块加载 3 个方法，其他方法不加载。这种加载称为“编译时加载”或者静态加载

当然，这也导致了没法引用 ES6 模块本身，因为它不是对象

由于 ES6 模块是编译时加载，使得静态分析成为可能。有了它，就能进一步拓宽 javascript 的语法，比如引入宏（macro）和类型检验（type system）这些只能靠静态分析实现的功能

除了静态加载带来的各种好处，ES6 模块还有以下好处

不再需要UMD模块格式了，将来服务器和浏览器都会支持 ES6 模块格式。目前，通过各种工具库，其实已经做到了这一点。
将来浏览器的新 API 就能用模块格式提供，不再必须做成全局变量或者navigator对象的属性。
不再需要对象作为命名空间（比如Math对象），未来这些功能可以通过模块提供。

 

 

2.严格模式

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）

其中，尤其需要注意this的限制。ES6 模块之中，顶层的this指向undefined，即不应该在顶层代码使用this

 

 

3.export 命令

一个模块就是一个独立的文件。如果你希望外部能够读取模块内部的某个变量，就必须使用export关键字输出该变量

1 // profile.js
2 export var firstName = ‘Michael‘;
3 export var lastName = ‘Jackson‘;
4 export var year = 1958;

export的写法，除了像上面这样，还有另外一种

1 // profile.js
2 var firstName = ‘Michael‘;
3 var lastName = ‘Jackson‘;
4 var year = 1958;
5 
6 export  firstName, lastName, year ;

 

export命令除了输出变量，还可以输出函数或类（class）

1 export function multiply(x, y) 
2   return x * y;
3 ;

 

通常情况下，export输出的变量就是本来的名字，但是可以使用as关键字重命名

1 function v1()  ... 
2 function v2()  ... 
3 
4 export 
5   v1 as streamV1,
6   v2 as streamV2,
7   v2 as streamLatestVersion
8 ;

重命名后，v2可以用不同的名字输出两次

 

下面两种写法都会报错

1 // 报错
2 export 1;
3 
4 // 报错
5 var m = 1;
6 export m;

正确的写法是下面这样

 1 // 写法一
 2 export var m = 1;
 3 
 4 // 写法二
 5 var m = 1;
 6 export m;
 7 
 8 // 写法三
 9 var n = 1;
10 export n as m;

 

另外，export语句输出的接口，与其对应的值是动态绑定关系，即通过该接口，可以取到模块内部实时的值。这一点与 CommonJS 规范完全不同。CommonJS 模块输出的是值的缓存，不存在动态更新

最后，export命令可以出现在模块的任何位置，只要处于模块顶层就可以。如果处于块级作用域内，就会报错

1 function foo() 
2   export default ‘bar‘ // SyntaxError
3 
4 foo()

 

 

4.import 命令

使用export命令定义了模块的对外接口以后，其他 JS 文件就可以通过import命令加载这个模块

1 // main.js
2 import  firstName, lastName, year  from ‘./profile.js‘;
3 
4 function setName(element) 
5   element.textContent = firstName + ‘ ‘ + lastName;
6 

如果想为输入的变量重新取一个名字，import命令要使用as关键字，将输入的变量重命名

import  lastName as surname  from ‘./profile.js‘;

 

import命令输入的变量都是只读的，因为它的本质是输入接口。也就是说，不允许在加载模块的脚本里面，改写接口

1 import a from ‘./xxx.js‘
2 
3 a = ; // Syntax Error : ‘a‘ is read-only;

但是，如果a是一个对象，改写a的属性是允许的

1 import a from ‘./xxx.js‘
2 
3 a.foo = ‘hello‘; // 合法操作

 

import后面的from指定模块文件的位置，可以是相对路径，也可以是绝对路径，.js后缀可以省略。如果只是模块名，不带有路径，那么必须有配置文件，告诉 JavaScript 引擎该模块的位置

 

注意，import命令具有提升效果，会提升到整个模块的头部，首先执行

1 foo();
2 
3 import  foo  from ‘my_module‘;

这种行为的本质是，import命令是编译阶段执行的，在代码运行之前

由于import是静态执行，所以不能使用表达式和变量，这些只有在运行时才能得到结果的语法结构

 1 // 报错
 2 import  ‘f‘ + ‘oo‘  from ‘my_module‘;
 3 
 4 // 报错
 5 let module = ‘my_module‘;
 6 import  foo  from module;
 7 
 8 // 报错
 9 if (x === 1) 
10   import  foo  from ‘module1‘;
11  else 
12   import  foo  from ‘module2‘;
13 

 

1 import  foo  from ‘my_module‘;
2 import  bar  from ‘my_module‘;
3 
4 // 等同于
5 import  foo, bar  from ‘my_module‘;

上面代码中，虽然foo和bar在两个语句中加载，但是它们对应的是同一个my_module实例。也就是说，import语句是 Singleton 模式

 

 

5.模块的整体加载

除了指定加载某个输出值，还可以使用整体加载，即用星号（*）指定一个对象，所有输出值都加载在这个对象上面

下面是一个circle.js文件，它输出两个方法area和circumference

1 // circle.js
2 export function area(radius) 
3   return Math.PI * radius * radius;
4 
5 
6 export function circumference(radius) 
7   return 2 * Math.PI * radius;
8 

整体加载的写法如下

1 import * as circle from ‘./circle‘;
2 
3 console.log(‘圆面积：‘ + circle.area(4));
4 console.log(‘圆周长：‘ + circle.circumference(14));

注意，模块整体加载所在的那个对象（上例是circle），应该是可以静态分析的，所以不允许运行时改变。下面的写法都是不允许的

1 import * as circle from ‘./circle‘;
2 
3 // 下面两行都是不允许的
4 circle.foo = ‘hello‘;
5 circle.area = function () ;

 

 

6.export default 命令

下面代码是一个模块文件export-default.js，它的默认输出是一个函数

1 // export-default.js
2 export default function () 
3   console.log(‘foo‘);
4 

其他模块加载该模块时，import命令可以为该匿名函数指定任意名字

1 // import-default.js
2 import customName from ‘./export-default‘;
3 customName(); // ‘foo‘

需要注意的是，这时import命令后面，不使用大括号

export default命令用在非匿名函数前，也是可以的.加载的时候，视同匿名函数加载

下面比较一下默认输出和正常输出

 1 // 第一组
 2 export default function crc32()  // 输出
 3   // ...
 4 
 5 
 6 import crc32 from ‘crc32‘; // 输入
 7 
 8 // 第二组
 9 export function crc32()  // 输出
10   // ...
11 ;
12 
13 import crc32 from ‘crc32‘; // 输入

export default命令用于指定模块的默认输出。显然，一个模块只能有一个默认输出，因此export default命令只能使用一次。所以，import命令后面才不用加大括号，因为只可能唯一对应export default命令

本质上，export default就是输出一个叫做default的变量或方法，然后系统允许你为它取任意名字。所以，下面的写法是有效的

 1 // modules.js
 2 function add(x, y) 
 3   return x * y;
 4 
 5 export add as default;
 6 // 等同于
 7 // export default add;
 8 
 9 // app.js
10 import  default as foo  from ‘modules‘;
11 // 等同于
12 // import foo from ‘modules‘;

正是因为export default命令其实只是输出一个叫做default的变量，所以它后面不能跟变量声明语句

同样地，因为export default命令的本质是将后面的值，赋给default变量，所以可以直接将一个值写在export default之后

1 // 正确
2 export default 42;
3 
4 // 报错
5 export 42;

如果想在一条import语句中，同时输入默认方法和其他接口，以输入 lodash 模块为例，可以写成下面这样

import _,  each, forEach  from ‘lodash‘;

 

 

7.export 与 import 的复合写法

如果在一个模块之中，先输入后输出同一个模块，import语句可以与export语句写在一起

1 export  foo, bar  from ‘my_module‘;
2 
3 // 可以简单理解为
4 import  foo, bar  from ‘my_module‘;
5 export  foo, bar ;

但需要注意的是，写成一行以后，foo和bar实际上并没有被导入当前模块，只是相当于对外转发了这两个接口，导致当前模块不能直接使用foo和bar

模块的接口改名和整体输出，也可以采用这种写法

1 // 接口改名
2 export  foo as myFoo  from ‘my_module‘;
3 
4 // 整体输出
5 export * from ‘my_module‘;

默认接口的写法如下

export  default  from ‘foo‘;

 

 

8.模块的继承

模块之间也可以继承

假设有一个circleplus模块，继承了circle模块

1 // circleplus.js
2 export * from ‘circle‘;
3 export var e = 2.71828182846;
4 export default function(x) 
5   return Math.exp(x);
6 

 

 

9.跨模块常量

本书介绍const命令的时候说过，const声明的常量只在当前代码块有效。如果想设置跨模块的常量（即跨多个文件），或者说一个值要被多个模块共享，可以采用下面的写法

 1 // constants.js 模块
 2 export const A = 1;
 3 export const B = 3;
 4 export const C = 4;
 5 
 6 // test1.js 模块
 7 import * as constants from ‘./constants‘;
 8 console.log(constants.A); // 1
 9 console.log(constants.B); // 3
10 
11 // test2.js 模块
12 import A, B from ‘./constants‘;
13 console.log(A); // 1
14 console.log(B); // 3

如果要使用的常量非常多，可以建一个专门的constants目录，将各种常量写在不同的文件里面，保存在该目录下

1 // constants/db.js
2 export const db = 
3   url: ‘http://my.couchdbserver.local:5984‘,
4   admin_username: ‘admin‘,
5   admin_password: ‘admin password‘
6 ;
7 
8 // constants/user.js
9 export const users = [‘root‘, ‘admin‘, ‘staff‘, ‘ceo‘, ‘chief‘, ‘moderator‘];

然后，将这些文件输出的常量，合并在index.js里面

1 // constants/index.js
2 export db from ‘./db‘;
3 export users from ‘./users‘;

使用的时候，直接加载index.js就可以了

// script.js
import db, users from ‘./constants/index‘;

 

 

10.import()

import命令的设计，固然有利于编译器提高效率，但也导致无法在运行时加载模块。在语法上，条件加载就不可能实现。如果import命令要取代 Node 的require方法，这就形成了一个障碍。因为require是运行时加载模块，import命令无法取代require的动态加载功能

因此，有一个提案，建议引入import()函数，完成动态加载

import(specifier)

上面代码中，import函数的参数specifier，指定所要加载的模块的位置。import命令能够接受什么参数，import()函数就能接受什么参数，两者区别主要是后者为动态加载

import()返回一个 Promise 对象。下面是一个例子

1 const main = document.querySelector(‘main‘);
2 
3 import(`./section-modules/$someVariable.js`)
4   .then(module => 
5     module.loadPageInto(main);
6   )
7   .catch(err => 
8     main.textContent = err.message;
9   );

import()函数可以用在任何地方，不仅仅是模块，非模块的脚本也可以使用。它是运行时执行，也就是说，什么时候运行到这一句，就会加载指定的模块。另外，import()函数与所加载的模块没有静态连接关系，这点也是与import语句不相同。import()类似于 Node 的require方法，区别主要是前者是异步加载，后者是同步加载

 

适用场合

1. 按需加载。 import()可以在需要的时候，再加载某个模块
2. 条件加载。import()可以放在if代码块，根据不同的情况，加载不同的模块
3. 动态的模块路径。import()允许模块路径动态生成

 

注意点

import()加载模块成功以后，这个模块会作为一个对象，当作then方法的参数。因此，可以使用对象解构赋值的语法，获取输出接口

1 import(‘./myModule.js‘)
2 .then((export1, export2) => 
3   // ...·
4 );

上面代码中，export1和export2都是myModule.js的输出接口，可以解构获得

如果模块有default输出接口，可以用参数直接获得

1 import(‘./myModule.js‘)
2 .then(myModule => 
3   console.log(myModule.default);
4 );

如果想同时加载多个模块，可以采用下面的写法

1 Promise.all([
2   import(‘./module1.js‘),
3   import(‘./module2.js‘),
4   import(‘./module3.js‘),
5 ])
6 .then(([module1, module2, module3]) => 
7    ···
8 );

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

 1 async function main() 
 2   const myModule = await import(‘./myModule.js‘);
 3   const export1, export2 = await import(‘./myModule.js‘);
 4   const [module1, module2, module3] =
 5     await Promise.all([
 6       import(‘./module1.js‘),
 7       import(‘./module2.js‘),
 8       import(‘./module3.js‘),
 9     ]);
10 
11 main();