node.js模块化和npm学习笔记

wangzdq

已于 2025-02-06 09:52:23 修改

阅读量525

点赞数 16

CC 4.0 BY-SA版权

文章标签： node.js 学习笔记

于 2025-02-05 17:25:01 首次发布

本文链接：https://blog.csdn.net/wangzdq/article/details/145458640

一、Node.js 中根据模块来源的不同，将模块分为了 3 大类，分别是：

l 内置模块（内置模块是由 Node.js 官方提供的，例如 fs、path、http 等）
l 自定义模块（用户创建的每个 .js 文件，都是自定义模块）
l 第三方模块（由第三方开发出来的模块，并非官方提供的内置模块，也不是用户创建的自定义模块，使用前需要先下载）

二、加载模块

使用强大的require()方法，可以加载需要的内置模块、用户自定义模块、第三方模块进行使用。例如：

 // 1.加载内置的 fs 模块!
 const fs = require('fs')

 // 2.加载用户的自定义模块
 const custom = require('./custom.js')

 //3.加载第三方模块
 const moment = require('moment')

注意：使用 require() 方法加载其它模块时，会执行被加载模块中的代码。

三、Node.js 中的模块作用域

什么是模块作用域

和函数作用域类似，在自定义模块中定义的变量、方法等成员，只能在当前模块内被访问，这种模块级别的访问限制，叫做模块作用域。

向外共享模块作用域中的成员

1、module 对象

在每个 .js 自定义模块中都有一个 module 对象，它里面存储了和当前模块有关的信息，打印如下：

{
  id: 'E:\\test.js',
  path: 'E:',
  exports: {},
  filename: 'E:\\test.js',
  loaded: false,
  children: [],
  paths: [
    'E:\\node_modules'
  ]
}

2、module.exports 对象

在自定义模块中，可以使用 module.exports 对象，将模块内的成员共享出去，供外界使用。
外界用 require() 方法导入自定义模块时，得到的就是 module.exports 所指向的对象。

3、exports 对象

由于 module.exports 单词写起来比较复杂，为了简化向外共享成员的代码，Node 提供了 exports 对象。默认情况下，exports 和 module.exports 指向同一个对象。最终共享的结果，还是以 module.exports 指向的对象为准。

共享成员时的注意点

使用 require() 方法导入模块时，导入的结果，永远以 module.exports 指向的对象为准。

四、npm与包

从哪里下载包

国外有一家 IT 公司，叫做 npm, Inc. 这家公司旗下有一个非常著名的网站： https://www.npmjs.com/ ，它是全球最大的包共享平台，你可以从这个网站上搜索到任何你需要的包，只要你有足够的耐心！
到目前位置，全球约 1100 多万的开发人员，通过这个包共享平台，开发并共享了超过 120 多万个包供我们使用。
npm, Inc. 公司提供了一个地址为 https://registry.npmjs.org/ 的服务器，来对外共享所有的包，我们可以从这个服务器上下载自己所需要的包。

注意：
从 https://www.npmjs.com/ 网站上搜索自己所需要的包
从 https://registry.npmjs.org/ 服务器上下载自己需要的包

在项目中安装包的命令

npm install 包的完整名称

上述的装包命令，可以简写成如下格式：

npm i 完整的包名称

初次装包后多了哪些文件

初次装包完成后，在项目文件夹下多一个叫做 node_modules 的文件夹和 package-lock.json 的配置文件。

其中：

node_modules 文件夹用来存放所有已安装到项目中的包。require() 导入第三方包时，就是从这个目录中查找并加载包。
package-lock.json 配置文件用来记录 node_modules 目录下的每一个包的下载信息，例如包的名字、版本号、下载地址等。

注意：程序员不要手动修改 node_modules 或 package-lock.json 文件中的任何代码，npm 包管理工具会自动维护它们。

安装指定版本的包

默认情况下，使用 npm install 命令安装包的时候，会自动安装最新版本的包。如果需要安装指定版本的包，可以在包名之后，通过 @ 符号指定具体的版本，例如：

npm i moment@2.22.2

包的语义化版本规范

包的版本号是以“点分十进制”形式进行定义的，总共有三位数字，例如 2.24.0
其中每一位数字所代表的的含义如下：
第1位数字：大版本
第2位数字：功能版本
第3位数字：Bug修复版本

版本号提升的规则：只要前面的版本号增长了，则后面的版本号归零。

包管理配置文件

npm 规定，在项目根目录中，必须提供一个叫做 package.json 的包管理配置文件。用来记录与项目有关的一些配置信息。例如：
项目的名称、版本号、描述等
项目中都用到了哪些包
哪些包只在开发期间会用到
那些包在开发和部署时都需要用到

如何记录项目中安装了哪些包

在项目根目录中，创建一个叫做 package.json 的配置文件，即可用来记录项目中安装了哪些包。从而方便剔除 node_modules 目录之后，在团队成员之间共享项目的源代码。

注意：今后在项目开发中，一定要把 node_modules 文件夹，添加到 .gitignore 忽略文件中。

快速创建 package.json

npm 包管理工具提供了一个快捷命令，可以在执行命令时所处的目录中，快速创建 package.json 这个包管理配置文件：

//作用:在执行命令所处的目录中，快速新建 package.json 文件
npm init -y

注意：
上述命令只能在英文的目录下成功运行！所以，项目文件夹的名称一定要使用英文命名，不要使用中文，不能出现空格。
运行 npm install 命令安装包的时候，npm 包管理工具会自动把包的名称和版本号，记录到 package.json 中。

dependencies 节点

package.json 文件中，有一个 dependencies 节点，专门用来记录您使用 npm install 命令安装了哪些包。

{
  "dependencies ": {
    "electron": "^34.0.2",
    "moment": "^2.30.1"
  }
}

一次性安装所有的包

当我们拿到一个剔除了 node_modules 的项目之后，需要先把所有的包下载到项目中，才能将项目运行起来。
可以运行 npm install 命令（或 npm i）一次性安装所有的依赖包：
npm命令会取查找package.json中的 dependencies进行安装

卸载包

可以运行 npm uninstall 命令，来卸载指定的包：
注意：npm uninstall 命令执行成功后，会把卸载的包，自动从 package.json 的 dependencies 中移除掉。

devDependencies 节点

如果某些包只在项目开发阶段会用到，在项目上线之后不会用到，则建议把这些包记录到 devDependencies 节点中。
与之对应的，如果某些包在开发和项目上线之后都需要用到，则建议把这些包记录到 dependencies 节点中。

您可以使用如下的命令，将包记录到 devDependencies 节点中：

npm i 包名 -D 
//安装指定的包，并记录到 devDependencies 节点中
//注意:上述命令是简写形式，等价于下面完整的写法:npm install包名--save-dev

解决下包速度慢的问题

方法一、切换 npm 的下包镜像源

 #查看当前的下包镜像源
 npm config get registry
 #将下包的镜像源切换为淘宝镜像源
 npm config set registry=https://registry.npm.taobao.org
#检查镜像源是否下载成功
 npm config get registry

方法二、nrm

为了更方便的切换下包的镜像源，我们可以安装 nrm 这个小工具，利用 nrm 提供的终端命令，可以快速查看和切换下包的镜像源。

#通过 npm 包管理器，将 nrm 安装为全局可用的工具
npm i nrm -g
#看所有可用的镜像源
nrm ls
#将下包的镜像源切换为 taobao 镜像
nrm use taobao

五、包的分类

项目包

那些被安装到项目的 node_modules 目录中的包，都是项目包。

项目包又分为两类，分别是：
开发依赖包（被记录到 devDependencies 节点中的包，只在开发期间会用到）
核心依赖包（被记录到 dependencies 节点中的包，在开发期间和项目上线之后都会用到）

全局包

在执行 npm install 命令时，如果提供了 -g 参数，则会把包安装为全局包。
全局包会被安装到 C:\Users\用户目录\AppData\Roaming\npm\node_modules 目录下。

npm i 包名 -g
#全局安装指定的包,
npm uninstall 包名-g# 卸载全局安装的包，

注意：
只有工具性质的包，才有全局安装的必要性。因为它们提供了好用的终端命令。
判断某个包是否需要全局安装后才能使用，可以参考官方提供的使用说明即可。