Node中沒搞明白require和import，你會被坑的很慘
- 2019 年 12 月 4 日
- 筆記
ES6標準發布後，module成為標準，標準的使用是以export指令導出介面，以import引入模組，但是在我們一貫的node模組中，我們採用的是CommonJS規範，使用require引入模組，使用module.exports導出介面。
不把require和import整清楚，會在未來的標準編程中死的很難看。
require時代的模組
node編程中最重要的思想之一就是模組，而正是這個思想，讓JavaScript的大規模工程成為可能。模組化編程在js界流行，也是基於此，隨後在瀏覽器端，requirejs和seajs之類的工具包也出現了，可以說在對應規範下，require統治了ES6之前的所有模組化編程，即使現在，在ES6 module被完全實現之前，還是這樣。
node的module遵循CommonJS規範，requirejs遵循AMD，seajs遵循CMD，雖各有不同，但總之還是希望保持較為統一的程式碼風格。
// a.js // -------- node ----------- module.exports = { a : function() {}, b : 'xxx' }; // ----------- AMD or CMD ---------------- define(function(require, exports, module){ module.exports = { a : function() {}, b : 'xxx' }; });
可以看出，為了保持風格的高度統一，除了在瀏覽器端的模組中要使用一個define函數來提供模組的閉包以外，其他程式碼可以完全一致。
// b.js // ------------ node --------- var m = require('./a'); m.a(); // ------------ AMD or CMD ------------- define(function(require, exports, module){ var m = require('./a'); m.a(); });
在使用上，也非常相似。雖然AMD or CMD提供了更加豐富的風格，但是我們本文主要是討論node環境下，所以不做擴展。
ES6中的module
ES6發布的module並沒有直接採用CommonJS，甚至連require都沒有採用，也就是說require仍然只是node的一個私有的全局方法，module.exports也只是node私有的一個全局變數屬性，跟標準半毛錢關係都沒有。
export導出模組介面
export的用法挺複雜的，具體有哪些可以看這裡。這裡舉幾個例子：
// a.js export default function() {} export function a () {} var b = 'xxx'; export {b}; // 這是ES6的寫法，實際上就是{b:b} setTimeout(() => b = 'ooo', 1000); export var c = 100;
在要導出的介面前面，加入export指令。
在export之後，b還可以被修改，這和CommonJS有著巨大不同，關於內部機理的東西，本文就無恥的省略了。
注意，下面的語法有嚴重錯誤：
// 錯誤演示 export 1; // 絕對不可以 var a = 100; export a;
export在導出介面的時候，必須與模組內部的變數具有一一對應的關係。直接導出1沒有任何意義，也不可能在import的時候有一個變數與之對應。export a雖然看上去成立，但是a的值是一個數字，根本無法完成解構，因此必須寫成export {a}的形式。即使a被賦值為一個function，也是不允許的。而且，大部分風格都建議，模組中最好在末尾用一個export導出所有的介面，例如：
export {fun as default,a,b,c};
import導入模組
import的語法跟require不同，而且import必須放在文件的最開始，且前面不允許有其他邏輯程式碼，這和其他所有程式語言風格一致。
import的使用和export一樣，也挺複雜，可以在這裡大致了解。舉幾個例子：
import $ from 'jquery'; import * as _ from '_'; import {a,b,c} from './a'; import {default as alias, a as a_a, b, c} from './a';
這裡有一些坑，暫時不透露，下面會講到。
import後面跟上花括弧的形式是最基本的用法，花括弧裡面的變數與export後面的變數一一對應。這裡，你必須了解對象的解構賦值的知識，沒這知識，你根本沒法在這裡裝逼。了解了解構賦值，這裡的「一一對應」的關係就能具體理解了。
as關鍵字
編程的同學對as都容易理解，簡單的說就是取一個別名。export中可以用，import中其實可以用：
// a.js var a = function() {}; export {a as fun}; // b.js import {fun as a} from './a'; a();
上面這段程式碼，export的時候，對外提供的介面是fun，它是a.js內部a這個函數的別名，但是在模組外面，認不到a，只能認到fun。
import中的as就很簡單，就是你在使用模組裡面的方法的時候，給這個方法取一個別名，好在當前的文件裡面使用。之所以是這樣，是因為有的時候不同的兩個模組可能通過相同的介面，比如有一個c.js也通過了fun這個介面：
// c.js export function fun() {};
如果在b.js中同時使用a和c這兩個模組，就必須想辦法解決介面重名的問題，as就解決了。
default關鍵字
其他人寫教程什麼的，都把default放到export那個部分，我覺得不利於理解。在export的時候，可能會用到default，說白了，它其實是別名的語法糖：
// d.js export default function() {} // 等效於： function a() {}; export {a as default};
在import的時候，可以這樣用：
import a from './d'; // 等效於，或者說就是下面這種寫法的簡寫，是同一個意思 import {default as a} from './d';
這個語法糖的好處就是import的時候，可以省去花括弧{}。簡單的說，如果import的時候，你發現某個變數沒有花括弧括起來（沒有*號），那麼你在腦海中應該把它還原成有花括弧的as語法。
所以，下面這種寫法你也應該理解了吧：
import $,{each,map} from 'jquery';
import後面第一個$是{defalut as $}的替代寫法。
*符號
*就是代表所有，只用在import中，我們看下兩個例子：
import * as _ from '_';
在意義上和import _ from '_';是不同的，雖然實際上後面的使用方法是一樣的。它表示的是把'_'模組中的所有介面掛載到_這個對象上，所以可以用_.each調用某個介面。
另外還可以通過*號直接繼承某一個模組的介面：
export * from '_'; // 等效於： import * as all from '_'; export all;
*符號儘可能少用，它實際上是使用所有export的介面，但是很有可能你的當前模組並不會用到所有介面，可能僅僅是一個，所以最好的建議是使用花括弧，用一個加一個。
該用require還是import？
require的使用非常簡單，它相當於module.exports的傳送門，module.exports後面的內容是什麼，require的結果就是什麼，對象、數字、字元串、函數……再把require的結果賦值給某個變數，相當於把require和module.exports進行平行空間的位置重疊。
而且require理論上可以運用在程式碼的任何地方，甚至不需要賦值給某個變數之後再使用，比如：
require('./a')(); // a模組是一個函數，立即執行a模組函數 var data = require('./a').data; // a模組導出的是一個對象 var a = require('./a')[0]; // a模組導出的是一個數組
你在使用時，完全可以忽略模組化這個概念來使用require，僅僅把它當做一個node內置的全局函數，它的參數甚至可以是表達式：
require(process.cwd() + '/a');
但是import則不同，它是編譯時的（require是運行時的），它必須放在文件開頭，而且使用格式也是確定的，不容置疑。它不會將整個模組運行後賦值給某個變數，而是只選擇import的介面進行編譯，這樣在性能上比require好很多。
從理解上，require是賦值過程，import是解構過程，當然，require也可以將結果解構賦值給一組變數，但是import在遇到default時，和require則完全不同：var $ = require('jquery');和import $ from 'jquery'是完全不同的兩種概念。
上面完全沒有回答「改用require還是import？」這個問題，因為這個問題就目前而言，根本沒法回答，因為目前所有的引擎都還沒有實現import，我們在node中使用babel支援ES6，也僅僅是將ES6轉碼為ES5再執行，import語法會被轉碼為require。這也是為什麼在模組導出時使用module.exports，在引入模組時使用import仍然起效，因為本質上，import會被轉碼為require去執行。
但是，我們要知道這樣一個道理，ES7很快也會發布，js引擎們會儘快實現ES6標準的規定，如果一個引擎連標準都實現不了，就會被淘汰，ES6是遲早的事。如果你現在仍然在程式碼中部署require，那麼等到ES6被引擎支援時，你必須升級你的程式碼，而如果現在開始部署import，那麼未來可能只需要做很少的改動。（完）
