模块化&包与npm

模块化&包与npm

引用

CSDN

1.

https://blog.csdn.net/m0_48884170/article/details/138072539

目录

1. 模块化的基本概念
   1.1 什么是模块化
   1.2 模块化规范
2. Node.js 中的模块化
   2.1 规范
   1：模块分类
   2：加载模块
   3：模块成员
   4：模块作用域
   5：模块对象
   6：向外共享模块成员
   7：Node.js 中的模块化规范
3. npm与包
   3.1 包
4. 什么是包
5. 包的来源
6. 为什么需要包
7. 从哪里下载包
8. 如何下载包
   3.2 npm 初体验
9. 格式化时间的传统做法（自己定义模块）
10. 格式化时间的高级做法（使用第三方的包）
    3.3 npm 安装下载包
    3.4 npm 安装指定版本的包
    3.5 npm 卸载包
    3.6 解决包下载慢的问题
    3.7 包的分类
11. 项目包
12. 全局包
    3.8 包管理配置文件
13. npm 规定
14. 为什么需要包管理配置文件？
15. 快速创建 package.json
16. 一次性安装所有的包
17. dependencies 节点
18. devDependencies 节点

1. 模块化的基本概念

1.1 什么是模块化

模块化是指解决一个复杂问题时，自顶向下逐层把系统划分成若干模块的过程。对于整个系统来说
，模块是可组合、分解和更换的单元。

模块化就是一种拆分、组合、复用的思想。

Node.js已经实现了模块化。

编程领域中的模块化：

编程领域中的模块化，就是遵守固定的规则，把一个大文件拆成独立并互相依赖的多个小模块。

把代码进行模块化拆分的好处：

• 提高了代码的复用性
• 提高了代码的可维护性
• 可以实现按需加载

1.2 模块化规范

模块化规范就是对代码进行模块化的拆分与组合时，需要遵守的那些规则。

例如：

• 使用什么样的语法格式来引用模块
• 在模块中使用什么样的语法格式向外暴露成员

模块化规范的好处：大家都遵守同样的模块化规范写代码，降低了沟通的成本，极大方便了各个模块之 间的相互调用。

2. Node.js 中的模块化

2.1规范

1：模块分类

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

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

2：加载模块

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

注意：使用 require() 方法加载其它模块时，会执行被加载模块中的代码。并且.js后缀可以省略。

3：模块成员

在当前模块中声明的变量、常量、函数，统称为“模块成员”

4：模块作用域

1. 什么是模块作用域

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

5：模块对象

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

6：向外共享模块成员

在自定义模块中，可以使用 module.exports 对象，将模块内的成员共享出去，供外界使用。

外界用require() 方法导入自定义模块时，得到的就是 module.exports 所指向的对象。

共享成员时的注意点：

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

7：Node.js 中的模块化规范

Node.js 遵循了 CommonJS 模块化规范，CommonJS 规定了模块的特性和各模块之间如何相互依赖。

CommonJS 规定：

• 每个模块内部，module 变量代表当前模块。
• module 变量是一个对象，它的 exports 属性（即module.exports）是对外的接口。
• 加载某个模块，其实是加载该模块的 module.exports 属性。require() 方法用于加载模块。

3. npm与包

3.1 包

1. 什么是包

Node.js 中的第三方模块又叫做包。

就像电脑和计算机指的是相同的东西，第三方模块和包指的是同一个概念，只不过叫法不同。

2. 包的来源

不同于 Node.js 中的内置模块与自定义模块，包是由第三方个人或团队开发出来的，免费供所有人使用。

注意：Node.js 中的包都是免费且开源的，不需要付费即可免费下载使用。

3.为什么需要包

由于 Node.js 的内置模块仅提供了一些底层的 API，导致在基于内置模块进行项目开发的时，效率很低。

包是基于内置模块封装出来的，提供了更高级、更方便的 API，极大的提高了开发效率。

4. 从哪里下载包

国外有一家 IT 公司，叫做npm, Inc.这家公司旗下有一个非常著名的网站：https://www.npmjs.com/，它是**全球最****大的包共享平台**，可以从这个网站上搜索到任何需要的包

5. 如何下载包

npm, Inc. 公司提供了一个包管理工具Node Package Manager（简称npm包管理工具），我们可以 使用这个包管理工具，从https://registry.npmjs.org/服务器把需要 的包下载到本地使用。

这个包管理工具随着 Node.js 的安 装包一起被安装到了用户的电脑上，在终端中执行npm -v命令，来查看版本号：

3.2 npm 初体验

1. 格式化时间的传统做法（自己定义模块）

1. 创建格式化时间的自定义模块
2. 定义格式化时间的方法
3. 创建补零函数
4. 从自定义模块中导出格式化时间的函数
5. 导入格式化时间的自定义模块
6. 调用格式化时间的函数

2. 格式化时间的高级做法（使用第三方的包）

1. 使用 npm 包管理工具，在项目中安装格式化时间的包 moment
2. 使用 require() 导入格式化时间的包
3. 参考 moment 的官方 API 文档对时间进行格式化

3.3 npm安装下载包

如果想在项目中安装指定名称的包，需要运行如下的命令：

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

一次性安装多个包：npm install包1包2包3

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

其中：

node_modules文件夹用来存放所有已安装到项目中的包。require()导入第三方包时，就是从这个目录中查找并加载的包。

package-lock.json配置文件用来记录node_modules目录下的每一个包的下载信息，例如包的名字、版本号、下载地址等。

package.json配置文件用来记录当前项目的一些配置信息，例如：项目的名称、版本号、用到的包等等。

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

3.4 npm安装指定版本的包

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

3.5 npm卸载包

3.6 解决包下载慢的问题

切换下包镜像源：下包的镜像源，指的就是下包的服务器地址

【1】通过命令，手动切换

【2】通过管理工具nrm切换

nrm ls没有星号

3.7 包的分类

使用 npm 包管理工具下载的包，共分为两大类，分别是：

• 项目包
• 全局包

1. 项目包

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

项目包又分为两类，分别是：

• 开发依赖包（被记录到devDependencies节点中的包，只在开发期间会用到）
• 核心依赖包（被记录到dependencies节点中的包，在开发期间和项目上线之后都会用到）

2. 全局包

在执行 npm install 命令时，如果提供了-g参数，则会把包安装为全局包。

全局包会被安装到C:\Users\用户目录\AppData\Roaming\npm\node_modules目录下。

注意：

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

3.8 包管理配置文件

1. npm 规定

npm 规定，在项目根目录中，必须提供一个叫做package.json的包管理配置文件。用来记录与项目有关的一些配置 信息。例如：

• 项目的名称、版本号、描述等
• 项目中都用到了哪些包
• 哪些包只在开发期间会用到
• 那些包在开发和部署时都需要用到

2. 为什么需要包管理配置文件？

整个项目的体积是 30.4M ，第三方包的体积是28.8M ，项目源代码的体积1.6M

遇到的问题：第三方包的体积过大，不 方便团队成员之间共享项目源代码。

解决方案：共享时剔除node_modules

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

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

3. 快速创建 package.json

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

注意：

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

4.一次性安装所有的包

当拿到一个剔除了 node_modules的项目之后，需要先把所有的包下载到项目中，才能将项目运行起来。否则会报类似于下面的错误：

可以运行npm install命令（或npm i）一次性安装所有的依赖包：

5.dependencies节点

package.json 文件中，有一个dependencies节点，专门用来记录当前项目中的核心依赖包。

6.devDependencies节点

某些包只在项目开发阶段会用到，在项目上线之后不会用到。

package.json文件中，有一个devDependencies节点，专门用来记录当前项目中的开发依赖包。