JavaScript / TypeScript / 系统课时

ES 模块导入导出

ES 模块导入导出

ES 模块让不同文件通过明确的导入、导出建立依赖。本节用一个可运行的 Node.js + TypeScript 示例串起命名导出、类型导入和默认导出的边界,最终能独立组织跨文件代码并验证编译结果。

学习目标

  • 使用 export 与 import 在多个文件之间共享值和函数
  • 使用 export type、import type 区分类型依赖与运行时依赖
  • 理解命名导出、默认导出以及 NodeNext 下相对路径扩展名的规则

用命名导出连接两个文件

ES 模块中的变量默认只在当前文件可见,只有显式导出的成员才能被其他模块引用。下面把计算逻辑放在 src/math.ts,入口文件只负责选择运算并输出结果。

片段示例(完整模块文件,需与后续入口文件和项目配置一起使用):

ts
// src/math.ts
export type Operation = "add" | "multiply";

export function calculate(
  left: number,
  right: number,
  operation: Operation,
): number {
  return operation === "add" ? left + right : left * right;
}

export const version = "1.0";

入口文件同时导入运行时值和仅用于类型检查的类型。片段示例(需与上面的模块文件和后续配置一起使用):

ts
// src/index.ts
import { calculate, version } from "./math.js";
import type { Operation } from "./math.js";

const operation: Operation = "multiply";
const result = calculate(6, 7, operation);

console.log(`version=${version}`);
console.log(`result=${result}`);

这里写 ./math.js 而不是 ./math.ts,是因为示例采用 NodeNext 的 ESM 规则:TypeScript 编译时可以把该说明符解析到 math.ts,输出 JavaScript 时仍保留可供 Node.js 加载的 .js 路径。

配置并运行 ESM 项目

项目需要让 Node.js 把输出文件视为 ES 模块,同时让 TypeScript 按 Node 的现代模块规则检查路径。创建 package.json:

json
{
  "type": "module"
}

再创建 tsconfig.json:

json
{
  "compilerOptions": {
    "target": "ES2022",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "rootDir": "src",
    "outDir": "dist",
    "strict": true
  },
  "include": ["src/**/*.ts"]
}

这两个配置分别让 Node.js 以 ESM 方式加载输出文件,并让 TypeScript 使用 NodeNext 规则解析模块。验证方法是在已安装 TypeScript 的项目目录执行编译和运行:

bash
npx tsc
node dist/index.js

预期输出:

text
version=1.0
result=42

如果实际项目目录不同,命令中的路径也会随之变化。

类型导入不会成为运行时依赖

Operation 只参与静态类型检查,因此使用 import type。编译后的 dist/index.js 不会为了这个类型额外生成导入项;calculate 和 version 则必须保留,因为 Node.js 运行时真的会用到它们。对外提供纯类型时,也可以写 export type { SomeType },让模块边界更清晰。

这一区分对大型项目尤其重要:看到普通 import 时,可以认为它可能影响运行时依赖图;看到 import type 时,则明确知道它只服务于 TypeScript 类型系统。

默认导出与命名导出的选择

命名导出要求导入方使用确切名称,例如 import { calculate } ...,适合同一模块暴露多个相关能力,也便于编辑器重构和统一命名。默认导出使用 export default,导入方可自行命名,更适合一个文件只有一个主要导出对象的场景。

两种形式都合法,但不要为了省花括号而滥用默认导出。一个模块包含多个函数、常量和类型时,优先使用命名导出通常更容易阅读,也能直接看出导入成员来自哪里。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

ES 模块导入导出

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通