【原创】nodejs的exports、module.exports与ES6的export、export default深入详解

参考：

https://www.cnblogs.com/guanghe/p/6560698.html （nodejs中的require和import）

http://t.zoukankan.com/little-oil-p-14754549.html（nodejs 如何处理 ES6 模块）

前言

决定开始重新规范的学习一下node编程。但是引入模块我看到用 require的方式，再联想到咱们的ES6各种export 、export default。

阿西吧，头都大了....

头大完了，那我们坐下先理理他们的使用范围。

• require: node 和 es6 都支持的引入
• export / import : 只有es6 支持的导出引入
• module.exports / exports: 只有 node 支持的导出

这一刻起，我觉得是时候要把它们之间的关系都给捋清楚了，不然我得混乱死。话不多少，咱们开干！！

node模块

Node里面的模块系统遵循的是CommonJS规范。

那问题又来了，什么是CommonJS规范呢？

由于js以前比较混乱，各写各的代码，没有一个模块的概念，而这个规范出来其实就是对模块的一个定义。

CommonJS定义的模块分为: 模块标识(module)、模块定义(exports) 、模块引用(require)

先解释 exports 和 module.exports

在一个node执行一个文件时，会给这个文件内生成一个 exports和module对象，

而module又有一个exports属性。他们之间的关系如下图，都指向一块{}内存区域。

exports = module.exports = {};

那下面我们来看看代码的吧。

//utils.js
let a = 100;
 
console.log(module.exports); //能打印出结果为：{}
console.log(exports); //能打印出结果为：{}
 
exports.a = 200; //这里辛苦劳作帮 module.exports 的内容给改成 {a : 200}
 
exports = '指向其他内存区'; //这里把exports的指向指走
 
//test.js
 
var a = require('/utils');
console.log(a) // 打印为 {a : 200}

从上面可以看出，其实require导出的内容是module.exports的指向的内存块内容，并不是exports的。

简而言之，区分他们之间的区别就是 exports 只是 module.exports的引用，辅助后者添加内容用的。

用白话讲就是，exports只辅助module.exports操作内存中的数据，辛辛苦苦各种操作数据完，累得要死，结果到最后真正被require出去的内容还是module.exports的，真是好苦逼啊。

其实大家用内存块的概念去理解，就会很清楚了。

然后呢，为了避免糊涂，尽量都用 module.exports 导出，然后用require导入。

es6中的模块导出导入

说实话，在es中的模块，就非常清晰了。不过也有一些细节的东西需要搞清楚。

比如 export 和 export default，还有 导入的时候，import a from ..,import {a} from ..，总之也有点乱，那么下面我们就开始把它们捋清楚吧。

export 和 export default

首先我们讲这两个导出，下面我们讲讲它们的区别

• export与export default均可用于导出常量、函数、文件、模块等
• 在一个文件或模块中，export、import可以有多个，export default仅有一个
• 通过export方式导出，在导入时要加{ }，export default则不需要
• export能直接导出变量表达式，export default不行。

下面咱们看看代码去验证一下

testEs6Export.js

'use strict'
//导出变量
export const a = '100'; 
 
 //导出方法
export const dogSay = function(){ 
 console.log('wang wang');
}
 
 //导出方法第二种
function catSay(){
 console.log('miao miao'); 
}
export { catSay };
 
//export default导出
const m = 100;
export default m; 
//export defult const m = 100;// 这里不能写这种格式。

index.js

//index.js
'use strict'
var express = require('express');
var router = express.Router();
 
import { dogSay, catSay } from './testEs6Export'; //导出了 export 方法 
import m from './testEs6Export'; //导出了 export default （这里的m可以命名成其他名字，都能获取到default定义的东西）
 
import * as testModule from './testEs6Export'; //as 集合成对象导出

 /* GET home page. */
router.get('/', function(req, res, next) {
 dogSay();
 catSay();
 console.log(m);
 testModule.dogSay();
 console.log(testModule.m); // undefined , 因为 as 导出是 把 零散的 export 聚集在一起作为一个对象，而export default 是导出为 default属性。
 console.log(testModule.default); // 100
 res.send('恭喜你，成功验证');
});
 
module.exports = router;

从上面可以看出，确实感觉 ES6的模块系统非常灵活的。

 

import和require的选择

“改用require还是import？”这个问题，根本没法回答，因为目前所有的引擎都还没有实现import，我们在node中使用babel支持ES6，也仅仅是将ES6转码为ES5再执行，import语法会被转码为require。这也是为什么在模块导出时使用module.exports，在引入模块时使用import仍然起效，因为本质上，import会被转码为require去执行。

 

es6模块的使用场景和注意点

1，script标签必须使用 type="module",才能解析模块

2，es6的模块必须放在服务器上才能被浏览器解析，直接用浏览器打开会报错

3，模块被多次引用，但只会被执行一次　

<script type="module" src="./main.js"></script>
<!-- 或者 -->
<script type="module">
  import { firstName, lastName, year } from './profile.js';

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

var name ={};
setName(name) 
alert(name.textContent);
</script> 

 

CommonJS 模块加载 ES6 模块

CommonJS 的require()命令不能加载 ES6 模块，会报错，只能使用import()这个方法加载。

(async () => {
  await import('./my-app.mjs');
})();

上面代码可以在 CommonJS 模块中运行。

require()不支持 ES6 模块的一个原因是，它是同步加载，而 ES6 模块内部可以使用顶层await命令，导致无法被同步加载。

ES6 模块加载 CommonJS 模块

ES6 模块的import命令可以加载 CommonJS 模块，但是只能整体加载，不能只加载单一的输出项。

// 正确
import packageMain from 'commonjs-package';

// 报错
import { method } from 'commonjs-package';

这是因为 ES6 模块需要支持静态代码分析，而 CommonJS 模块的输出接口是module.exports，是一个对象，无法被静态分析，所以只能整体加载。

加载单一的输出项，可以写成下面这样。

import packageMain from 'commonjs-package';
const { method } = packageMain;

 

同时支持两种格式的模块：

一个模块同时要支持 CommonJS 和 ES6 两种格式。

如果原始模块是 ES格式：ES模块加载CJS模块

那么需要给出一个整体输出接口，比如export default obj，使得 CommonJS 可以用import()进行加载。

 

如果原始模块是 CommonJS 格式：CJS模块加载ES模块

在这个子目录里面放一个单独的package.json文件，指明{ type: "module" }。

另一种做法是在package.json文件的exports字段，指明两种格式模块各自的加载入口。

"exports"：{ 
    "require": "./index.js"，
    "import": "./esm/wrapper.js" 
}

上面代码指定require()和import()，加载该模块会自动切换到不一样的入口文件

 

使用babel

1.首先, 安装依赖

npm install 
    @babel/core@7.1.6 
    babel-core@^6.26.3 
    babel-plugin-transform-es2015-modules-commonjs@6.26.2 
    babel-polyfill@6.26.0 
    babel-preset-env@1.7.0 
    babel-preset-latest-node@2.0.2 
    babel-register@6.26.0 -D

2.在项目的根目录中添加 .babelrc 在该文件中粘贴以下内容

{
    "presets": ["env"],
    "plugins": ["transform-es2015-modules-commonjs"]
}

3.创建入口文件 index.js 并粘贴以下内容

require('babel-register');
const babel = require('@babel/core');
const babelPresetLatestNode = require('babel-preset-latest-node');

babel.transform('code();', {
  presets: [[babelPresetLatestNode, {
    target: 'current',
  }]],
});

require('babel-polyfill');
require('./src');

4. 创建 src 目录, 并添加 index.js 文件

​ 在index.js 文件中写ES6 或者nodejs 就可以了