Node.js（2）模块与包

我就是我 2023-03-04 06:50 2阅读 0赞

### 一、模块（module）： ###

> 本章主要讲解模块与包，认识模块请看小编上一篇文章[Node.js的基础知识][Node.js]。

##### 1、 引入模块时的路径问题： #####

（1）引入核心模块，不需要考虑路径，直接书写模块名即可。

var http = require('http');		//引入核心模块http，并将其赋值给一个模块对象。

（2）引入模块文件：  
引入本模块同路径下的模块：`var 变量 = require('./模块名');`  
引入本模块同路径下的下一级路径下的模块：`var 变量 = require('./模块名');`  
引入本模块上一级路径下的模块：`var 变量 = require('../模块名');`  
（3)引入第三方模块：  
由于第三方模块都被下载到了本项目的node\_modules文件夹中，所以直接输入模块名即可：`var express = require('express');`

##### 2、REPL交互式解释： #####

（1）在命令提示符中输入node命令，可以直接进入到REPL交互式解释器工具中。  
（2）除了window对象及其DOM操作以外，几乎所有的js操作都可以执行。  
（3）可以在REPL交互式解释器中查看Node下的对象。  
（4）在REPL交互式解释器中直接输入下列命令：  
>moudle <回车>  
上述命令中将显示当前模块的具体属性，问欸是当前是哪个模块？  
在REPL交互式解释器中显示的module模块就是REPL交互式解释器本身。  
（5）按两次ctrl+C可以推出REPL交互式解释器环境。

##### 3、module对象： #####

module对象是Moudle类的实例，表示模块自身。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlYl9vbmx5Xw_size_16_color_FFFFFF_t_70]

<table> 
 <thead> 
  <tr> 
   <th>module.id</th> 
   <th>表示模块的标识符</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>module.express</td> 
   <td>表示模块的导出对象</td> 
  </tr> 
  <tr> 
   <td>module.parent</td> 
   <td>表示当前模块的父模块，当前模块是谁加载的</td> 
  </tr> 
  <tr> 
   <td>module.filename</td> 
   <td>表示模块的绝对路径</td> 
  </tr> 
  <tr> 
   <td>module.loaded</td> 
   <td>表示是否加载完成</td> 
  </tr> 
  <tr> 
   <td>module.children</td> 
   <td>表示当前模块加载了哪些模块</td> 
  </tr> 
  <tr> 
   <td>module.paths</td> 
   <td>表示模块的搜索路径，路径的多少取决于目录的深度</td> 
  </tr> 
 </tbody> 
</table>

##### 4、require对象： #####

*  require.main：表示项目的主模块（入口模块）。  
    在模块中可以调用(require.main == module)\{\}来判断当前是否为主模块。
 *  require.resolve：表示完整的模块名。
    
        //例如：
        console.log(require.resolve('./a'));	//F:\node.js
        console.log(require.resolve('http'));	//http
        console.log(require.resolve('abc'));	//报错，没有找到abc模块
 *  require.cache：显示哪些模块装入了缓存。

##### 5、模块的特点 #####

1.  对于同一个模块的多次调用，不会引起模块内代码额多次执行。
2.  模块在首次加载后将缓存存在内存缓冲区中，即require.cache。
3.  两个模块相互调用，不会导致模块之间的循环执行。

### 二、认识包（Package）： ###

##### 1、 包： #####

包是将模块联系起来的机制（可以认为一个项目就是一个包）。

##### 2、包由两部分组成 #####

1.  **包结构：结构包的一些目录结构**
2.  **包描述文件：package.json**  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlYl9vbmx5Xw_size_16_color_FFFFFF_t_70 1]

Com模拟JS规定的package.json文件中必须的字段

<table> 
 <thead> 
  <tr> 
   <th>序号</th> 
   <th>键名</th> 
   <th>含义</th> 
   <th>键值数据类型</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>name</td> 
   <td>包名</td> 
   <td>字符串</td> 
   <td>只能包含小写字符、数字、.、_和-、不允许出现空格</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>descrip</td> 
   <td>包介绍</td> 
   <td>字符串</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>version</td> 
   <td>包版本号</td> 
   <td>字符串</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>keywords</td> 
   <td>包关键字</td> 
   <td>数组</td> 
   <td>NPM中主要用来做分类搜索</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>maintainers</td> 
   <td>包维护者列表</td> 
   <td>JSON数组</td> 
   <td>每个维护者由name、email和web这3个属性组成</td> 
  </tr> 
  <tr> 
   <td>6</td> 
   <td>contribuctors</td> 
   <td>包贡献者列表</td> 
   <td>JSON数组</td> 
   <td>每个贡献者由name、email、和web这3个属性组成</td> 
  </tr> 
  <tr> 
   <td>7</td> 
   <td>bugs</td> 
   <td>反馈bug的网址/邮箱</td> 
   <td>JSON</td> 
   <td>由url、email两个属性组成</td> 
  </tr> 
  <tr> 
   <td>8</td> 
   <td>licenses</td> 
   <td>包许可证列表</td> 
   <td>JSON数组</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>9</td> 
   <td>repositories</td> 
   <td>托管源代码位置列表</td> 
   <td>JSON</td> 
   <td>由type、url、path三个属性组成</td> 
  </tr> 
  <tr> 
   <td>10</td> 
   <td>dependencies</td> 
   <td>包的依赖关系</td> 
   <td>JSON</td> 
   <td>由包名和版本号组成</td> 
  </tr> 
  <tr> 
   <td>11</td> 
   <td>main</td> 
   <td>包项目的入口文件</td> 
   <td>字符串</td> 
   <td>默认值为项目根目录下的index.js文件</td> 
  </tr> 
 </tbody> 
</table>

CommonJS规定的package.json文件中的其他字段

<table> 
 <thead> 
  <tr> 
   <th>序号</th> 
   <th>键名</th> 
   <th>含义</th> 
   <th>键值数据类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>homepage</td> 
   <td>包项目的首页地址</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>author</td> 
   <td>作者</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>os</td> 
   <td>操作系统</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>CPU</td> 
   <td>处理器</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>engine</td> 
   <td>项目需要的Node版本</td> 
   <td>JSON</td> 
  </tr> 
  <tr> 
   <td>9</td> 
   <td>script</td> 
   <td>npm script脚本</td> 
   <td>JSON</td> 
  </tr> 
  <tr> 
   <td>10</td> 
   <td>devDependencies</td> 
   <td>包的依赖关系</td> 
   <td>JSON</td> 
  </tr> 
 </tbody> 
</table>

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlYl9vbmx5Xw_size_16_color_FFFFFF_t_70 2]

##### 3、包管理工具：npm、yarn #####

1.  npm init：初始化npm工具，并在项目根目录下创建包描述文件。  
    npm init-y：在不提问的情况下直接创建包描述文件。
2.  npm install 包名（简写为：npm i 包名）：  
    哪些包全局安装，哪写包本地（本项目）安装：每一个项目都可能会用到包，或者是工具类型的包，都必须全局安装。  
    全局安装到哪里了？npm root -g 查看全局安装的路径。
3.  npm list查看当前项目的所有的依赖包列表。
4.  npm run 查看当前项目所有的npm Script脚本代码。

<table> 
 <thead> 
  <tr> 
   <th>命令</th> 
   <th>简写</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>npm -v</td> 
   <td>-</td> 
   <td>显示npm包管理工具的版本号</td> 
  </tr> 
  <tr> 
   <td>npm init</td> 
   <td>-</td> 
   <td>初始化npm，在项目中创建package.json文件</td> 
  </tr> 
  <tr> 
   <td>npm init -y</td> 
   <td>-</td> 
   <td>所有选项均采用默认是初始化npm</td> 
  </tr> 
  <tr> 
   <td>npm install 包名</td> 
   <td>npm i 包名</td> 
   <td>安装依赖包</td> 
  </tr> 
  <tr> 
   <td>npm install 包名 --save</td> 
   <td>npm i 包名 -S</td> 
   <td>安装依赖包至生产环境，依赖关系书写在dependencies中</td> 
  </tr> 
  <tr> 
   <td>npm install 包名 --save-dev</td> 
   <td>npm i 包名 -D</td> 
   <td>安装依赖包至开发环境，依赖关系书写在devDependencies中</td> 
  </tr> 
  <tr> 
   <td>npm install 包名 -g</td> 
   <td>npm i 包名 -g</td> 
   <td>全局安装依赖包</td> 
  </tr> 
  <tr> 
   <td>npm install</td> 
   <td>npm i 包名 -i</td> 
   <td>按照package.json中的依赖安装所偶有哦需要用到的包</td> 
  </tr> 
  <tr> 
   <td>npm root -g</td> 
   <td>-</td> 
   <td>查看全局安装依赖包的安装路径</td> 
  </tr> 
  <tr> 
   <td>npm root</td> 
   <td>-</td> 
   <td>查看当前项目中依赖包的安装路径</td> 
  </tr> 
  <tr> 
   <td>npm update 包名</td> 
   <td>-</td> 
   <td>更新依赖包</td> 
  </tr> 
  <tr> 
   <td>npm uninstall 包名</td> 
   <td>-</td> 
   <td>卸载依赖包</td> 
  </tr> 
  <tr> 
   <td>npm uninstall 包名 -g</td> 
   <td>-</td> 
   <td>卸载全局依赖包</td> 
  </tr> 
  <tr> 
   <td>npm list</td> 
   <td>npm ls</td> 
   <td>查看当前项目下安装的依赖包清单</td> 
  </tr> 
  <tr> 
   <td>npm run</td> 
   <td>-</td> 
   <td>查看当前项目中所有的npm Script脚本</td> 
  </tr> 
 </tbody> 
</table>

##### 4、npm节点管理工具：nrm #####

1.  全局安装nrm：npm install nrm -g
2.  nrm ls：显示当前所有的npm接入节点（\*标注的是当前使用的节点）。
3.  nrm test：测试所有的npm接入节点的速度，所花费的毫秒数越少越快。
4.  nrm use 节点名称：切换npm接入节点。
5.  nrm current：显示当前节点。

##### 5、npm Script：npm脚本 #####

在package.json文件中有一个键名：scripts，取值为JSON数据。

script:{ 
    	"脚本名称":"脚本代码"
    }
    //所有的脚本名称,都可以使用npm run + 脚本名称来执行

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlYl9vbmx5Xw_size_16_color_FFFFFF_t_70 3]

##### 6、包管理工具yarn #####

全局安装yarn工具：npm install yarn -g

<table> 
 <thead> 
  <tr> 
   <th>命令</th> 
   <th>含义</th> 
   <th>对应npm命令</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>yarn init</td> 
   <td>初始化项目,在项目根目录生成package.json文件</td> 
   <td>npm init</td> 
  </tr> 
  <tr> 
   <td>yarn --version</td> 
   <td>查看yarn工具的当前版本</td> 
   <td>npm -v</td> 
  </tr> 
  <tr> 
   <td>yarn add 包名</td> 
   <td>在生产环境下安装依赖包</td> 
   <td>npm install 包名 --save</td> 
  </tr> 
  <tr> 
   <td>yarn add 包名 --dev</td> 
   <td>在开发环境下安装依赖包</td> 
   <td>npm install 包名 --save -dev</td> 
  </tr> 
  <tr> 
   <td>yarn global add 包名</td> 
   <td>在本地全局安装依赖包</td> 
   <td>npm inatall 包名 -g</td> 
  </tr> 
  <tr> 
   <td>yarn install</td> 
   <td>根据package.json文件安装左右的依赖包</td> 
   <td>npm install</td> 
  </tr> 
  <tr> 
   <td>yarn upgrade 包名</td> 
   <td>更新依赖包</td> 
   <td>npm update 包名</td> 
  </tr> 
  <tr> 
   <td>yarn remove 包名</td> 
   <td>卸载依赖包</td> 
   <td>npm install 包名</td> 
  </tr> 
  <tr> 
   <td>yarn run</td> 
   <td>执行package.json中的script脚本</td> 
   <td>npm run</td> 
  </tr> 
 </tbody> 
</table>

[Node.js]: https://blog.csdn.net/web_only_/article/details/107593487
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlYl9vbmx5Xw_size_16_color_FFFFFF_t_70]: /images/20230208/0b14de26ec384b2f854ec1b3ffc913e2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlYl9vbmx5Xw_size_16_color_FFFFFF_t_70 1]: /images/20230208/4da553a94afe4b1383102f057d4c5dc3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlYl9vbmx5Xw_size_16_color_FFFFFF_t_70 2]: /images/20230208/2769d7d431fe4639803b66e5c138058b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlYl9vbmx5Xw_size_16_color_FFFFFF_t_70 3]: /images/20230208/32b688c16e454a949b383f69b5d0025d.png