Module 的语法

2019-10-23 本文已影响0人了凡和纤风

一、概述

JavaScript 一直没有模块（module）体系，无法将一个大程序拆分成互相依赖的小文件，再用简单的方法将它们拼装起来。
在 ES6 之前，社区指定了一些模块加载方案，最主要的有 CommonJS 和 AMD 两种。前者用于服务器，后者用于浏览器
ES6 模块的设计思想是尽量静态化，使得编译时就能确定模块的依赖关系，以及输入和输出的变量。CommonJS 和 AMD 模块都只能在运行时确定这些东西。

由于 ES6 模块时编译时加载，使得静态分析称为可能。能进一步扩展 JavaScript的语法，比如引入宏（macro）和类型检验（type system）这些只能靠静态分析实现的功能

除了今天加载带来的各种好处，ES6 模块还有以下好处：

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

浏览器加载模块的规则
浏览器加载 ES6 模块，也使用<script>标签，但是要加入type="module"属性。

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

需要使用'http(s)'打开文件，不能以 file 协议打开文件

二、严格模式

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。

三、export 命令

模块功能主要由两个命令构成：export 和 import。

export 命令用于规定模块的对外接口
import 命令用于输入其他模块提供的功能。

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

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

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

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

export { firstName, lastName, year }

这两种写法是等价的，但是应该优先考虑使用这种写法，因为这样就可以在脚本尾部，一眼看清楚输出了哪些变量。

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

export function miltiply(x, y) {
  return x * y
}

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

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

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

重命名后，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 }

它们的实质是，在接口名与模块内部变量之间建立了一一对应的关系

同样地，function 和 class 的输出也必须遵守这样的写法

// 报错
function f() {}
export f

// 正确
export function f() {}

// 正确
function f() {}
export { f }

export 语句输出的接口预期对应的值是动态绑定关系，即通过该接口可以取到模块内部实时的值

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

export 命令可以出现在模块的任何位置，只要处于模块顶层就可以。如果处于块级作用域内，就会报错， import 命令也是如此。这是因为处于条件代码块之中，就没法做静态优化了，违背了 ES6 模块的设计初衷

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

四、import 命令

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

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

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

import 大括号中的变量名必须与被导入模块对外接口的名称相同。

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

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

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

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

foo()

import { foo } from 'my_module'

这种行为的本质是，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 'loadsh'

上面的代码仅仅执行 lodash 模块，但是不会输出任何值。
如果多次重复执行同一句 import 语句，那么只会执行一次，而不会执行多次

五、模块的整体加载

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

// circle.js

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

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

加载这个模块

// main.js

import { 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 命令

可以使用 export default 命令为模块指定默认输出

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

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

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

export default 命令用在非匿名函数前面也是可以的

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

// 或者
function foo() {
  console.log('foo')
}

export default foo

foo函数的函数名 foo 在模块外部是无效的。加载时视同名匿名函数

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

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

import _, { each, each as forEach } 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 { 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'

八、模块的继承

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

// circleplus.js

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

上面的 export * 表示输出 circle 模块的所有属性和方法

export * 命令会忽略 circle 模块的 default 方法。之后，又输出了自定义的 e 变量和默认方法。

这时也可以将 circle 的属性或方法改名后再输出

// circleplus.js

export { area as circleArea } from 'circle'

上面的代码表示，只输出 circle 模块的 area 方法，且将其改名为 circleArea

加载上面模块的写法如下。

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

import exp 表示，将 circleplus 模块的默认方法记载为 exp 方法

九、跨模块常量

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://xx.xxxxx.xxx',
  admin_username: 'ccc',
  admin_password: '123455'
}

// constants/user.js
export const users = [ 'root', 'admib', 'staff' ]

然后，讲这些晚间输出的常量合并在 index.js 里面。

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

使用的时候，直接加载 index.js 即可。

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

十、import()

10.1、简介

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 myModel = 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 方法，主要区别是，前者是异步加载，后者是同步加载。

10.2、适用场合

按需加载
import() 可以在需要的时候再加载某个模块

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

import() 方法放在 click 事件的监听函数之中，只有用户点击按钮才会加载这个模块。

条件加载
import() 可以放在 if 代码块中，根据不同的情况加载不同的模块

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

瞒住条件是就加载模块 A，否则加载模块 B

动态的模块路径
import() 允许模块路径动态生成

import(f())
.then( /* ... */ )

根据函数 f 的返回结果加载不同的模块

10.3、注意点

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

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

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

import('./myMoudle.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()