js Module 模块的使用

一、什么是Module

ES6 模块的设计思想是尽量的静态化,使得编译时就能确定模块的依赖关系,以及输入和输出的变量。ES6 模块不是对象,而是通过export命令显式指定输出的代码,再通过import命令输入。

二、export 命令

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

例:

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

解释: 上面代码是profile.js文件,保存了用户信息。ES6 将其视为一个模块,里面用export命令对外部输出了三个变量。

例:

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

export {
    
     firstName, lastName, year };

解释: 上面代码在export命令后面,使用大括号指定所要输出的一组变量。它与前一种写法(直接放置在var语句前)是等价的,但是应该优先考虑使用这种写法。因为这样就可以在脚本尾部,一眼看清楚输出了哪些变量。

2、export命令除了输出变量,还可以输出函数或类(class)。通常情况下,export输出的变量就是本来的名字,但是可以使用as关键字重命名。

例:

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

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

解释: 上面代码使用as关键字,重命名了函数v1和v2的对外接口。重命名后,v2可以用不同的名字输出两次。

扫描二维码关注公众号,回复: 17064410 查看本文章

3、export命令规定的是对外的接口,必须与模块内部的变量建立一一对应关系。

例:

// 写法1:报错(直接输出 1)
export 1;

// 写法2:报错(通过变量m,还是直接输出 1。1只是一个值,不是接口。)
var m = 1;
export m;

// 写法3:正确
export var m = 1;

// 写法4:正确
var m = 1;
export {
    
    m};

// 写法5:正确
var n = 1;
export {
    
    n as m};

解释: 后面三种写法都是正确的,规定了对外的接口m,其他脚本可以通过这个接口,取到值1。它们的实质是,在接口名模块内部变量之间,建立了一 一对应的关系。

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

例:

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

解释: 上面代码输出变量foo,值为bar,500 毫秒之后变成baz。

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

例:

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

解释: 上面代码中,export语句放在函数之中,结果报错。

三、import 命令

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

例:

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

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

解释: 上面代码的import命令,用于加载profile.js文件,并从中输入变量。import命令接受一对大括号,里面指定要从其他模块导入的变量名。大括号里面的变量名,必须与被导入模块(profile.js)对外接口的名称相同

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

例:

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

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

例:

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

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

解释: 脚本加载了变量a,对其重新赋值就会报错,因为a是一个只读的接口。但是,如果a是一个对象,改写a的属性是允许的。

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

例:

import {
    
     myMethod } from 'util';

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

5、import命令具有提升效果,会提升到整个模块的头部,首先执行。

例:

foo();

import {
    
     foo } from 'my_module';

解释: 上面的代码不会报错,因为import的执行早于foo的调用。这种行为的本质是,import命令是编译阶段执行的,在代码运行之前。

6、由于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结构。在静态分析阶段,这些语法都是没法得到值的。

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

例:

import 'lodash';

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

四、模块的整体加载

指定加载某个输出值,还可以使用整体加载,即用星号(*)指定一个对象,所有输出值都加载在这个对象上面。

例:(逐一加载)

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),应该是可以静态分析的,所以不允许运行时改变。

五、export default 命令

1、为了给用户提供方便,让他们不用阅读文档就能加载模块,就要用到export default命令,为模块指定默认输出。

例:

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

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

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

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

// 或者写成

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

export default foo;

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

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

例:

// 第一组
export default function crc32() {
    
     // 输出
  // ...
}

import crc32 from 'crc32'; // 输入

// 第二组
export function crc32() {
    
     // 输出
  // ...
};

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

解释: 第一组是使用export default时,对应的import语句不需要使用大括号;第二组是不使用export default时,对应的import语句需要使用大括号。

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

例:

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

5、export default命令其实只是输出一个叫做default的变量,所以它后面不能跟变量声明语句。

// 正确
export var a = 1;

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

// 错误
export default var a = 1;

解释: export default a的含义是将变量a的值赋给变量default。所以,最后一种写法会报错。

六、export 与 import 的复合写法

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

例:

export {
    
     foo, bar } from 'my_module';

// 可以简单理解为
import {
    
     foo, bar } from 'my_module';
export {
    
     foo, bar };

解释: 上面代码中,export和import语句可以结合在一起,写成一行。但需要注意的是,写成一行以后,foo和bar实际上并没有被导入当前模块,只是相当于对外转发了这两个接口,导致当前模块不能直接使用foo和bar。

2、模块的接口改名和整体输出

例:

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

// 默认接口输出
export {
    
     default } from 'my_module';

// 具名接口改为默认接口
export {
    
     es6 as default } from 'my_module';

// 整体输出
export * from 'my_module';

七、跨模块常量

1、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

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

猜你喜欢

转载自blog.csdn.net/change_any_time/article/details/128436924