如何基于 JSON Modules 提案直接异步导入原始配置数据并保持类型一致性

夏杰小哥_3401

夏杰小哥_3401

2026-05-07

882人浏览

原创

json modules 提案已进入 stage 4,支持通过 import json from "./file.json" assert { type: "json" } 直接导入并自动推导精确类型;typescript 4.5+ 需启用 "resolvejsonmodule": true,node.js 17.1+ 原生支持,vite/webpack 5+ 默认兼容。

如何基于 json modules 提案直接异步导入原始配置数据并保持类型一致性

可以使用 JSON Modules 提案(已进入 Stage 3,现代 TypeScript 和主流浏览器/打包工具普遍支持)直接 import JSON 文件,并在编译期保留类型推导,无需额外声明或运行时解析。关键在于启用相应配置并正确使用 assert(ES 模块规范)或工具链适配。

确保环境支持 JSON Modules

TypeScript 4.5+ 原生支持 JSON 导入(需 "resolveJsonModule": true 和 "esModuleInterop": true);Node.js 17.1+ 原生支持 import ... from "./config.json" assert { type: "json" };Vite、Webpack 5+、esbuild 等也默认兼容。

  • TSConfig 中启用:"resolveJsonModule": true 和 "moduleResolution": "node16" 或 "bundler"
  • Node.js 运行时需加 --experimental-json-modules(v18.12+ 已默认启用)
  • Vite 项目无需额外配置,直接 import 即可获得类型和 HMR 支持

同步导入(推荐用于构建时确定的配置)

最简方式:TypeScript 会自动为 JSON 文件生成精确类型,零成本、强类型、无运行时开销。

Wjs Uploading Video
Wjs Uploading Video

将一个或多个视频上传至YouTube。当用户想“上传到YouTube”“发YouTube”“批量上传”“upload to YouTube”“post videos to YouTube”或发布到YouTube时使用此技能。

下载
// config.json
{
  "apiUrl": "https://api.example.com",
  "timeoutMs": 5000,
  "features": {
    "darkMode": true,
    "analytics": false
  }
}

直接导入即得完整类型:

import config from "./config.json";
// config 的类型为自动推导的 { apiUrl: string; timeoutMs: number; features: { darkMode: boolean; analytics: boolean } }
console.log(config.apiUrl); // ✅ 类型安全,IDE 自动补全

异步导入原始 JSON(适用于动态路径或条件加载)

使用 import() 动态导入 + assert { type: "json" },可在运行时按需加载,且仍保持类型安全(TypeScript 5.0+ 支持动态导入断言的类型推导):

async function loadConfig(env: "prod" | "dev") {
  const mod = await import(`./config.${env}.json`, {
    assert: { type: "json" }
  });
  return mod.default as typeof import("./config.prod.json").default;
}

// 或更简洁地利用类型守卫(推荐)
type Config = typeof import("./config.prod.json").default;

async function loadConfigTyped(env: "prod" | "dev"): Promise<config> {
  const mod = await import(`./config.${env}.json`, {
    assert: { type: "json" }
  });
  return mod.default;
}</config>
  • 注意:Webpack/Vite 中动态路径需是静态可分析的(如模板字符串中变量必须是字面量联合类型)
  • 若用 TypeScript 4.x,可配合 as const + 类型别名提升推导精度
  • 不建议用 fetch + JSON.parse —— 会丢失类型、需手动校验、无 tree-shaking

保持类型一致性与最佳实践

避免类型漂移:让 JSON Schema 或 TS 接口成为单一事实来源。

  • 用 zod 或 io-ts 在运行时验证 JSON 内容(尤其当 JSON 来自外部或 CI 生成)
  • 将核心结构定义为 TS 接口,再用 export type Config = typeof config 复用导入类型
  • 配置文件命名统一(如 .jsonc 支持注释)、提交前加 lint(jsonc-eslint-parser)
  • 避免在 JSON 中放函数或 undefined —— 它们无法序列化,会破坏模块语义

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js json

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4886

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1209

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4824

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

960

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1876

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3465

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4513

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2960

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

948

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.8万人学习