區分ES6的export與Nodejs的module.exports的區別
目錄
前言
最近用Vue.js的框架去封裝請求方法,再用node.js搭建一個簡單服務測試請求的時候感覺module.exports / exports、require、export / import啥的寫法、效果相似但是有不同,感覺講不清哪裡有具體的差別,於是就重新學習了一下標準規範,記錄文章供參考。
require: node 和 es6 都支援的引入(CommonJS規範)
export / import : 只有es6 支援的匯出引入
module.exports / exports: 只有 node 支援的匯出(CommonJS規範)
CommonJS模組規範
Node應用由模組組成,採用CommonJS模組規範。
根據這個規範,每個檔案就是一個模組,有自己的作用域。在一個檔案裡面定義的變數、函式、類,都是私有的,對其他檔案不可見。
CommonJS規範規定,每個模組內部,module變數代表當前模組。這個變數是一個物件,它的exports屬性(即module.exports)是對外的介面。載入某個模組,其實是載入該模組的module.exports屬性。
exports 與 module.exports
var x = 5;
var addX = function (value) {
return value + x;
};
module.exports.x = x;
module.exports.addX = addX;
上面程式碼通過module.exports輸出變數x和函式addX。
require方法用於載入模組。
var example = require('./example.js');
console.log(example.x); // 5
console.log(example.addX(1)); // 6
為了方便,Node為每個模組提供一個exports變數,指向module.exports。這等同在每個模組頭部,有一行這樣的命令。
var exports = module.exports;
於是我們可以直接在 exports 物件上新增方法,表示對外輸出的介面,如同在module.exports上新增一樣。注意,不能直接將exports變數指向一個值,因為這樣等於切斷了exports與module.exports的聯絡。
ES6模組規範
不同於CommonJS,ES6使用 export 和 import 來匯出、匯入模組。
// profile.js
var firstName = 'Michael';
var lastName = 'Jackson';
var year = 1958;
export {firstName, lastName, year};
需要特別注意的是,export命令規定的是對外的介面,必須與模組內部的變數建立一一對應關係。
import 命令
使用export命令定義了模組的對外介面以後,其他 JS 檔案就可以通過import命令載入這個模組。
// main.js
import {firstName, lastName, year} from './profile';
function setName(element) {
element.textContent = firstName + ' ' + lastName;
}
上面程式碼的import命令,用於載入profile.js檔案,並從中輸入變數。import命令接受一對大括號,裡面指定要從其他模組匯入的變數名。大括號裡面的變數名,必須與被匯入模組(profile.js)對外介面的名稱相同。
如果想為輸入的變數重新取一個名字,import命令要使用as關鍵字,將輸入的變數重新命名。
import { lastName as surname } from './profile';
import後面的from指定模組檔案的位置,可以是相對路徑,也可以是絕對路徑,.js路徑可以省略。如果只是模組名,不帶有路徑,那麼必須有配置檔案,告訴 JavaScript 引擎該模組的位置。
// 寫法一
export var m = 1;
// 寫法二
var m = 1;
export {m};
// 寫法三
var n = 1;
export {n as m};
export default 命令
使用export default命令,為模組指定預設輸出。
// export-default.js
export default function () {
console.log('foo');
}
上面程式碼是一個模組檔案export-default.js,它的預設輸出是一個函式。
其他模組載入該模組時,import命令可以為該匿名函式指定任意名字。
// import-default.js
import customName from './export-default';
customName(); // 'foo'
上面程式碼的import命令,可以用任意名稱指向export-default.js輸出的方法,這時就不需要知道原模組輸出的函式名。需要注意的是,這時import命令後面,不使用大括號。
export default命令用在非匿名函式前,也是可以的。
// export-default.js
export default function foo() {
console.log('foo');
}
// 或者寫成
function foo() {
console.log('foo');
}
export default foo;
上面程式碼中,foo函式的函式名foo,在模組外部是無效的。載入的時候,視同匿名函式載入。
下面比較一下預設輸出和正常輸出。
// 第一組
export default function crc32() { // 輸出
// ...
}
import crc32 from 'crc32'; // 輸入
// 第二組
export function crc32() { // 輸出
// ...
};
import {crc32} from 'crc32'; // 輸入
上面程式碼的兩組寫法,第一組是使用export default時,對應的import語句不需要使用大括號;第二組是不使用export default時,對應的import語句需要使用大括號。
export default命令用於指定模組的預設輸出。顯然,一個模組只能有一個預設輸出,因此export default命令只能使用一次。所以,import命令後面才不用加大括號,因為只可能對應一個方法。
本質上,export default就是輸出一個叫做default的變數或方法,然後系統允許你為它取任意名字。所以,下面的寫法是有效的。
// modules.js
function add(x, y) {
return x * y;
}
export {add as default};
// 等同於
// export default add;
// app.js
import { default as xxx } from 'modules';
// 等同於
// import xxx from 'modules';
正是因為export default命令其實只是輸出一個叫做default的變數,所以它後面不能跟變數宣告語句。
// 正確
export var a = 1;
// 正確
var a = 1;
export default a;
// 錯誤
export default var a = 1;
上面程式碼中,export default a的含義是將變數a的值賦給變數default。所以,最後一種寫法會報錯。
有了export default命令,輸入模組時就非常直觀了,以輸入 lodash 模組為例。
import _ from 'lodash';
如果想在一條import語句中,同時輸入預設方法和其他變數,可以寫成下面這樣。
import _, { each } from 'lodash';
對應上面程式碼的export語句如下。
export default function (obj) {
// ···
}
export function each(obj, iterator, context) {
// ···
}
export { each as forEach };
上面程式碼的最後一行的意思是,暴露出forEach介面,預設指向each介面,即forEach和each指向同一個方法。
如果要輸出預設的值,只需將值跟在export default之後即可。
export default 42;
export default也可以用來輸出類。
// MyClass.js
export default class { ... }
// main.js
import MyClass from 'MyClass';
let o = new MyClass();
export 與 import 的複合寫法
如果在一個模組之中,先輸入後輸出同一個模組,import語句可以與export語句寫在一起。
export { foo, bar } from 'my_module';
// 等同於
import { foo, bar } from 'my_module';
export { foo, boo};
上面程式碼中,export和import語句可以結合在一起,寫成一行。
模組的介面改名和整體輸出,也可以採用這種寫法。
// 介面改名
export { foo as myFoo } from 'my_module';
// 整體輸出
export * from 'my_module';
預設介面的寫法如下。
export { default } from 'foo';
具名介面改為預設介面的寫法如下。
export { es6 as default } from './someModule';
// 等同於
import { es6 } from './someModule';
export default es6;
同樣地,預設介面也可以改名為具名介面。
export { default as es6 } from './someModule';
另外,ES7有一個提案,簡化先輸入後輸出的寫法,拿掉輸出時的大括號。
// 現行的寫法
export {v} from 'mod';
// 提案的寫法
export v from 'mod';
參考連結:
http://javascript.ruanyifeng.com/nodejs/module.html
http://caibaojian.com/es6/module.html