模块化

1.模块化基本概念

1.1 什么是模块化

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

1. 现实生活中的模块化

2. 编程领域中的模块化

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

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

① 提高了代码的复用性

② 提高了代码的可维护性

③ 可以实现按需加载

1.2 模块化规范

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

例如：

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

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

2. Node.js 中的模块化

2.1 Node.js 中模块的分类

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

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

2.2 加载模块

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

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

2.3 Node.js 中的模块作用域

1. 什么是模块作用域

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

2. 模块作用域的好处

防止了全局变量污染的问题

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

1. module 对象

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

2. module.exports 对象

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

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

3. 共享成员时的注意点

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

4. exports 对象

由于 module.exports 单词写起来比较复杂，为了简化向外共享成员的代码，Node 提供了 exports 对象。

默认情况下，exports 和 module.exports 指向同一个对象。最终共享的结果，还是

5. exports 和 module.exports 的使用误区

时刻谨记，require() 模块时，得到的永远是 module.exports 指向的对象：

注意：为了防止混乱，建议不要在同一个模块中同时使用 exports 和 module.exports

2.5 Node.js 中的模块化规范

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

① 每个模块内部，module 变量代表当前模块。

② module 变量是一个对象，它的 exports 属性（即 module.exports）是对外的接口。

③ 加载某个模块，其实是加载该模块的 module.exports 属性。require() 方法用于加载模块。

3. npm、cnpm、pnpm、npx、yarn

1.npm、cnpm

NPM 的全称是 Node Package Manager，是随同 NodeJS 一起安装的包管理和分发工具，它可以很方便的让前端开发者下载、安装、上传以及管理已经安装的包。
cnpm是一个完整 npmjs.org 镜像，下载cnpm：npm i cnpm -g

以下所有命令npm和cnpm都适用

1.查看版本

npm -v

2.设置npm淘宝镜像

# 设置全局的npm淘宝镜像
npm config set registry https://registry.npmmirror.com
# 也可以切换回默认全局镜像
npm config set registry https://registry.npmjs.org

3.npm 常用命令简写说明

-g： 为 --global 的缩写，表示安装到全局目录里
-S： 为 --save 的缩写，表示安装的包将写入package.json里面的dependencies
-D： 为 --save-dev 的缩写，表示将安装的包将写入packege.json里面的devDependencies
 i： 为install的缩写，表示安装

4.安装模块

npm init  # npm 初始化当前目录
npm i  # 安装package.json中记录的所有依赖
npm i xxx  # 安装模块到默认dependencies
npm i xxx -g  # 会安装到配置的全局目录下
npm i xxx -S  # 安装包信息将加入到dependencies生产依赖
npm i xxx -D  # 安装包信息将加入到devDependencies开发依赖
npm i xxx@1.8.3  # 安装xxx指定的1.8.3版本

5.卸载模块

npm uninstall xxx  # 卸载模块，但不卸载模块留在package.json中的对应信息
npm uninstall xxx -g  # 卸载全局模块
npm uninstall xxx --save  # 卸载模块，同时卸载留在package.json中dependencies下的信息
npm uninstall xxx --save-dev  # 卸载模块，同时卸载留在package.json中devDependencies下的信息

6.更新模块

npm update xxx  # 更新最新版本的xxx
npm update xxx@2.1.0  # 更新到指定版本号的xxx
npm install xxx@latest  # 可以直接更新到最新版本

7.查看命令

npm root  # 查看项目中模块所在的目录
npm root -g  # 查看全局安装的模块所在目录
npm list 或者 npm ls  # 查看本地已安装模块的清单列表
npm view xxx dependencies  # 查看某个包对于各种包的依赖关系
npm view xxx version  # 查看xxx最新的版本号
npm view xxx versions  # 查看所有xxx历史版本号（很实用）
npm view xxx  # 查看最新的xxx版本的信息
npm info xxx  # 查看xxx的详细信息，等同于上面的npm view xxx
npm list xxx 或 npm ls xxx  # 查看本地已安装的xxx的详细信息
npm view xxx repository.url  # 查看xxx包的来源地址

8.其他命令

npm cache clean --force  # 清除npm的缓存
npm prune  # 清除项目中没有被使用的包
npm outdated  # 检查模块是否已经过时
npm repo jquery  # 会打开默认浏览器跳转到github中jquery的页面
npm docs jquery  # 会打开默认浏览器跳转到github中jquery的README.MD文件信息
npm home jquery  # 会打开默认浏览器跳转到github中jquery的主页

2.pnpm

pnpm 创建从全局存储到项目下 node_modules 文件夹的硬链接。硬链接指向磁盘上原始文件所在的同一位置。

1.下载pnpm

npm i pnpm -g

2.常用指令

命令	解释
pnpm -v	查看已安装的pnpm的版本
pnpm install xxx/pnpm i xxx	安装依赖
pnpm run xxx	运行package.json中scripts脚本
pnpm config get registry	查看源
pnpm config set registry https://registry.npmmirror.com	切换源
pnpm add xxx	安装依赖包到 dependencies
pnpm add -D xxx	安装依赖包到devDependencies
pnpm update xxx/pnpm up xxx	更新依赖包
pnpm remove xxx	删除依赖包

3.npx

有很多命令，我们只需要执行一次的，但是却要全局安装。使用npx，可以在不全局安装依赖包的情况下，运行命令，而且运行后不会污染全局环境。
npx 会在当前目录下的./node_modules/.bin里去查找是否有可执行的命令，没有找到的话再从全局里查找是否有安装对应的模块，全局也没有的话就会自动下载对应的模块
npm自带npx，可以直接使用，如果没有可以手动安装一下：npm i -g npx

npx命令参数

--no-install

--no-install 告诉npx不要自动下载，也就意味着如果本地没有该模块则无法执行后续的命令。

npx --no-install create-react-app my-react-app
// not found: create-react-app

--ignore-existing

--ignore-existing 告诉npx忽略本地已经存在的模块，每次都去执行下载操作，也就是每次都会下载安装临时模块并在用完后删除。

-p

-p 用于指定npx所要安装的模块，它可以指定某一个版本进行安装：

npx -p node@12.0.0 node index.js

-p 还可以用于同时安装多个模块：

npx -p lolcatjs -p cowsay [command]

-c

-c 告诉npx所有命令都用npx解释。

npx -p lolcatjs -p cowsay 'cowsay hello | lolcatjs'

这样运行会报错，因为第一项命令cowsay hello默认有npx解释，但第二项命令localcatjs会有shell解释，此时lolcatjs并没有全局安装，所有就报错了。这时候可以用-c参数来解决。

npx -p lolcatjs -p cowsay -c 'cowsay hello | lolcatjs'

4.yarn

1.安装yarn

npm i -g yarn

2.查看版本

yarn -v

3.设置淘宝镜像

#设置淘宝镜像
yarn config set registry https://registry.npmmirror.com

#设置原本镜像
yarn config set registry http://registry.npmjs.org/

4.初始化

yarn init

5.安装依赖包

yarn add xxx # 会自动安装最新版本，会覆盖指定版本号
yarn add xxx1 xxx2 xxx3 # 一次性添加多个包
yarn add xxx@版本号 # 添加指定版本的包
yarn add xxx@[tag] # 安装某个tag（比如beta,next或者latest）

# 加到 devDependencies
yarn add xxx --dev
#或
yarn add xxx -D

6.更新依赖包

yarn upgrade xxx # 升级到最新版本
yarn upgrade xxx@[version] # 升级到指定版本
yarn upgrade xxx@[tag] # 升级到指定tag

7.移除依赖包

yarn remove xxx # 移除包

8.缓存

shell

yarn cache
yarn cache list # 列出已缓存的每个包
yarn cache dir # 返回全局缓存位置
yarn cache clean # 清除缓存

4.package包

4.1 包

1. 什么是包

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

2. 包的来源

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

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

3. 为什么需要包

由于 Node.js 的内置模块仅提供了一些底层的 API，导致在基于内置模块进行项目开发的时，效率很低。包是基于内置模块封装出来的，提供了更高级、更方便的 API，极大的提高了开发效率。包和内置模块之间的关系，类似于 jQuery 和浏览器内置 API 之间的关系。

4. 从哪里下载包

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

到目前位置，全球约 1100 多万的开发人员，通过这个包共享平台，开发并共享了超过 120 多万个包供我们使用。

npm, Inc. 公司提供了一个地址为 https://registry.npmjs.org/ 的服务器，来对外共享所有的包，我们可以从这个服务器上下载自己所需要的包。

注意：

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

5. 如何下载包

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

这个包管理工具的名字叫做 Node Package Manager（简称 npm 包管理工具），这个包管理工具随着 Node.js 的安装包一起被安装到了用户的电脑上。

大家可以在终端中执行 npm -v 命令，来查看自己电脑上所安装的 npm 包管理工具的版本号：

4. 初次装包后多了哪些文件

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

其中：

node_modules 文件夹用来存放所有已安装到项目中的包。require() 导入第三方包时，就是从这个目录中查找并加载包。
package-lock.json 配置文件用来记录 node_modules 目录下的每一个包的下载信息，例如包的名字、版本号、下载地址等。
注意：程序员不要手动修改 node_modules 或 package-lock.json 文件中的任何代码，npm 包管理工具会自动维护它们。

6. 包的语义化版本规范

包的版本号是以“点分十进制”形式进行定义的，总共有三位数字，例如 2.24.0

其中每一位数字所代表的的含义如下：

第1位数字：大版本
第2位数字：功能版本
第3位数字：Bug修复版本

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

4.2 package.json

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

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

1.package.json基本配置说明

一下是一个项目中package.json的基本配置，详细配置及说明可在package.json 配置完全解读 - 掘金 (juejin.cn)查询

name：项目的名称
version：项目的版本号
private：如果是私有项目，不希望发布到公共 npm 仓库上，可以将 private 设为 true。
scripts：指定项目的一些内置脚本命令，这些命令可以通过 npm run xxx来执行
dependencies：记录在开发期间和项目上线之后都会用到的包
devDependencies：记录只会在项目开发期间使用到的依赖包

json

{
    "name": "pet",		
    "version": "0.1.0",
    "private": true,
    "scripts": {
        "start": "vue-cli-service serve",
    },
    "dependencies": {
        "包名": "版本号",
        "axios": "0.24.0",
    },
    "devDependencies": {
        "包名": "版本号",
        "eslint": "^7.32.0",
    }
}

2. 多人协作的问题

当我们多人协作开发一个项目时，第三方包的体积过大，不方便团队成员之间共享项目源代码。因为项目中所有包都存放于node_modules里，这使得整个项目的体积非常大

**解决方案：**当我们上传git或者打包发送时，把node_modules删除再打包发送，这样项目体积就会变得非常轻便

3. 快速创建 package.json

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

shell

npm init -y

注意：

① 上述命令**！所以，**，不要使用中文，不能出现空格。

② 运行 npm install 命令安装包的时候，npm 包管理工具会自动把包的名称和版本号，记录到 package.json 中

4. nrm

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

bash

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

4.3 包的分类

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

项目包
全局包

1. 项目包

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

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

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

bash

npm i 包名-D  //开发依赖包(会被记录到devDependencies节点下)
npm i 包名    //核心依赖包（会被记录到dependencies节点下)

2. 全局包

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

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

bash

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

注意：

① 只有工具性质的包，才有全局安装的必要性。因为它们提供了好用的终端命令。

② 判断某个包是否需要全局安装后才能使用，可以参考官方提供的使用说明即可。

3. i5ting_toc

i5ting_toc 是一个可以把 md 文档转为 html 页面的小工具，使用步骤如下

bash

#将i5ting toc安装为全局包
npm install -g i5ting_toc
#调用i5ting toc，轻松实现md转html 的功能
i5ting toc_-f 要转换的md文件路径-o

4.4规范的包结构

在清楚了包的概念、以及如何下载和使用包之后，接下来，我们深入了解一下包的内部结构。

一个规范的包，它的组成结构，必须符合以下 3 点要求

包必须以单独的目录而存在
包的顶级目录下要必须包含 package.json 这个包管理配置文件
package.json 中必须包含 name，version，main 这三个属性，分别代表包的名字、版本号、包的入口。

注意：以上 3 点要求是一个规范的包结构必须遵守的格式，关于更多的约束，可以参考如下网址：

https://yarnpkg.com/zh-Hans/docs/package-json

4. 模块的加载机制

4.1 优先从缓存中加载

模块在第一次加载后会被缓存。这也意味着多次调用 require() 不会导致模块的代码被执行多次。

注意：不论是内置模块、用户自定义模块、还是第三方模块，它们都会优先从缓存中加载，从而提高模块的加载效率

4.2 内置模块的加载机制

内置模块是由 Node.js 官方提供的模块，内置模块的加载优先级最高。

例如，require('fs') 始终返回内置的 fs 模块，即使在 node_modules 目录下有名字相同的包也叫做 fs

4.3 自定义模块的加载机制

使用 require() 加载自定义模块时，必须指定以 ./ 或 ../ 开头的路径标识符。在加载自定义模块时
如果没有指定 ./ 或 ../ 这样的路径标识符，则 node 会把它当作内置模块或第三方模块进行加载。
同时，在使用 require() 导入自定义模块时，如果省略了文件的扩展名，则 Node.js 会按顺序分别尝试加载以下的文件：
按照确切的文件名进行加载
补全 .js 扩展名进行加载
补全 .json 扩展名进行加载
补全 .node 扩展名进行加载
加载失败，终端报错

4.4 第三方模块的加载机制

如果传递给 require() 的模块标识符不是一个内置模块，也没有以 ‘./’ 或 ‘../’ 开头，则 Node.js 会从当前模块的父目录开始，尝试从 /node_modules 文件夹中加载第三方模块。

如果没有找到对应的第三方模块，则移动到再上一层父目录中，进行加载，直到文件系统的根目录。

例如，假设在 'C:\Users\itheima\project\foo.js' 文件里调用了 require('tools')，则 Node.js 会按以下顺序查找：

① C:\Users\itheima\project\node_modules\tools

② C:\Users\itheima\node_modules\tools

③ C:\Users\node_modules\tools

④ C:\node_modules\tools

4.5 目录作为模块

当把目录作为模块标识符，传递给 require() 进行加载的时候，有三种加载方式：

① 在被加载的目录下查找一个叫做 package.json 的文件，并寻找 main 属性，作为 require() 加载的入口

② 如果目录里没有 package.json 文件，或者 main 入口不存在或无法解析，则 Node.js 将会试图加载目录下的 index.js 文件。

③ 如果以上两步都失败了，则 Node.js 会在终端打印错误消息，报告模块的缺失：Error: Cannot find module 'xxx

模块化 ​

1.模块化基本概念 ​

1.1 什么是模块化 ​

1. 现实生活中的模块化 ​

2. 编程领域中的模块化 ​

1.2 模块化规范 ​

2. Node.js 中的模块化 ​

2.1 Node.js 中模块的分类 ​

2.2 加载模块 ​

2.3 Node.js 中的模块作用域 ​

1. 什么是模块作用域 ​

2. 模块作用域的好处 ​

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

1. module 对象 ​

2. module.exports 对象 ​

3. 共享成员时的注意点 ​

4. exports 对象 ​

5. exports 和 module.exports 的使用误区 ​

2.5 Node.js 中的模块化规范 ​

3. npm、cnpm、pnpm、npx、yarn ​

1.npm、cnpm ​

1.查看版本 ​

2.设置npm淘宝镜像 ​

3.npm 常用命令简写说明 ​

4.安装模块 ​

5.卸载模块 ​

6.更新模块 ​

7.查看命令 ​

8.其他命令 ​

2.pnpm ​

1.下载pnpm ​

2.常用指令 ​

3.npx ​

npx命令参数 ​

--no-install ​

--ignore-existing ​

-p ​

-c ​

4.yarn ​

1.安装yarn ​

2.查看版本 ​

3.设置淘宝镜像 ​

4.初始化 ​

5.安装依赖包 ​

6.更新依赖包 ​

7.移除依赖包 ​

8.缓存 ​

4.package包 ​

4.1 包 ​

1. 什么是包 ​

2. 包的来源 ​

3. 为什么需要包 ​

4. 从哪里下载包 ​

5. 如何下载包 ​

4. 初次装包后多了哪些文件 ​

6. 包的语义化版本规范 ​

4.2 package.json ​

1.package.json基本配置说明 ​

2. 多人协作的问题 ​

3. 快速创建 package.json ​

4. nrm ​

4.3 包的分类 ​

1. 项目包 ​

2. 全局包 ​

3. i5ting_toc ​

4.4规范的包结构 ​

4. 模块的加载机制 ​

4.1 优先从缓存中加载 ​

4.2 内置模块的加载机制 ​

4.3 自定义模块的加载机制 ​

4.4 第三方模块的加载机制 ​

4.5 目录作为模块 ​

模块化

1.模块化基本概念

1.1 什么是模块化

1. 现实生活中的模块化

2. 编程领域中的模块化

1.2 模块化规范

2. Node.js 中的模块化

2.1 Node.js 中模块的分类

2.2 加载模块

2.3 Node.js 中的模块作用域

1. 什么是模块作用域

2. 模块作用域的好处

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

1. module 对象

2. module.exports 对象

3. 共享成员时的注意点

4. exports 对象

5. exports 和 module.exports 的使用误区

2.5 Node.js 中的模块化规范

3. npm、cnpm、pnpm、npx、yarn

1.npm、cnpm

1.查看版本

2.设置npm淘宝镜像

3.npm 常用命令简写说明

4.安装模块

5.卸载模块

6.更新模块

7.查看命令

8.其他命令

2.pnpm

1.下载pnpm

2.常用指令

3.npx

npx命令参数

--no-install

--ignore-existing

-p

-c

4.yarn

1.安装yarn

2.查看版本

3.设置淘宝镜像

4.初始化

5.安装依赖包

6.更新依赖包

7.移除依赖包

8.缓存

4.package包

4.1 包

1. 什么是包

2. 包的来源

3. 为什么需要包

4. 从哪里下载包

5. 如何下载包

4. 初次装包后多了哪些文件

6. 包的语义化版本规范

4.2 package.json

1.package.json基本配置说明

2. 多人协作的问题

3. 快速创建 package.json

4. nrm

4.3 包的分类

1. 项目包

2. 全局包

3. i5ting_toc

4.4规范的包结构

4. 模块的加载机制

4.1 优先从缓存中加载

4.2 内置模块的加载机制

4.3 自定义模块的加载机制

4.4 第三方模块的加载机制

4.5 目录作为模块