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

export命令用于规定模块的对外接口,

import命令用于输入其他模块提供的功能。


export输出

一个模块就是一个独立的文件。该文件内部的所有变量,外部无法获取。如果你希望外部能够读取模块内部的某个变量,就必须使用export关键字输出该变量。下面是一个 JS 文件,里面使用export命令输出变量。

export const a = 'Jeson'
export let b = 'Jack'
export var c = 'Tom'

export命令对外部输出了三个变量。

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

const a = 'Jeson'
let b = 'Jack'
var c = 'Tom'

export { a, b, c }

与前一种写法(直接放置在var语句前)是等价的,但是应该优先考虑使用这种写法。因为这样就可以在脚本尾部,一眼看清楚输出了哪些变量。


export命令除了输出变量,还可以输出函数或类(class)。

export function sum(x, y) {
    return x+y
}

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

function a() {...}
function b() {...}

export {
    a as a1
    b as b1
    b as b2
}

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


需要特别注意的是,export命令规定的是对外的接口,必须与模块内部的变量建立一一对应关系。

export 1 // 报错 1是一个值不是接口

var a = 2
export a // 报错 依旧是上一个问题

正确写法

// 写法1
export var a = 1

// 写法2 
var b = 1
export { b }

// 写法3
var c = 1
export { c as d } // 输出d

function和class的输出,也必须遵守这样的写法

// 报错
function a() {...}
export a

// 正确
export function b() {...}

// 正确
function c() {...}
export { c }

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

export var a = 1
setTimeout(() => a = 2, 500)

上面代码输出变量foo,值为bar,500毫秒之后变成baz。
这一点与 CommonJS 规范完全不同。CommonJS 模块输出的是值的缓存,不存在动态更新,详见下文《Module 的加载实现》一节。


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

// 报错 SyntaxError
function name() {
    export default 'Jeson'
}
name()

import命令

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

// a.js
const a = 1
let b = 2
var c = 3
export { a, b, c }

// b.js
import { a, b, c } from './a'

function count() {
    return a+b+c
}

大括号里面的变量名,必须与被导入模块(profile.js)对外接口的名称相同。


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

import { a as a1 } from './a'

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

import { myMethod } from 'util'

上面代码中,util是模块文件名,由于不带有路径,必须通过配置,告诉引擎怎么取到这个模块。


import命令具有提升效果,会提升到整个模块的头部,首先执行.本质是,import命令是编译阶段执行的,在代码运行之前

a()
import { a } from 'my_module'

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

// 报错
import { 'f' + 'oo' } from 'my_module'

// 报错
const module = 'my_module'
import { foo } from module

// 报错
if (x===1) {
    import { a } from 'module1'
} else {
    import { b } from 'module2'
}

三种写法都会报错,因为它们用到了表达式、变量和if结构。在静态分析阶段,这些语法都是没法得到值的。


import语句会执行所加载的模块,因此可以有下面的写法。

import 'count' // 仅执行count模块,不输入任何值

多次重复执行同一句import语句,那么只会执行一次,而不会执行多次。

import { a } from 'my_module'
import { b } from 'my_module'

// 等同于
import { a, b } from 'my_module'

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


export defult

使用import命令的时候,用户需要知道所要加载的变量名或函数名,否则无法加载。但是,用户肯定希望快速上手,未必愿意阅读文档,去了解模块有哪些属性和方法。
为了给用户提供方便,让他们不用阅读文档就能加载模块,就要用到export default命令,为模块指定默认输出。

// a.js 默认输出是一个函数。
export default function() {
    console.log('Jeson')
}

import customName from './a'
customName() // Jeson

上面代码的import命令,可以用任意名称指向export-default.js输出的方法,这时就不需要知道原模块输出的函数名。需要注意的是,这时import命令后面,不使用大括号。

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

// a.js
export default function jeson() {
    console.log('jeson')
}

// 或者写成
function jeson() {
    console.log('jeson')
}
export default jeson

上面代码中,foo函数的函数名foo,在模块外部是无效的。加载的时候,视同匿名函数加载。


比较正常输出或默认输出

// 第一组
export default function a() {
    // do something
}
import b from 'a'

// 第二组
export funciton c() {
    // do something
}
import { c } from 'c'

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

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

import { default as customName } from 'modules'
// 等同于
// import customName 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 2

// 错误
export 2
后一句报错是因为没有指定对外的接口,而前一句指定外对接口为default

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

import _, { each } from 'lodash'

// 对应的export
export default function(obj) {
    // do some
}
export function each(item, index) {
    // do some
}
export { each as forEach }

forEach和each指向同一个方法。

export default 也可以用来输出类

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

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

export 与 import的复合写法
如果在一个模块之中,先输入后输出同一个模块,import语句可以与export语句写在一起。

export { a, b } from 'my_module'

// 等同于
import { a, b } from 'my_module'
export { a, b }

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

// 接口改名
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";

模块的继承

模块之间也可以继承。

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

// circlelus.js
export * from 'circle'
export var e = 2.333
export default function(x) {
    return Math.exp(x)
}

上面代码中的export *,表示再输出circle模块的所有属性和方法。注意,export *命令会忽略circle模块的default方法。然后,上面代码又输出了自定义的e变量和默认方法。

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

export { area as circleArea } from 'circle'

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

加载上面模块的写法

import * 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 = 2
export const C = 3

// test1.js模块
import * as constants from './constants'

console.log(constants.A)
conosle.log(constants.B)

// test2.js模块
import { A, B } from './constants'

console.log(A)
console.log(B)

如果要使用的常量非常多,可以建一个专门的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'];

// 合并输出 constants/index.js
export { db } from './db'
export { users } from './users'

// 使用的时候直接加载index.js
import { db, users } from './contains'

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 对象。下面是一个例子

```js
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();

results matching ""

    No results matching ""