如何在 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-01-21 10:32:29

    Vue-cli proxyTable 解决开发环境的跨域问题

    和后端联调时总是会面对恼人的跨域问题,最近基于Vue开发项目时也遇到了这个问题,两边各自想了一堆办法,查了一堆资料,加了一堆参数,最后还得我把自己的localhost映射成上线时将要使用的域名。

  • 2017-01-21 21:44:29

    详解 ESLint 规则,规范你的代码

    在很久之前就想通过工具来规范自己的代码风格,减少程序出错的概率,如果看过我的 一个前端程序猿的Sublime Text3的自我修养 ,这篇博客的朋友,肯定知道在当时我使用 SublimeLinter-jshint 插件来规范风格,但是实际上一直懒癌发作也没去看它的文档,使用着它默认的规则。不过现在是时候切换到 ESLint 了!

  • 2017-01-23 23:09:16

    使用 CSS3 实现超炫的 Loading(加载)动画效果

     SpinKit 是一套网页动画效果,包含8种基于 CSS3 实现的很炫的加载动画。借助 CSS3 Animation 的强大功能来创建平滑,易于定制的动画。SpinKit 的目标不是提供一个每个浏览器都兼容的解决方案,而是给现代浏览器提供更优的技术实现方案和更佳的使用体验。(为保证最佳的效果,请在 Chrome、Firefox 和 Safari 等现代浏览器中浏览)