前后端交互—模块化

模块化

代码下载

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

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

1. 提高了代码的复用性
2. 提高了代码的可维护性
3. 可以实现按需加载

模块化规范 就是对代码进行模块化的拆分与组合时，需要遵守的那些规则。都遵守同样的模块化规范写代码，降低了沟通的成本，极大方便了各个模块之间的相互调用，利人利己。

Node.js 中的模块化

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

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

使用强大的 require() 方法，可以加载需要的内置模块、用户自定义模块、第三方模块进行使用。 需要注意的是使用 require() 方法加载其它模块时，会执行被加载模块中的代码。 例如:

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

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

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

模块作用域: 和函数作用域类似，在自定义模块中定义的变量、方法等成员，只能在当前模块内被访问，这种模块级别的访问限制，叫做模块 作用域。好处是可以防止全局变量污染的问题。

module 对象

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

Module {
  id: '.',
  path: '/Users/suzheng/QSP/Learn/web前端/WebInteraction/js/Node',
  exports: {},
  parent: null,
  filename: '/Users/suzheng/QSP/Learn/web前端/WebInteraction/js/Node/moduleOne.js',
  loaded: false,
  children: [
    Module {
      id: '/Users/suzheng/QSP/Learn/web前端/WebInteraction/js/Node/custom.js',
      path: '/Users/suzheng/QSP/Learn/web前端/WebInteraction/js/Node',
      exports: {},
      parent: [Circular],
      filename: '/Users/suzheng/QSP/Learn/web前端/WebInteraction/js/Node/custom.js',
      loaded: true,
      children: [],
      paths: [Array]
    }
  ],
  paths: [
    '/Users/suzheng/QSP/Learn/web前端/WebInteraction/js/Node/node_modules',
    '/Users/suzheng/QSP/Learn/web前端/WebInteraction/js/node_modules',
    '/Users/suzheng/QSP/Learn/web前端/WebInteraction/node_modules',
    '/Users/suzheng/QSP/Learn/web前端/node_modules',
    '/Users/suzheng/QSP/Learn/node_modules',
    '/Users/suzheng/QSP/node_modules',
    '/Users/suzheng/node_modules',
    '/Users/node_modules',
    '/node_modules'
  ]
}

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

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

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

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

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

npm与包

Node.js 中的第三方模块又叫做包。不同于 Node.js 中的内置模块与自定义模块，包是由第三方个人或团队开发出来的，免费供所有人使用。 注意:Node.js 中的包都是免费且开源的，不需要付费即可免费下载使用。

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

国外有一家 IT 公司，叫做 npm, Inc. 这家公司旗下有一个非常著名的网站: https://www.npmjs.com/ ，它是全球最大的包共享平台，可以从这个网站上搜索到任何你需要的包。 npm, Inc. 公司提供了一个地址为 https://registry.npmjs.org/ 的服务器，来对外共享所有的包，可以从这个服务器上下载自己所需要的包。

如何下载包

npm, Inc. 公司提供了一个包管理工具，可以使用这个包管理工具，从 https://registry.npmjs.org/ 服务器把需要的包下载到本地使用。这个包管理工具的名字叫做 Node Package Manager(简称 npm 包管理工具)，这个包管理工具随着 Node.js 的安 装包一起被安装到了用户的电脑上。

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

$ npm -v
6.11.3

如果想在项目中安装指定名称的包，需要运行命令: npm instal1 包的完整名称，可以简写成格式: npm i 完整的包名称。默认情况下，使用 npm install 命令安装包的时候，会自动安装最新版本的包。如果需要安装指定版本的包，可以在包名之后，通过 @ 符号指定具体的版本: npm install moment@2.29.4。

包的版本号是以“点分十进制”形式进行定义的，总共有三位数字，例如 2.24.0 其中每一位数字所代表的的含义如下:

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

初次装包后多了哪些文件

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

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

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

包管理配置文件

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

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

在项目根目录中，创建一个叫做 package.json 的配置文件，即可用来记录项目中安装了哪些包。从而方便剔除 node_modules 目录之后，在团队成员之间共享项目的源代码。注意:在项目开发中，一定要把 node_modules 文件夹，添加到 .gitignore 忽略文件中。

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

npm init -y

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

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

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

Error: Cannot find module 'moment'

可以运行 npm install 命令(或 npm i)一次性安装所有的依赖包:

npm install

可以运行 npm uninstall 命令，来卸载指定的包:

npm uninstall moment

注意: npm uninstall 命令执行成功后，会把卸载的包，自动从 package.json 的 dependencies 中移除掉。

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

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

解决下包速度慢的问题

在使用 npm 下包的时候，默认从国外的 https://registry.npmjs.org/ 服务器进行下载，此时，网络数据的传输需要经过漫长的海底光缆，因此下包速度会很慢。海底光缆:

• https://baike.baidu.com/item/%E6%B5%B7%E5%BA%95%E5%85%89%E7%BC%86/4107830
• https://baike.baidu.com/item/APG/23647721?fr=aladdin

淘宝 NPM 镜像服务器，淘宝在国内搭建了一个服务器，专门把国外官方服务器上的包同步到国内的服务器，然后在国内提供下包的服务。从而极大的提高了下包的速度。

镜像(Mirroring)是一种文件存储形式，一个磁盘上的 数据在另一个磁盘上存在一个完全相同的副本即为镜像。

切换 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 1s
＃将下包的镜像源切换为 taobao 镜像
nrm use taobao

使用 npm 包管理工具下载的包，共分为两大类，分别是:项目包、全局包。

项目包，那些被安装到项目的 node_modules 目录中的包，都是项目包。项目包又分为两类，分别是:

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

npm i 包名 -D ＃开发依赖包（会被记录到 devDependencies 节点下）
npm i 包名 #核心依赖包（会被记录到 dependencies 节点下）

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

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

npm i 包名 -g ＃全局安装指定的包
npm uninstal1 包名 -g ＃卸载全局安装的包

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

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

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

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

开发一个自己的包

初始化包的基本结构

1. 新建 XXXX 文件夹，作为包的根目录
2. 在 XXXX 文件夹中，新建如下三个文件:
   • package.json (包管理配置文件)
   • index.js (包的入口文件)
   • README.md (包的说明文档)

初始化 package.json，关于更多 license 许可协议相关的内容，可参考 https://www.jianshu.com/p/86251523e898：

{
  "name": "XXXX",
  "version": "1.0.0",
  "main": "index.js",
  "description": "这是一个牛逼的包，提供了牛逼的功能",
  "keywords": [
    "kw1",
    "kw2",
    "kw3"
  ],
  "license": "IMT"
}

模块功能拆分实现

将不同的功能进行模块化拆

功能一，拆分到 src -> toolOne.js 中：

function fO1() {
    console.log('第一个工具的第一个功能方法！');
}
function fO2() {
    console.log('第一个工具的第二个功能方法！');
}
exports.fO1 = fO1;
exports.fO2 = fO2;

将功能二，拆分到 src -> toolTwo.js 中：

function fT1() {
    console.log('第二个工具的第一个功能方法！');
}
function fT2() {
    console.log('第二个工具的第二个功能方法！');
}
module.exports = {
    fT1,
    fT2
}

在 index.js 中，导入两个模块，得到需要向外共享的方法，使用 module.exports 把对应的方法共享出去：

const toolOne = require('./src/toolOne.js');
const toolTwo = require('./src/toolTwo.js');
module.exports = {
    nm: name,
    sayHello() {
        console.log('hello every one!');
    },
    ...toolOne,
    ...toolTwo
}

编写包的说明文档，包根目录中的 README.md 文件，是包的使用说明文档。通过它，我们可以事先把包的使用说明，以 markdown 的 格式写出来，方便用户参考。

README 文件中具体写什么内容，没有强制性的要求;只要能够清晰地把包的作用、用法、注意事项等描述清楚即可。一般包的 README.md 文档中，会包含以下几个方面内容: 安装方式、导入方式、如何使用、开源协议。

发布包

1. 访问 https://www.npmjs.com/ 网站，注册 npm 账号

2. npm 账号注册完成后，可以在终端中执行 npm login 命令，依次输入用户名、密码、邮箱后，即可登录成功：

npm login
Username: *****
Password:
Email: (this IS public) **@**.com
Logged in as 1lb1314 on https://registry.npmjs.org/.

注意: 在运行 npm login 命令之前，必须 先把下包的服务器地址切换为 npm 的官方 服务器。否则会导致发布包失败!

3. 将终端切换到包的根目录之后，运行 npm publish 命令，即可将包发布到 npm 上(注意:包名不能雷同)。

npm publish XXXX

4. 运行 npm unpublish 包名 --force 命令，即可从 npm 删除已发布的包。

npm unpublish XXXX --force

注意:

• npm unpublish 命令只能删除 72 小时以内发布的包
• npm unpublish 删除的包，在 24 小时内不允许重复发布
• 发布包的时候要慎重，尽量不要往 npm 上发布没有意义的包

模块的加载机制

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

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

2. 内置模块是由 Node.js 官方提供的模块，内置模块的加载优先级最高。例如，require('fs') 始终返回内置的 fs 模块，即使在 node_modules 目录下有名字相同的包也叫做 fs。

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

• 按照确切的文件名进行加载
• 补全 .js 扩展名进行加载
• 补全 .json 扩展名进行加载
• 补全 .node 扩展名进行加载
• 加载失败，终端报错

4. 如果传递给 require() 的模块标识符不是一个内置模块，也没有以 ‘./’ 或 ‘../’ 开头，则 Node.js 会从当前模块的 父 目录开始，尝试从 /node_modules 文件夹中加载第三方模块。如果没有找到对应的第三方模块，则移动到再上一层父目录中，进行加载，直到文件系统的根目录。 例如，假设在 '\Users\project\foo.js' 文件里调用了 require('tools')，则 Node.js 会按以下顺序查找:

• \Users\project\node_modules\tools
• \Users\node_modules\tools
• \node_modules\tools

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

• 在被加载的目录下查找一个叫做 package.json 的文件，并寻找 main 属性，作为 require() 加载的入口
• 如果目录里没有 package.json 文件，或者 main 入口不存在或无法解析，则 Node.js 将会试图加载目录下的 index.js 文件
• 如果以上两步都失败了，则 Node.js 会在终端打印错误消息，报告模块的缺失:Error: Cannot find module 'xxx'