如何在 Node.js 中使用 import / export 的三种方法

2019-08-07 17:16:53

如何在 Node.js 中使用 import / export 的三种方法

因为一些历史原因,虽然 Node.js 已经实现了 99% 的 ES6 新特性,不过截止 2018.8.10,How To Enable ES6 Imports in Node.JS 仍然是老大难问题


下面我来介绍三种方法可以让我们在 Node.js 中使用 import/export 。


注:第1、2种方法均是借助 babel,需要注意的是文章使用的babel版本 < 7。从 babel 7.X 版本开始,部分包名、用法发生了些许变化,大体与7之前的用法类似,详细请到官方手册学习 7.X 版本的改动(Babel 踩坑总结(三) —— 7.X 版本升级是我对 7.X 版本三大改动的总结)


1. 使用 babel-register

1.1 下载必须的包

npm install babel-register babel-preset-env -D

1

1.2 修改你的 server.js

下面是一个 server.js 的例子:


const Koa = require('koa')

const app = new Koa()


app.listen(8225, console.log("application is start at port 8225"))

1

2

3

4

用 import 替换 require


import Koa from 'koa'

const app = new Koa()


app.listen(8225, console.log("application is start at port 8225"))

1

2

3

4

如果你现在用 node server.js 跑这个文件,你会收到像这样的错误提示:


/Users/zwkkkk1/myStudy/demo/chatroom/server/app.js:1

(function (exports, require, module, __filename, __dirname) { import Koa from 'koa'

                                                                     ^^^


SyntaxError: Unexpected identifier

1

2

3

4

5

下面让我们用 babel 来解决这个问题


1.3 新增一个 start.js 文件

这个文件将成为我们的入口文件,里面是一些 babel 的代码


require('babel-register') ({

    presets: [ 'env' ]

})


module.exports = require('./server.js')

1

2

3

4

5

注意,接下来不是 node server.js,而是用 node start.js 来启动这个文件


2. 使用 babel-node 命令

如果你不想添加新的文件也可以,这里需要在命令行中使用 babel-node 命令。babel-node 命令不是独立安装,在 Babel 7.X 版本前,需要通过安装 babel-cli 包获得;在 Babel 7.X 版本,需要安装 @babel/core、@babel/cli 两个包。


此处以 7.X 之前的版本举例,7.X 版本可去官网查找对应包的使用用例


安装必要的插件


全局安装 babel-cli


npm install babel-cli -g

1

安装 babel-preset-env


npm install babel-preset-env -D

1

然后原来是 node server.js,改为这样调用:babel-node --presets env server.js


需要注意的是如果只是为了 babel-node 这一个命令,安装 babel-cli 会加载安装很多资源和模块,出于性能考虑不推荐在生产环境使用。自己在开发调试的时候,可以鼓捣着玩玩


3. 来自 Node.js 官方的力量

Node 9提供了一个尚处于 Experimental 阶段的模块,让我们可以抛弃 babel 等一类工具的束缚,直接在 Node 环境下使用 import/export。


官方手册:ECMAScript Modules

一个不错的教程:Node 9下import/export的丝般顺滑使用

有兴趣的可以去了解一下,嫌字多的可以继续往下看看我总结的使用方法


用前须知

Node 版本需在 9.0 及以上

不加 loader 时候,使用 import/export 的文件后缀名必须为 .mjs

举个例子,还是用上面的例子,请将代码回退到 Babel 中第一步的样子


3.1 改写 server.js

import Koa from 'koa'

const app = new Koa()


app.listen(8225, console.log("application is start at port 8225"))

1

2

3

4

和前面一样,不过将文件名改一下,从 server.js 改为 server.mjs


3.2 启动文件

执行下面代码,来启动文件


node --experimental-modules ./server.mjs

1

注意这是引用 koa 第三方模块不用做其他变化,如果要 import 自己的文件,那么那个待引入的文件也要改后缀。


比如


import example from './example'

1

那么原来应该是 example.js 要改为 example.mjs


目前这个模块还处于实验阶段,还是不要放到生产环境,自己拿出来玩玩还是可以的,


  • 2017-07-11 21:54:14

    MYSQL5.7版本sql_mode=only_full_group_by问题

    一旦开启 only_full_group_by ,感觉,group by 将变成和 distinct 一样,只能获取受到其影响的字段信息,无法和其他未受其影响的字段共存,这样,group by 的功能将变得十分狭窄了

  • 2017-07-14 13:51:58

    NodeJS连接MySQL出现Cannot enqueue Handshake after invoking quit.

    原因在于node连接上mysql后如果因网络原因丢失连接或者用户手工关闭连接后,原有的连接挂掉,需要重新连接;如下代码,每次访问结束都关闭,每次开始访问前重连接下,代码中没有监听连接的fatal错误,copy需谨慎

  • 2017-07-14 13:53:02

    nodejs解决mysql和连接池(pool)自动断开问题

    最近在做一个个人项目,数据库尝试使用了mongodb、sqlite和mysql。分享一下关于mysql的连接池用法。项目部署于appfog,项目中我使用连接池链接数据库,本地测试一切正常。上线以后,经过几次请求两个数据接口总是报503。一直不明就里,今天经过一番排查终于顺利解决了。

  • 2017-07-15 16:13:26

    设置MySQL里的wait_timeout

    如果你没有修改过MySQL的配置,缺省情况下,wait_timeout的初始值是28800。

  • 2017-07-16 20:13:14

    nodejs,express 自制错误日志

    对于同步执行的代码,以上的处理已经足够简单。然而,当异步程序在执行时抛出异常的情况,Express 就无能为力。原因在于当你的程序开始执行回调函数时,它原来的栈信息已经丢失。

  • 2017-07-16 20:17:56

    NodeJS处理Express中异步错误

    本文主要阐述如何在 Express 中使用错误处理中间件(error-handling middleware)来高效处理异步错误。在 Github 上有对应 代码实例 可供参考。