使用Node.js require与ES6导入/导出


930

在我正在合作的项目中,关于可以使用哪种模块系统,我们有两个选择:

  1. 导入使用的模块require,并使用导出module.exportsexports.foo
  2. 使用ES6导入模块import,并使用ES6导出export

一项使用另一项有什么性能上的好处?如果要在Node模块上使用ES6模块,还有其他什么应该知道的吗?


9
node --experimental-modules index.mjs使您可以在import没有Babel的情况下使用,并且可以在Node 8.5.0+中工作。您还可以(并且应该)将npm软件包发布为本地ESModule,并向后兼容旧require方法。
Dan Dascalescu

Answers:


728

一项使用另一项有什么性能上的好处?

请记住,还没有JavaScript引擎本身支持ES6模块。您说自己正在使用Babel。无论如何,Babel都会默认将其转换importexport声明为CommonJS(require/ module.exports)。因此,即使您使用ES6模块语法,但如果在Node中运行代码,也将在后台使用CommonJS。

CommonJS和ES6模块之间存在技术差异,例如,CommonJS允许您动态加载模块。ES6不允许这样做,但是正在为此开发一个API

由于ES6模块是标准的一部分,因此我将使用它们。


16
我尝试使用ES6 importrequire但它们的工作方式有所不同。CommonJS导出类本身,而只有一个类。ES6导出就像有多个类,因此您必须使用它.ClassName来获取导出的类。还有其他实际影响实现的差异
吗?-Thellimist

78
@Entei:好像您要默认导出,而不是命名导出。module.exports = ...;等同于export default ...exports.foo = ...等价于export var foo = ...;
菲利克斯·克林

10
值得注意的是,即使Babel最终import在Webpack 2 / Rollup(以及其他允许ES6摇树的捆绑器)中最终使用Node.b编译为Node.com 中的CommonJS,也有可能最终完成一个文件,该文件明显小于等效的Node Node处理代码。require正是由于 ES6允许对导入/导出进行静态分析这一事实,所以才使用它们。尽管这对Node并没有什么影响,但如果最终将代码作为单个浏览器捆绑包出售,肯定可以。
李本森

5
除非您需要动态导入
-chulian

3
ES6模块位于最新的V8中,并且还带有其他标志。请参阅:medium.com/dev-channel/...
Nexii马尔萨斯

180

您可能要考虑几种用法/功能:

要求:

  • 您可以在未预定义的模块名称/ static的情况下进行动态加载,或者仅在“确实需要”模块时才有条件地加载模块(取决于某些代码流)。
  • 加载是同步的。这意味着,如果您有多个require,它们将被一个接一个地加载和处理。

ES6导入:

  • 您可以使用命名的导入来有选择地仅加载所需的片段。这样可以节省内存。
  • 导入可以是异步的(实际上是在当前的ES6 Module Loader中),并且可以执行得更好。

另外,Require模块系统也不基于标准。由于存在ES6模块,因此极不可能成为标准。将来,将在各种实现中对ES6模块提供本机支持,这将在性能方面带来优势。


16
是什么让您认为ES6导入是异步的?
菲利克斯·克林

5
@FelixKling-各种观察结果的组合。使用JSPM(ES6 Module Loader ...),我注意到,当导入修改了全局名称空间时,在其他导入中不会观察到这种效果(因为它们是异步发生的。这在转码中也可以看到)。另外,由于这是行为(1次导入不会影响其他行为),因此没有理由不这样做,因此它可能取决于实现方式
Amit 2015年

35
您提到了一个非常重要的东西:模块加载器。ES6提供了导入和导出语法,但未定义模块的加载方式。重要的部分是声明是可以静态分析的,因此无需执行代码即可确定依赖项。这将允许模块加载器同步或异步加载模块。但是ES6模块本身不是同步或异步的。
菲利克斯·克林

5
@FelixKling ES6模块加载器在OP中被标记,因此我认为它与答案相关。我还说过,基于观察,异步是当前行为,以及将来(在任何实现中)的可能性,因此这是需要考虑的相关问题。你认为这是错的吗?
阿米特(Amit)2015年

10
我认为重要的是不要将模块系统/语法与模块加载器混为一谈。例如,如果您为节点开发,则require无论如何都可能将ES6模块编译为,因此无论如何都在使用Node的模块系统和加载器。
Felix Kling

41

主要优点是语法:

  • 更多说明性/紧凑语法
  • ES6模块将基本上使UMD(通用模块定义)过时-实质上消除了CommonJS和AMD(服务器与浏览器)之间的分裂。

您不太可能看到ES6模块的任何性能优势。即使浏览器完全支持ES6功能,您仍将需要一个额外的库来捆绑模块。


4
您能否阐明为什么即使浏览器具有完整的ES6模块支持,也需要捆绑器吗?
E. Sundin

1
道歉,进行了更合理的编辑。我的意思是导入/导出模块功能未在任何浏览器中本地实现。仍然需要转译器。
snozza '16

16
在我看来似乎有点矛盾。如果有全力支持,那么捆扎机的目的是什么?ES6规范中缺少什么吗?在完全受支持的环境中,捆绑程序实际上会执行哪些操作呢?
E. Sundin

1
正如@snozza所说的...“导入/导出模块功能并未在任何浏览器中天真地实现。仍然需要编译器”
robertmain

2
您不再需要任何额外的库。从v8.5.0(一年多以前发布)开始,node --experimemntal-modules index.mjs让您import无需Babel即可使用。您还可以(并且应该)将npm软件包发布为本机ESModule,并向后兼容require方法。许多浏览器本身也支持动态导入
Dan Dascalescu

38

一项使用另一项有什么性能上的好处?

当前的答案是否定的,因为当前的浏览器引擎都没有实现import/exportES6标准。

一些比较表http://kangax.github.io/compat-table/es6/没有考虑到这一点,因此当您看到Chrome的几乎所有绿色时,请小心。import未考虑来自ES6的关键字。

换句话说,包括V8在内的当前浏览器引擎无法通过任何JavaScript指令从主JavaScript文件导入新的JavaScript文件

(直到V8根据ES6规范实现该功能为止,我们距离我们可能只有几步之遥,也可能只有年之遥。)

这个文件是我们需要的,而这个文件是我们必须服从。

ES6标准说,在像使用编程语言C那样拥有(头文件).h文件的方式读取模块之前,应该存在模块依赖性。

这是一个经过良好测试的良好结构,并且我相信创建ES6标准的专家会牢记这一点。

这就是使Webpack或其他程序包捆绑器在某些特殊情况下可以优化该程序包,并减少该程序包不需要的某些依赖项的原因。但是,如果我们有完美的依赖关系,这将永远不会发生。

import/export原生支持尚需时日,而require关键字很长一段时间都不会出现。

什么require

这是node.js加载模块的方式。(https://github.com/nodejs/node

Node使用系统级方法来读取文件。使用时,基本上可以依靠它requirerequire将以某些系统调用uv_fs_open(取决于最终系统,Linux,Mac,Windows)结束,以加载JavaScript文件/模块。

要检查这是否正确,请尝试使用Babel.js,您会看到该import关键字将转换为require

在此处输入图片说明


2
其实,还有一个领域,性能可以得到改善-集束大小。通过import在Webpack 2 /汇总构建过程中使用,可以通过“摇晃”未使用的模块/代码来减小生成的文件大小,否则这些文件/代码可能会在最终捆绑包中结清。较小的文件大小=下载速度更快=在客户端上初始化/执行速度更快。
李本森

2
原因是目前地球上没有浏览器允许该import 关键字本地使用。或这意味着您无法从JavaScript文件导入另一个JavaScript文件。这就是为什么您无法比较这两者的性能优势的原因。但是,当然,Webpack1 / 2或Browserify之类的工具可以处理压缩。他们并驾齐驱:gist.github.com/substack/68f8d502be42d5cd4942
prosti

4
您正在忽略“摇树”。在要点链接的任何地方都没有讨论摇树。使用ES6模块可以启用它,因为importexport是导入特定代码路径的静态声明,而require可以是动态的,因此可以捆绑在未使用的代码中。性能收益是间接的-Webpack 2和/或汇总可以潜在地导致较小的包大小,这些包大小可以更快地下载,因此对于(浏览器的)最终用户来说显得更灵活。仅当所有代码都写在ES6模块中,因此导入才可以静态分析时,此方法才有效。
李本森

2
我更新了答案@LeeBenson,我认为,如果考虑到浏览器引擎的本机支持,我们还无法比较。甚至在我们设置CommonJS模块之前,也可以使用Webpack来实现方便的三摇选项,因为对于大多数实际应用程序,我们知道应该使用哪些模块。
prosti

1
您的答案是完全正确的,但我认为我们正在比较两个不同的特征。全部 import/export转换为require,被授予。但是此步骤之前发生的事情可以被认为是“性能”增强。示例:如果lodash用ES6和you编写import { omit } from lodash,则最终捆绑包将仅包含“忽略”,而不包含其他实用程序,而简单捆绑包require('lodash')将导入所有内容。这将增加捆绑包的大小,需要更长的下载时间,从而降低性能。当然,这仅在浏览器上下文中有效。
李本森

31

使用ES6模块对于“摇树”很有用;例如,启用Webpack 2,汇总(或其他捆绑程序)以标识未使用/导入的代码路径,因此不要将其放入生成的捆绑程序中。通过消除不需要的代码,可以大大减少文件的大小,但是CommonJS是默认捆绑的,因为Webpack等无法知道是否需要它。

这是通过对代码路径进行静态分析来完成的。

例如,使用:

import { somePart } 'of/a/package';

...给捆绑程序一个package.anotherPart不需要的提示(如果未导入,则无法使用-对吗?),因此不会打扰它。

要为Webpack 2启用此功能,您需要确保您的编译器不会吐出CommonJS模块。如果您将es2015插件与babel一起使用,则可以按以下方式禁用它.babelrc

{
  "presets": [
    ["es2015", { modules: false }],
  ]
}

汇总和其他工具的工作方式可能有所不同-如果您有兴趣,请查看文档。



25

当涉及到异步或延迟加载时,它的功能要强import ()大得多。看看何时我们需要异步方式的组件,然后我们import以某种异步方式使用它,就像在constusing中使用变量一样await

const module = await import('./module.js');

或者,如果您想使用require()

const converter = require('./converter');

事情是import()实际上是异步的性质。正如neehar neehar venugopal在ReactConf中提到的那样,您可以使用它为客户端架构动态加载React组件。

在路由方面也更好。这是当用户将特定网站连接到其特定组件时使网络日志下载必要部分的一件事。例如,在仪表板无法下载仪表板的所有组件之前的登录页面。因为当前需要什么,即登录组件,所以将仅下载该组件。

这同样适用于export:ES6 export是为CommonJS的完全相同module.exports

注意 -如果你正在开发一个项目的Node.js,那么你必须严格使用require()的节点会抛出异常错误的invalid token 'import',如果你会使用import。因此,节点不支持导入语句。

更新-正如Dan Dascalescu所建议:自v8.5.0(2017年9月发布)以来,node --experimental-modules index.mjsimport无需Babel即可使用。您还可以(并且应该)将npm软件包发布为本机ESModule,并向后兼容require方法。

有关在哪里使用异步导入的更多信息,请参见此-https: //www.youtube.com/watch?v=bb6RCrDaxhw


1
那么需求将被同步并等待吗?
baklazan

1
可以说实话!
2014年

15

最重要的是,ES6模块确实是一个官方标准,而CommonJS(Node.js)模块则不是。

在2019年,84%的浏览器都支持ES6模块。尽管Node.js将它们放在--experimental-modules标志的后面,但还有一个方便的节点程序包esm,它使集成更加流畅。

您可能会在这些模块系统之间遇到的另一个问题是代码位置。Node.js假定源代码保存在node_modules目录中,而大多数ES6模块则以平面目录结构进行部署。这些都不容易调和,但是可以通过package.json使用安装前和安装后脚本来入侵文件来完成。下面是一个例子同构模块文章解释它是如何工作的。


8

我个人使用import是因为,我们可以使用import导入所需的方法,成员。

import {foo, bar} from "dep";

文件名: dep.js

export foo function(){};
export const bar = 22

归功于Paul Shan。更多信息


1
很好的选择!您是否还将npm软件包作为本机ESModule发布,并且具有向后兼容的旧require方法?
Dan Dascalescu 18/09/26

6
您可以使用require做同样的事情!
Suisse

4
const {a,b} = require('module.js'); 也可以正常工作...如果您出口,a并且b
BananaAcid

module.exports = { a: ()={}, b: 22 }-@BananaAcid回应的第二部分
赛斯·麦克莱恩

7

从现在开始,ES6导入,导出始终被编译为CommonJS,因此使用两者都不会有任何好处。尽管建议使用ES6,因为当发布来自浏览器的本机支持时,它应该是有利的。原因是,您可以从一个文件导入部分文件,而使用CommonJS则需要所有文件。

ES6→ import, export default, export

CommonJS→ require, module.exports, exports.foo

以下是这些的常见用法。

ES6导出默认

// hello.js
function hello() {
  return 'hello'
}
export default hello

// app.js
import hello from './hello'
hello() // returns hello

ES6导出多个和导入多个

// hello.js
function hello1() {
  return 'hello1'
}
function hello2() {
  return 'hello2'
}
export { hello1, hello2 }

// app.js
import { hello1, hello2 } from './hello'
hello1()  // returns hello1
hello2()  // returns hello2

CommonJS module.exports

// hello.js
function hello() {
  return 'hello'
}
module.exports = hello

// app.js
const hello = require('./hello')
hello()   // returns hello

CommonJS module.exports多个

// hello.js
function hello1() {
  return 'hello1'
}
function hello2() {
  return 'hello2'
}
module.exports = {
  hello1,
  hello2
}

// app.js
const hello = require('./hello')
hello.hello1()   // returns hello1
hello.hello2()   // returns hello2

0

不知道为什么(可能是优化-延迟加载?)是否可以那样工作,但是我注意到,import如果不使用导入的模块,可能无法解析代码。
在某些情况下,这可能不是预期的行为。

以讨厌的Foo类作为我们的示例依赖项。

foo.ts

export default class Foo {}
console.log('Foo loaded');

例如:

索引

import Foo from './foo'
// prints nothing

索引

const Foo = require('./foo').default;
// prints "Foo loaded"

索引

(async () => {
    const FooPack = await import('./foo');
    // prints "Foo loaded"
})();

另一方面:

索引

import Foo from './foo'
typeof Foo; // any use case
// prints "Foo loaded"
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.