目录
在 JavaScript 中,require 和 import 都是用来导入模块的。
CommonJS 模块与 ES6 模块的区别
- CommonJS模块最初为Node.js设计,而ES6模块则是JavaScript语言标准的一部分,更适合于浏览器环境。不过,随着工具链的发展,两种模块都可以在不同环境中使用;
- CommonJS 输出的是一个值的浅拷贝,而 ES6 输出的是值的引用;
- CommonJS 是运行时加载,ES6 是编译时输出接口即静态加载,这导致 ES6 模块更适合于性能优化;
- CommonJS 模块的 require() 是同步加载模块,ES6 模块的 import 命令是异步加载,有一个独立的模块依赖的解析阶段;
- ES6 模块可以在 import 引用语句前使用模块,CommonJS 则需要先引用后使用
ES6模块化更适合性能优化主要是因为它支持静态加载。这意味着模块间的依赖关系在编译阶段就确定了,允许进行树摇(tree-shaking)等优化措施,从而去除未使用的代码,减少最终包的大小。
require 与 import 的区别
- require 是 Node.js 内置的方法,而 import 是一个 ES6 标准的关键字。
- require/exports 是 CommonJS/AMD 规范,即输出的是一个值的拷贝;import/export 是ES6+ 规范,即输出的是值的引用。
- 若文件引用的模块值改变,require 引入的模块值不会改变,而 import 引入的模块值会改变。
- 作用域:import 命令只能在模块顶层使用,不能在函数、判断语句等代码块之中引用;require 可以
- import/export 导出的模块默认调用严格模式;require/exports 默认不使用严格模式,可以自定义是否使用严格模式
- 其实他们最大的区别,require 只能对整个模块进行加载;而 import 可以选择性的加载被拆分导出(individual export)的模块,拆分导出(individual export)的模块可以是 value, funcition, object
举个例子,我们有一个模块叫 lodash, 你可以通过 require 导入整个模块
const _ = require('lodash')
如果想使用其中的方法或值,需要使用 .
符号去调用
const cloneDeep= require('myModule').cloneDeep;
再看看import, 如果想导入整个模块
import * as _from 'lodash';
如果想导入指定内容
import { cloneDeep } from 'lodash';
比较而言,import 更灵活,也是在 require 之后 ES 推出的关键字,理论上 import 会全面的取替 require。不过在 Node.js 还是会支持 require,可以根据需求去选择两种语法。
require() 可以利用缓存让模块只加载一次,即便很多文件都加载了这个模块。意思是说当用require 加载了一个模块,Node.js 会去检查这个模块是否已经被加载和缓存,如果是的话,就直接返回缓存的内容。
require/exports 相关用法
// common/utils.js
exports.name = 'cao ding shuan'
module.exports.age = 24
console.log(exports, module.exports)
// index.js
const util = require('./common/util')
// 输出 { name: 'cao ding shuan', age: 24 } { name: 'cao ding shuan', age: 24 }
exports 是对 module.exports 的引用,相当于
exports = module.exports = {};
exports 指向了其他对象,exports 改变不会改变模块输出值;而修改了module.exports的指向,则会改变模块输出值。示例如下
// common/utils.js
exports.a = 200;
console.log(exports, module.exports)
exports = { a: 300 }; //exports 指向其他内存区
console.log(exports, module.exports)
// index.js
const util = require('./common/util')
console.log('util', util)
// 输出
// { a: 200 } { a: 200 }
// { a: 300 } { a: 200 }
// util { a: 200 }
以上 exports 指向其他内存区,模块输出值没变
// common/utils.js
exports.a = 200;
console.log(exports, module.exports)
exports = { a: 300 }; // exports 指向其他内存区
module.exports = { a: 400}; // module.exports 指向其他内存区
console.log(exports, module.exports)
// index.js
const util = require('./common/util')
console.log('util', util)
// 输出
// { a: 200 } { a: 200 }
// { a: 300 } { a: 400 }
// util { a: 400 }
以上 exports 与 module.exports 都指向了其他内存区,模块输出值跟随 module.exports 改变而改变
import/export 相关用法
Module 主要由两个命令组成,import和export,export用于规定模块的对外接口,import命令用于输入其他模块提供的功能。
export
模块是独立的文件,该文件内部的所有的变量外部都无法获取。如果希望获取某个变量,必须通过export输出
// utils/index
export const name = 'Jasmine'
export const age = 27
export const sex = 'man'
// index.js
import { name, age, sex } from './utils/index'
console.log(name, age, sex)
// 输出 Jasmine 27 man
或者用更好的方式:用大括号指定要输出的一组变量
// utils/index
const name = 'Jasmine'
const age = 27
const sex = 'man'
export { name, age, sex }
除了输出变量,还可以输出函数或者类(class)
export function echoHello () {
console.log('hello')
}
还可以批量输出,同样是要包含在大括号里,也可以用 as 重命名:
function v1() { ... }
function v2() { ... }
export {
v1 as streamV1,
v2 as streamV2,
v2 as streamLatestVersion // 可有多个不同重命名
};
注意: export 命令规定的是对外接口,必须与模块内部变量建立一一对应的关系
// 写法一
export var m = 1;
// 写法二
var m = 1;
export { m };
// 写法三
var n = 1;
export {n as m};
// 报错,没有提供对外的接口,直接输出1
export 1;
// 报错,虽然有变量m,但还是直接输出1,导致无法解构
var m = 1;
export m;
同样的,function和class的输出,也必须遵守这样的写法。
// 报错
function f() {}
export f;
// 正确
export function f() {};
// 正确
function f() {}
export { f };
export语句输出的接口,都是和其对应的值是动态绑定的关系,即通过该接口取到的都是模块内部实时的值。
export模块可以位于模块中的任何位置,但是必须是在模块顶层,如果在其他作用域内,会报错。
function foo() {
export default 'bar' // SyntaxError
}
foo()
import
export定义了模块的对外接口后,其他JS文件就可以通过import来加载这个模块
import命令接受一对大括号,里面指定要从其他模块导入的变量名,必须与被导入模块对外接口的名称相同。
如果想重新给导入的变量一个名字,可以用as关键字
import { lastName as surname } from './profile';
import后的from 可以指定需要导入模块的路径名,可以是绝对路径,也可以是相对路径, .js路径可以省略,如果只有模块名,不带有路径,需要有配置文件指定。
注意,import命令具有提升效果,会提升到整个模块的头部,首先执行。(是在编译阶段执行的)
因为import是静态执行的,不能使用表达式和变量,即在运行时才能拿到结果的语法结构(e.g. if…else…)
module的整体加载
除了指定加载某个输出值,还可以用*指定一个对象,所有的变量都会加载在这个对象上。
使用 * 虽然很方便,但是不利于现代的构建工具检测未被使用的函数,影响代码优化。
// 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));
注意:import引入后,不允许运行时改变引入模块。
import * as circle from './circle';
// 下面两行都是不允许的
circle.foo = 'hello';
circle.area = function () {};
注意: 在验证代码的时候遇到如下报错
access to script from origin 'null' has been blocked by CORS policy
因为浏览器引入模块的 <script> 元素要添加 type="module 属性,但 module 不支持 FTP 文件协议(file://),只支持 HTTP 协议,所以本地需要使用 http-server 等本地网络服务器打开网页文件。
export default
前面的例子中,使用 import 导入时,都需要知道模块中所要加载的变量名或函数名,用户可能不想阅读源码,只想直接使用接口,就可以用 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 function crc32() { // 输出
// ...
}
import crc32 from 'crc32'; // 输入
或
import customName from 'crc32'; // 输入
// 第二组
export function crc32() { // 输出
// ...
};
import { crc32 } from 'crc32'; // 输入
可以看出,使用export default时,import语句不用使用大括号({})。
注意: 一个文件只能导出一个 default 模块。
import()函数
import和export命令只能在模块的顶层,不能在代码块之中。否则会语法报错。
这样的设计,可以提高编译器效率,但是没有办法实现运行时加载。
因为require是运行时加载,所以import命令没有办法代替require的动态加载功能。
所以引入了import()函数。完成动态加载。
import(specifier)
specifier 用来指定所要加载的模块的位置。import 能接受什么参数,import() 可以接受同样的参数。
import() 表达式加载模块并返回一个 promise,该 promise resolve 为一个包含其所有导出的模块对象。
我们可以在代码中的任意位置动态地使用它。例如
// utils/index.js
export default {
People: class People {
constructor (name, age) {
this.name = name
this.age = age
}
toString () {
console.log(this.name, this.age)
}
toError () {
throw new Error('进入错误处理')
}
}
}
// index.js
import('./utils/index')
.then((res) => {
const newPeople = new res.default.People('Jasmine', 27)
newPeople.toString()
newPeople.toError()
})
.catch(err => {
console.error(err)
})
// 输出
// Jasmine 27
// Error: 进入错误处理
建议:请不要滥用动态导入 import()(只有在必要情况下采用)。静态框架能更好的初始化依赖,而且更有利于静态分析工具和 tree shaking 发挥作用
import()函数适用场合
按需加载,如下 import 模块在事件监听函数中,只有用户点击了按钮,才会加载这个模块。
button.addEventListener('click', event => {
import('./dialogBox.js')
.then(dialogBox => {
dialogBox.open();
})
.catch(error => {
/* Error handling */
})
});
条件加载,import() 可以放在 if/else 语句中,实现条件加载。
if (condition) {
import('moduleA').then(...);
} else {
import('moduleB').then(...);
}