nodejs使用模块

Node.js 模块系统：创建、加载与依赖管理

Node.js 的模块系统是其核心特性之一，通过exports和require实现代码的模块化拆分与复用，配合package.json可高效管理项目依赖。本文详细讲解模块的创建、加载逻辑及依赖配置，帮助理解 Node.js 的模块化开发模式。

模块的基本概念

在 Node.js 中，一个文件就是一个模块，每个模块拥有独立的作用域（变量、函数仅在模块内可见），通过exports暴露接口，通过require引入其他模块。这种设计避免了全局变量污染，同时实现了代码的解耦与复用。

创建与加载模块：`exports`与`require`的使用

1. 导出模块：`exports`与`module.exports`

模块通过exports对象暴露可供外部调用的属性或方法，也可通过module.exports导出完整对象（二者指向同一内存地址）。

示例：创建greet.js模块

// 方式1：通过exports暴露单个方法
exports.sayHello = function(name) {
  console.log(`Hello, ${name}!`);
};

// 方式2：通过module.exports暴露多个方法（更灵活）
module.exports = {
  sayHi: function(name) {
    console.log(`Hi, ${name}!`);
  },
  sayBye: function(name) {
    console.log(`Bye, ${name}!`);
  }
};

注意：若直接给exports赋值（如exports = { ... }），会断开与module.exports的关联，导致导出失效，建议优先使用module.exports。

2. 加载模块：`require`的路径规则

使用require(模块路径)加载其他模块，路径解析规则如下：

相对路径：加载本地模块时，需以./（当前目录）或../（上级目录）开头。

1
2
3

// 加载同目录下的greet.js模块
const greet = require('./greet');
greet.sayHi('老张'); // 输出：Hi, 老张!

模块名：加载内置模块（如fs、path）或node_modules中的第三方模块时，直接写模块名。

// 加载内置模块fs
const fs = require('fs');
// 加载第三方模块axios（需先通过npm安装）
const axios = require('axios');

绝对路径：从根目录开始的完整路径（较少使用，不利于移植）。

3. 模块加载的执行机制

模块被require时会立即执行一次，后续再次加载会直接使用缓存（避免重复执行）；
若模块未显式导出（无exports或module.exports），默认导出{}空对象。

项目依赖管理：`package.json`的作用

当项目依赖多个第三方模块时，手动逐个安装效率低下。package.json作为项目的 “配置清单”，可集中管理依赖模块、版本信息及项目脚本，通过npm install一键安装所有依赖。

1. `package.json`的核心字段

以下是一个典型的package.json示例，包含关键字段说明：

{
  "name": "my-project",       // 项目名称（小写，无空格）
  "version": "1.0.0",         // 版本号（遵循语义化版本：主版本.次版本.补丁）
  "private": true,            // 设为true时，防止项目被意外发布到npm仓库
  "scripts": {                // 自定义脚本（通过npm run <脚本名>执行）
    "start": "node server.js",  // 启动服务：npm start
    "build": "webpack"          // 打包：npm run build
  },
  "dependencies": {           // 生产环境依赖（项目运行必需）
    "axios": "^0.19.0",        // HTTP请求库
    "vue": "^2.6.10"           // 前端框架
  },
  "devDependencies": {        // 开发环境依赖（仅开发时使用）
    "eslint": "^8.0.0",        // 代码检查工具
    "webpack": "^5.0.0"        // 打包工具
  }
}

2. 依赖安装与版本控制

安装依赖并写入package.json：

# 安装生产依赖（写入dependencies）
npm install axios --save  # 简写：-S
# 安装开发依赖（写入devDependencies）
npm install eslint --save-dev  # 简写：-D

版本号规则：版本号前的符号代表更新范围（如^0.19.0允许更新次版本和补丁，~0.19.0仅允许更新补丁），确保依赖兼容性。
一键安装所有依赖：
当项目迁移或团队协作时，只需复制package.json和package-lock.json，执行以下命令即可安装所有依赖：
1
npm install

模块的分类

Node.js 的模块可分为三类，加载规则略有差异：

内置模块：Node.js 自带的核心模块（如fs、path、http），加载时无需指定路径，优先级最高。
1
const http = require('http'); // 启动HTTP服务

第三方模块：通过 npm 安装的开源模块（如axios、lodash），默认存放在项目根目录的node_modules文件夹中，加载时直接写模块名。
自定义模块：开发者自己编写的模块，加载时需指定相对路径或绝对路径。

模块化开发的最佳实践

单一职责原则：一个模块只负责一个功能（如greet.js仅处理问候逻辑），避免过大的模块体积；
合理拆分模块：将工具函数、配置信息、业务逻辑拆分为不同模块，提高可维护性；
避免循环依赖：若模块 A 依赖模块 B，模块 B 又依赖模块 A，会导致部分导出内容无法正常加载，需通过重构避免；
使用package-lock.json：锁定依赖版本，确保团队成员或部署环境使用完全一致的依赖。

Node.js 模块系统：创建、加载与依赖管理

模块的基本概念

创建与加载模块：exports与require的使用

1. 导出模块：exports与module.exports

2. 加载模块：require的路径规则