Node.js 官方文档

一、网站简介

Node.js 官方文档（nodejs.org/docs/）是 Node.js 运行时环境的权威 API 参考和开发指南，由 OpenJS 基金会维护。它完整记录了所有内置模块（fs、http、path、buffer、stream、crypto 等）的接口规范、事件说明和使用示例，并提供了从命令行工具到 Web 服务器的全面开发指导。Node.js 的全栈 JavaScript 能力使其成为前后端统一技术栈的核心支柱，官方文档是每一位 Node.js 开发者最频繁查阅的技术资源。

二、公司背景

Node.js 由 Ryan Dahl 于 2009 年创建，首次将 Google Chrome 的 V8 JavaScript 引擎移植到服务器端，使 JavaScript 具备了文件系统、网络、进程管理等系统级能力。2015 年 Node.js 基金会成立（后与 JS 基金会合并为 OpenJS 基金会），Node.js 成为社区治理的开源项目。目前全球超过 3000 万开发者使用 Node.js，几乎所有前端工具链（Webpack、Vite、ESLint、Prettier）均基于 Node.js 构建。官方文档由 Node.js 核心贡献者编写，随每个 LTS 版本发布更新。

三、核心功能

• 完整 API 参考：按模块分类详细记录 assert、buffer、child_process、cluster、crypto、dgram、dns、events、fs、http、https、net、os、path、process、querystring、readline、stream、string_decoder、timers、tls、url、util、zlib 等所有内置模块的方法签名、参数类型、返回值、事件及错误码。
• 文件系统（fs）操作指南：涵盖同步/异步文件读写、流式处理、文件监控、权限管理、临时文件创建等操作，并针对不同操作系统（Windows/macOS/Linux）的路径差异给出注意事项。
• HTTP 模块深度解析：从创建最简 HTTP 服务器到处理请求响应、设置 Header、处理文件上传、实现反向代理，结合 Stream 模块实现高效数据传输。
• Node.js 指南（Guides）：覆盖“如何编写 CLI 工具”、“使用 node-addon-api 开发 C++ 扩展”、“诊断内存泄漏”、“分析 CPU 性能”等高级主题，提供基于真实场景的完整代码示例。
• ES 模块与 CommonJS 互操作文档：详细说明两种模块系统的加载机制、互操作规则和迁移策略，帮助开发者在项目中平滑过渡到 ESM。
• npm 包管理器文档：涵盖 package.json 字段详解、语义化版本控制、npm scripts、workspaces 单仓库管理及 npm audit 安全审计等核心功能。

四、网站特点

• LTS 版本清晰标识：文档顶部明确标注当前查看的 Node.js 版本号及 LTS 状态，开发者可切换查看 v18、v20、v22 等不同版本的 API 文档，避免版本差异导致的接口不存在问题。
• 中文社区站点 nodejs.cn：官方认可的中文文档镜像站，完整翻译了 Node.js API 文档，国内访问速度快，搜索功能针对中文优化。
• 稳定性索引明确：每个模块的 API 都标注了稳定性等级（Stable、Experimental、Deprecated），帮助开发者判断是否适合在生产环境使用。
• CHANGELOG 详尽：每个版本的变更日志记录每一项 API 的新增、修改和废弃，便于升级前评估影响范围。

五、适用人群

• Node.js 后端开发工程师：使用 Express、Koa、Fastify、Nest.js 等框架开发 REST API 或 GraphQL 服务时，频繁查阅 http、fs、crypto、stream 等核心模块文档。
• 前端工程化工程师：配置 Webpack、Vite、Rollup 等构建工具时，需要理解 Node.js 的模块解析机制、路径处理及 process.env 环境变量。
• 全栈 JavaScript 开发者：在 Next.js、Nuxt.js 等全栈框架中编写服务端逻辑，依赖 Node.js API 进行文件操作、数据库连接和认证处理。
• DevOps 工具开发者：使用 Node.js 编写 CLI 工具、自动化脚本和 CI/CD 插件，官方文档的 child_process 和 process 模块是核心参考资料。

六、应用场景

• 构建 CLI 工具：需要编写一个自动生成项目模板的命令行工具，查阅 commander 和 inquirer 的 npm 文档及 Node.js 的 fs/path 模块 API，实现文件模板渲染和交互式问答。
• 后端 API 开发：使用 http 模块搭建轻量级 API 网关，查阅文档中 IncomingMessage 和 ServerResponse 的属性与方法，实现请求转发、响应拦截和日志记录。
• 文件处理服务：构建一个批量图片压缩服务，结合 stream 模块的 pipe 方法和 sharp 库，参考官方 stream 文档中的背压处理和错误传播机制，确保大文件处理不耗尽内存。
• 前端工具链调试：Webpack 构建报错“Cannot find module”，查阅 Node.js 的模块解析算法文档，理解 require.resolve 的查找顺序，定位是 node_modules 缺失还是路径别名配置错误。

七、常见问题（FAQ）

Q：国内能否直接访问 Node.js 官方文档？
A：可以。nodejs.org 在国内网络环境下可正常访问。官方文档英文版位于 nodejs.org/en/docs/，中文社区镜像站 nodejs.cn 也提供完整中文 API 文档，国内访问速度更快。

Q：Node.js LTS 版本和 Current 版本怎么选？
A：官方文档建议：生产环境始终使用 LTS（长期支持）版本，享受 30 个月的安全更新保障；Current 版本包含最新特性但支持周期短，适合探索新功能和开发环境使用。截止目前推荐使用 Node.js 22 LTS。

Q：CommonJS 和 ES Modules 应该用哪个？
A：官方文档推荐新项目优先使用 ES Modules（.mjs 或 package.json 中 type: module），因为 ESM 是 JavaScript 标准，支持静态分析和 tree-shaking。但大量 npm 包仍使用 CommonJS，两者可通过 import 和 require 互操作，文档中提供了详细的互操作规则表。

Q：Node.js 可以处理高并发吗？
A：可以。Node.js 基于事件驱动和非阻塞 I/O 模型，单线程即可处理数万并发连接，非常适合 I/O 密集型应用（如 API 网关、实时聊天、代理服务器）。对于 CPU 密集型任务，官方文档建议使用 Worker Threads 模块将计算分流到独立线程。

八、类似网站

• Node.js 中文网 (nodejs.cn)：Node.js 官方认可的中文文档镜像，API 文档翻译完整，国内访问速度快，是中文开发者的首选参考。
• Deno 官方文档：Node.js 创始人 Ryan Dahl 的新作，原生支持 TypeScript 和 ES Modules，内置安全模型和开发工具链，文档清晰现代。
• Bun 官方文档：新兴的 JavaScript 运行时，性能对标 Node.js 大幅提升，原生支持 TypeScript 和 JSX，文档简洁实用，发展势头迅猛。