Node.js 入门笔记

1. 官方入门的 Node.js 例子 app.js:

const http = require('http');

const hostname = '127.0.0.1'
const port = 3000
const server = http.createServer((req, res) => {
  res.statusCode = 200
  res.setHeader('Content-Type', 'text/plain')
  res.end('Hello World')
})
server.listen(port, hostname, () => {
  console.log(`Server running at http://${hostname}:${port}/`)
})

执行命令 node app.js 就可以直接运行起来,无需 package.json 文件:

$ node app.js
Server running at http://127.0.0.1:3000/

这是一个简单的 http 服务器,用浏览器打开 http://localhost:3000 即可访问。

2. 关于 ES6 语法的使用

官方文档:《Node.js/ECMAScript Modules

如果要直接使用 es6 模块格式语法来编写 app.js,即将上面入门例子的 'const http = require('http');' 改为 'import http from 'http'',就算
使用当前(2020-02-05)最新的版本(node-13.7.0),运行 node app.js 会出错,报不支持 import 语法:

$ node app.js
(node:24425) Warning: To load an ES module, set "type": "module" in the package.json or use the .mjs extension.
/Volumes/RJ/work/github-simter-vue/simter-vue/app.js:1
import http from 'http'
^^^^^^

SyntaxError: Cannot use import statement outside a module

为了保证向后的兼容性,没有额外配置情况下,node 默认是按 CommonJS 模块规范加载模块的。但是 node 是同时支持 CommonJS 和 ES modules 的,最佳实践应该是显式指定(即在 package.json 文件内显式设置 type="module" 或 "commonjs")

package.json 中的 type 值是按照就近原则查找的,先在与 js 文件同级目录下查找,找不到就逐级向上级目录查找,直到根目录,这叫 Package Scope。例:

// my-app.js, in an ES module package scope because there is a package.json
// file in the same folder with "type": "module".

import './startup/init.js';
// Loaded as ES module since ./startup contains no package.json file,
// and therefore inherits the ES module package scope from one level up.

import 'commonjs-package';
// Loaded as CommonJS since ./node_modules/commonjs-package/package.json
// lacks a "type" field or contains "type": "commonjs".

import './node_modules/commonjs-package/index.js';
// Loaded as CommonJS since ./node_modules/commonjs-package/package.json
// lacks a "type" field or contains "type": "commonjs".

显式指定 Node.js 按 CommonJS 加载模块:

  1. 使用 .cjs 扩展名
  2. 使用 .js 扩展名或无扩展名,并在 package.json 文件指定 type="commonjs"

显式指定 Node.js 按 ES modules 加载模块:

  1. 使用 .mjs 扩展名
  2. 使用 .js 扩展名,并在 package.json 文件指定 type="module"

    显式设置 type="module" 后,代码中的 import "./abc.js",node 会按 ES module 方式加载 abc.js 模块。

故为了使上面用了 es6 语法的 js 也能正常运行,有如下两个方法。

2.1. 方法 1:

将文件名 app.js 更改为 app.mjs,然后运行 node app.mjs

$ node app.mjs
(node:24475) ExperimentalWarning: The ESM module loader is experimental.
Server running at http://127.0.0.1:3000/

2.2. 方法 2:

添加 package.json 文件,配置 type=module:

{
  "type": "module"
}

然后运行 node app.js

$ node app.js
(node:24475) ExperimentalWarning: The ESM module loader is experimental.
Server running at http://127.0.0.1:3000/

3. 直接在命令行输入脚本内容并执行

node --input-type=module --eval "import { sep } from 'path'; console.log(sep);"

# 或
echo "import { sep } from 'path'; console.log(sep);" | node --input-type=module

4. 模块入口 Package Entry Points

Node.js 并不认识 package.json 文件的顶级属性 module,这个属性是一些包构建工具使用的,官方文档《Dual CommonJS/ES Module Packages》有相应的说明。

通过 package.json 文件的 main 和 export 两个顶级属性来定义 entry points。

main 是所有版本的 Node.js 都支持的,exports 则需要较高的 Node.js 版本才支持,对于那些支持 exports 的版本,如果同时定义了 main 和 exports,它会优先选用 exports 的定义。

./node_modules/es-module-package/package.json:

{
  "type": "module",
  "main": "./src/index.js",
  "exports": {
    "./submodule": "./src/submodule.js", // file
    "./features/": "./src/features/"     // folder
  }
}

设置 exports=false 而不是 {} 来显式设置不导出任何子模块

./my-app.mjs:

// 1. 加载 ./node_modules/es-module-package/src/index.js
//   如果使用 requirs("es-module-package") 方式就会报错!因为 es-module-package 显式设置了 type=module。
import { something } from 'es-module-package';

// 2. 加载 ./node_modules/es-module-package/src/submodule.js
// 如果 submodule 并没有在 exports 中指定, import 就会报错
import submodule from 'es-module-package/submodule';

// 3. 加载 ./node_modules/es-module-package/src/features/x.js
import feature from 'es-module-package/features/x.js';

使用 exports 还可以根据不同的 Node.js 环境配置不同的入口,这叫 Conditional Exports

{
  "exports": {
    "import": "./main.mjs", // for load vis import ... from ... or import(...)
    "require": "./main.cjs", // for load via require(...)
    "default": "...",              // generic fallback
    "node": "..."                  // for any Node.js environment
  }
}

说明:

  1. 如果子模块也要定义特殊的 Conditional Exports,则使用 '.' 来表示主模块,如:
    {
      "exports": {
        ".": {
          "import": "./main.js",
          "require": "./main.cjs"
        },
        "./feature": {
          "import": "./feature-default.js",
          "browser": "./feature-browser.js"
        }
      }
    }
    

    子模块务必使用 './' 前缀指定。

  2. 还有 "browser", "electron", "deno", "react-native" 等被其他运行时或工具定义。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 207,113评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,644评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,340评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,449评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,445评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,166评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,442评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,105评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,601评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,066评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,161评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,792评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,351评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,352评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,584评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,618评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,916评论 2 344

推荐阅读更多精彩内容