【大战前端开发系列】Node.js模块导入方式漫谈

编程语言支持模块化开发，各个开发框架也不例外，全部支持模块的导入和导出，这样方便代码的复用，站在前人的肩膀上走的更远。

那么，Node.js中是如何导入模块的呢？

一 模块导入系统

Node.js最初使用了CommonJS模块系统，但随着JavaScript的发展，ECMAScript模块（ESM）系统也被引入。这两种模块系统在Node.js中都得到了支持，但它们在设计和行为上有所不同。

1.1 CommonJS

优势：

• 同步导入：CommonJS模块是同步加载的，这对于服务器环境（如Node.js）是可行的，因为它们通常在开始执行前就完成了模块的加载。
• 易于理解：对于JavaScript开发者来说，CommonJS的require和module.exports语法简单直观。
• 成熟稳定：CommonJS是Node.js的传统模块系统，有着广泛的社区支持和丰富的模块生态。

局限性：

• 同步加载：CommonJS模块的同步加载在浏览器环境中不可行，因为会导致页面加载阻塞。
• 全局作用域污染：使用require导入全局变量可能导致命名冲突。
• 动态导入限制：CommonJS没有原生支持动态导入。

1.2 ECMAScript模块（ESM）

优势：

• 异步导入：ESM支持异步加载模块，这对于浏览器环境和未来的Node.js环境都是有益的，可以提高应用的加载性能。
• 静态分析：由于ESM模块的导入在编译时就已确定，这使得它们更容易进行静态分析和优化。
• 更好的作用域管理：ESM使用import和export，不会污染全局作用域。
• 树摇（Tree-shaking）：ESM支持更高效的死代码消除，有助于减少最终打包体积。

局限性：

• 学习曲线：对于习惯了CommonJS的开发者来说，ESM可能需要一些时间来适应。
• 向后兼容性：在Node.js中，ESM的引入需要考虑与CommonJS的兼容性问题。
• 动态导入的复杂性：虽然ESM支持动态导入，但使用起来比CommonJS的require更复杂。

1.3 Node.js中的模块系统

在Node.js中，CommonJS和ESM可以共存，但它们有一些关键的区别：

• 文件扩展名：CommonJS通常使用.js扩展名，而ESM可以使用.mjs或者在package.json中设置"type": "module"后使用.js。
• 顶层await：在ESM中，可以在模块的顶层使用await，而CommonJS则不行。
• 默认导出：ESM支持默认导出，而CommonJS使用module.exports。

CommonJS和ESM各有优势和局限性，它们适用于不同的场景。CommonJS在Node.js中已经非常成熟，而ESM则代表了现代JavaScript的发展方向，提供了更好的性能和更清晰的语法。随着Node.js对ESM的原生支持逐渐增强，预计ESM将会在未来的JavaScript开发中扮演更重要的角色。

二 模块导入方式汇总

2.1. 动态导入：

使用import()函数进行动态导入，这是一个返回Promise的异步函数，允许你在需要时才加载模块。

import('./module.js')
  .then(module => {
    module.exportedFunction();
  })
  .catch(err => {
    console.error(err);
  });

2.2 ES6 模块导入：

在支持ES6模块的环境中，可以使用import语句来导入模块。

import { exportedFunction } from './module.js';
exportedFunction();

2.3 路径别名：

可以在项目的package.json中配置"_moduleAliases"字段，为模块路径设置别名。

{
  "_moduleAliases": {
    "@utils": "path/to/utils"
  }
}

然后在代码中使用别名导入模块：

const utils = require('@utils');

2.4 相对路径：

使用相对路径来导入同一项目中的其他模块。

const someFunction = require('./utils/someFunction');

2.5 绝对路径：

使用绝对路径来导入模块，从项目的根目录开始。

const someFunction = require('/utils/someFunction');

2.6 核心模块：

直接使用核心模块，不需要导入。

const http = require('http');

2.7 npm 包：

使用npm安装的包可以直接通过包名导入。

const express = require('express');

2.8 文件系统模块：

使用文件系统路径来导入非JavaScript文件，如JSON文件。

const packageJson = require('./package.json');

2.9 模块重导出：

使用module.exports重导出一个模块。

// lib/math.js
const math = require('./math');
module.exports = math;

// app.js
const math = require('./lib/math');

2.10 使用解构赋值：

使用解构赋值语法从模块中导入特定的导出。

import { add, subtract } from './mathModule';

2.11 使用通配符：

使用通配符*从模块中导入所有导出。

import * as mathModule from './mathModule';

2.12 使用默认导出：

如果模块有一个默认导出，可以直接导入。

import MyDefaultExport from './module';

这么多导入方式，到底该如何选择呢？

选择哪种方式取决于项目需求、代码风格以及Node.js的版本。随着Node.js对ES6模块支持的增强，import语句可能会成为更常用的导入方式。