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" 等被其他运行时或工具定义。