如何讓node運行es6模塊文件及其原理詳解
最新版的 node 支持最新版 ECMAScript 幾乎所有特性,但有一個特性卻一直到現(xiàn)在都還沒有支持,那就是從 ES2015 開始定義的模塊化機制。而現(xiàn)在我們很多項目都是用 es6 的模塊化規(guī)范來寫代碼的,包括 node 項目,所以,node 不能運行 es6 模塊文件就會很不便。
讓 node 運行 es6 模塊文件的方式有兩種:
- 轉(zhuǎn)碼
es6模塊為commonjs模塊 hooknode的require機制,直接讓node的require加載import/export
1. 轉(zhuǎn)碼 es6 模塊為 commonjs 模塊
因為 node 支持幾乎所有除 import/export 外的語法,所以我們只需要將 import/export 轉(zhuǎn)碼成 require/exports,而不需要轉(zhuǎn)碼其他語法。
比如下面的項目:
- package.json - src/ - index.js - print.js - ...
# package.json
{
"main": "lib/index.js" # 由工具轉(zhuǎn)碼 src 目錄下源文件到 lib 目錄下
}
# src/index.js
import print from './print';
print('index');
export default print;
# src/print.js
export default str => {
console.log('print: ' + str);
};
因為 src 目錄下的源文件都是 es6 模塊化規(guī)范的,node 并不能直接運行,所以需要轉(zhuǎn)碼成 commonjs 規(guī)范的代碼。
這個過程有兩個方案:
- 如果不會單獨使用
src目錄下的某個文件,而僅僅是以src/index.js為入口文件使用,可以把src目錄下的文件打包成一個文件到lib/index.js:這種方式推薦使用工具 rollup - 如果需要單獨使用
src目錄下的文件,那就需要把src目錄下的文件一對一的轉(zhuǎn)碼到lib目錄下:這種方式推薦使用工具 gulp + babel
1.1 用 rollup 把 src 目錄下的文件打包成一個文件到 lib/index.js
相關(guān)文件:
# rollup.config.js
export default {
input: 'src/index.js',
output: {
file: 'lib/index.js',
format: 'cjs',
},
};
# package.json
{
"scripts": {
"build": "rollup -c"
},
"devDependencies": {
"rollup": "^0.66.4"
}
}
運行命令:
npm run build
結(jié)果:
# lib/index.js
'use strict';
var print = str => {
console.log('print: ' + str);
};
print('index');
module.exports = print;
1.2 用 gulp + babel 把 src 目錄下的文件一對一的轉(zhuǎn)碼到 lib 目錄下
相關(guān)文件:
# build.js
const gulp = require('gulp');
const babel = require('gulp-babel');
gulp.task('babel', () =>
gulp.src('src/**/*.js')
.pipe(babel({
plugins: ['@babel/plugin-transform-modules-commonjs']
}))
.pipe(gulp.dest('lib'))
);
gulp.series('babel')();
# package.json
{
"scripts": {
"build": "node build.js"
},
"devDependencies": {
"@babel/core": "^7.1.2",
"@babel/plugin-transform-modules-commonjs": "^7.2.0",
"gulp": "^4.0.0",
"gulp-babel": "^8.0.0"
}
}
運行命令:
npm run build
結(jié)果:
# lib/index.js
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _print = _interopRequireDefault(require("./print"));
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
(0, _print.default)('index');
var _default = _print.default;
exports.default = _default;
# lib/print.js
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _default = str => {
console.log('print: ' + str);
};
exports.default = _default;
2. hook node 的 require 機制,直接加載 import/export
這種機制一般是通過對 node 的 require 機制進行 hook,劫持 require 抓取的源文件代碼,把源代碼轉(zhuǎn)碼成 commonjs 規(guī)范之后,再傳送給 require 機制原本的代碼流中。
pirates 之類的第三方 npm 包提供了這種添加 hook 的功能。
babel-register 便是使用這種方式達到 node 運行 es6 模塊文件的目的的。
2.1 使用 babel-register 直接運行 es6 模塊文件
示例目錄:
- package.json - src/ - entry.js # 這里多了一個入口文件,專門用于注冊 babel-register - index.js - print.js - ...
相關(guān)文件:
# package.json
{
"scripts": {
"run": "node src/entry.js"
},
"devDependencies": {
"@babel/core": "^7.1.2",
"@babel/plugin-transform-modules-commonjs": "^7.2.0",
"@babel/register": "^7.0.0"
}
}
# src/entry.js # 入口文件必須使用 commonjs 規(guī)范來寫,因為還沒有注冊 hook
require('@babel/register')({
plugins: ['@babel/plugin-transform-modules-commonjs']
});
require('./index');
# src/index.js
import print from './print';
print('index');
# src/print.js
export default str => {
console.log('print: ' + str);
};
運行:
npm run run
結(jié)果:
# 命令行打印 print: index
這種方式因為中間轉(zhuǎn)碼會有額外的性能損耗,所以不建議在生產(chǎn)環(huán)境下使用,只建議在開發(fā)模式下使用。
2.2 使用babel-node 直接運行 es6 模塊文件
babel-node 對 babel-register 進行了封裝,提供了在命令行直接運行 es6 模塊文件的便捷方式。
示例目錄:
- package.json - src/ - index.js - print.js - ...
相關(guān)文件:
# package.json
{
"scripts": {
"run": "babel-node src/index.js --plugins @babel/plugin-transform-modules-commonjs"
},
"devDependencies": {
"@babel/core": "^7.1.2",
"@babel/node": "^7.2.0",
"@babel/plugin-transform-modules-commonjs": "^7.2.0"
}
}
# src/index.js
import print from './print';
print('index');
# src/print.js
export default str => {
console.log('print: ' + str);
};
運行:
npm run run
結(jié)果:
# 命令行打印 print: index
這種方式也不建議在生產(chǎn)環(huán)境下使用,只建議在開發(fā)模式下使用。
3. 鏈接
es6 就是指 ECMAScript 2015
es7 就是指 ECMAScript 2016
es8 就是指 ECMAScript 2017
es9 就是指 ECMAScript 2018
到寫這篇文章為止,已發(fā)布了 ECMAScript 2018。
以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
- ES6中module模塊化開發(fā)實例淺析
- ES6模塊化的import和export用法方法總結(jié)
- ES6新特性:使用export和import實現(xiàn)模塊化詳解
- ES6使用export和import實現(xiàn)模塊化的方法
- ES6新特性之模塊Module用法詳解
- 詳談commonjs模塊與es6模塊的區(qū)別
- ES6與CommonJS中的模塊處理的區(qū)別
- ES6新特性之解構(gòu)、參數(shù)、模塊和記號用法示例
- 詳解CommonJS和ES6模塊循環(huán)加載處理的區(qū)別
- NodeJS模塊與ES6模塊系統(tǒng)語法及注意點詳解
- ES6知識點整理之模塊化的應(yīng)用詳解
相關(guān)文章
編譯打包nodejs服務(wù)代碼如何部署到服務(wù)器
這篇文章主要介紹了編譯打包nodejs服務(wù)代碼如何部署到服務(wù)器問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-10-10
Node.js的項目構(gòu)建工具Grunt的安裝與配置教程
Grunt是為Node打造的項目構(gòu)建工具,相當(dāng)于C/C++世界中的makefile,可以執(zhí)行像壓縮、編譯、單元測試、代碼檢查以及打包發(fā)布的任務(wù),下面我們就來一起看一下Node.js的項目構(gòu)建工具Grunt的安裝與配置教程:2016-05-05

