ECMAScript模块中nodejs怎么加载json文件

发布时间：2021-12-08 09:36:01 作者：iii
来源：亿速云阅读：205

# ECMAScript模块中Node.js怎么加载JSON文件

## 引言

随着ECMAScript模块(ESM)在Node.js中的正式支持，开发者开始逐渐从CommonJS迁移到ESM体系。在这个过程中，JSON文件的加载方式发生了显著变化。本文将深入探讨在ESM模式下Node.js加载JSON文件的各种方法、背后的原理以及实际应用中的最佳实践。

## 一、CommonJS与ESM加载JSON的差异

### 1.1 CommonJS的传统方式

在CommonJS模块系统中，加载JSON文件非常简单：

```javascript
// CommonJS方式
const data = require('./config.json');
console.log(data.apiKey);

这种方式的特性包括： - 同步加载机制 - 自动解析JSON内容 - 返回的是解析后的JavaScript对象

1.2 ESM的挑战与变化

当切换到ESM模式后，上述方法将不再适用：

// 以下代码在ESM中会报错
import data from './config.json'; // 报错：JSON模块不支持

这是因为ECMAScript规范最初并未定义JSON模块的加载方式，Node.js需要特殊的处理机制。

二、Node.js中的JSON模块支持

2.1 实验性支持阶段

从Node.js v12开始，通过--experimental-json-modules标志提供了JSON模块的实验性支持：

node --experimental-json-modules app.mjs

对应的代码写法：

import data from './config.json' assert { type: 'json' };
console.log(data.apiKey);

2.2 正式支持后的语法

从Node.js v16开始，JSON模块成为稳定功能：

// 标准写法
import data from './config.json' assert { type: 'json' };

// 也可以使用默认导入
import { default as data } from './config.json' assert { type: 'json' };

2.3 导入断言(Import Assertions)

这种语法被称为”导入断言”，它： - 向运行时声明模块类型 - 是TC39标准的一部分 - 可以防止意外的文件类型执行

三、替代加载方案

3.1 使用`fs`模块读取

import { readFile } from 'fs/promises';

async function loadJSON(filePath) {
  const content = await readFile(filePath, 'utf8');
  return JSON.parse(content);
}

const data = await loadJSON('./config.json');

优缺点分析： - ✅ 不需要特殊标志或语法 - ✅ 适用于所有Node.js版本 - ❌ 需要手动错误处理 - ❌ 异步操作稍显繁琐

3.2 动态`import()`

async function loadJSON(url) {
  const { default: data } = await import(url, {
    assert: { type: 'json' }
  });
  return data;
}

const data = await loadJSON('./config.json');

3.3 使用`module.createRequire`

import { createRequire } from 'module';
const require = createRequire(import.meta.url);

const data = require('./config.json');

这种方法实际上是在ESM中混用CommonJS的require。

四、深入理解JSON模块的工作原理

4.1 加载过程解析

解析阶段：Node.js识别assert { type: 'json' }声明
获取阶段：读取文件内容
转换阶段：将JSON文本转换为JavaScript对象
执行阶段：作为模块的默认导出

4.2 与常规模块的区别

特性	JSON模块	JavaScript模块
解析方式	JSON.parse	JavaScript引擎
导出对象	自动包装为默认导出	显式export语句
缓存策略	相同	相同
内容校验	严格JSON格式	JavaScript语法

五、实际应用中的注意事项

5.1 路径解析规则

JSON文件的路径解析遵循ESM规则： - 必须使用完整扩展名(.json) - 相对路径需要以./或../开头 - 可以使用import.meta.url作为基准

5.2 错误处理

推荐的处理方式：

try {
  const data = await import('./config.json', {
    assert: { type: 'json' }
  });
} catch (err) {
  if (err.code === 'ERR_IMPORT_ASSERTION_TYPE_MISSING') {
    console.error('缺少JSON类型断言');
  } else if (err.code === 'ENOENT') {
    console.error('文件不存在');
  } else {
    console.error('JSON解析错误', err);
  }
}

5.3 性能考量

JSON模块会被缓存，重复导入不会重复解析
大型JSON文件建议使用流式处理
敏感数据应考虑加密或环境变量

六、高级应用场景

6.1 配合TypeScript使用

在tsconfig.json中配置：

{
  "compilerOptions": {
    "module": "esnext",
    "resolveJsonModule": true
  }
}

然后可以这样导入：

import data from './config.json' assert { type: 'json' };

6.2 在Web框架中的应用

以Express为例：

import express from 'express';
import config from './config.json' assert { type: 'json' };

const app = express();
app.set('config', config);

app.listen(config.port, () => {
  console.log(`Server running on port ${config.port}`);
});

6.3 配合打包工具使用

Webpack和Rollup等工具通常有自己的JSON加载方式：

// webpack.config.js
module.exports = {
  module: {
    rules: [
      {
        test: /\.json$/,
        type: 'javascript/auto',
        use: 'json-loader'
      }
    ]
  }
};

七、未来发展方向

导入断言的演进：可能会简化为import data from "data.json" with type: "json"
更严格的校验：可能加入JSON Schema验证
浏览器兼容性：逐步统一Node.js和浏览器的JSON模块加载方式

八、总结与最佳实践

8.1 方法选择建议

场景	推荐方法
现代Node.js环境	原生JSON模块+导入断言
需要向后兼容	`fs.readFile`+`JSON.parse`
混合模块系统项目	`createRequire`
前端项目/使用打包工具	工具提供的JSON加载器

8.2 推荐的代码模式

// 现代Node.js应用
import config from '../config.json' assert { type: 'json' };

// 需要兼容的实用函数
async function loadJSON(path) {
  try {
    if (typeof process !== 'undefined' && 
        process.versions?.node) {
      const { readFile } = await import('fs/promises');
      return JSON.parse(await readFile(path));
    }
    const response = await fetch(path);
    return await response.json();
  } catch (err) {
    console.error(`Failed to load JSON: ${path}`, err);
    throw err;
  }
}

8.3 安全注意事项

永远不要加载不受信任的JSON文件
考虑使用JSON.parse的reviver函数进行数据清洗
对于敏感配置，应结合环境变量使用

结语

随着JavaScript生态的不断发展，JSON作为最重要的数据交换格式之一，其在模块系统中的加载方式也越来越规范化。理解这些机制不仅能帮助开发者正确加载JSON数据，还能为处理其他类型的资源模块提供思路。建议开发者根据实际项目需求，选择最适合的JSON加载策略，并在项目文档中明确记录所采用的方法。

本文基于Node.js 18 LTS版本编写，部分特性在旧版本中可能不可用。在实际开发中，请始终参考官方文档获取最新信息。 “`

这篇文章共计约2700字，涵盖了从基础到高级的JSON模块加载知识，采用Markdown格式编写，包含代码示例、比较表格和结构化内容。文章既介绍了标准用法，也提供了替代方案和实际应用建议，适合不同层次的Node.js开发者阅读。