首页 NodeJs

# 模块化

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

# 加载模块

使用 require() 方法，可以加载需要的内置模块，用户自定义模块，第三方模块进行使用

1
2
3
4
5
6
7
8
// 1. 加载内置的fs模块
const fs = require('fs')

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

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

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

# 模块作用域

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

# module 对象

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

# module.exports 对象

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

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

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

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

# 模块化规范

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

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

# npm

初次安装包完成后，在项目文件夹多一个 node-modules 的文件夹和 package-lock.json 的配置文件

其中 :

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

# 安装指定版本的包

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

1
npm install moment@2.29.4

# 包管理配置文件

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

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

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

所以在开发中，一定要把 node_modules 文件夹添加到.gitignore 忽略文件中

# 快速创建 package.json

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

1
npm init -y

** 注意 : **

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

当剔除了 node_modules 文件夹后，可以运行 npm install 命令 (或 npm i) 一次性安装所有的依赖包

# 卸载包

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

1
npm uninstall moment

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

# devDependencies 节点

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

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

# 全局包

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

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

** 注意 : **

  1. 只有工具性质的包，才有全局安装的必要性。因为它们提供了好用的终端命令
  2. 如何判断包是否设置为全局包，查看官方文档即可

# 规范的包结构

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

# 模块的加载机制

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

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

  • 内置模块的加载机制：内置模块是由 Node.js 官方提供的模块，内置模块的加载优先级最高
  • ** 自定义模块的加载机制 : ** 使用 require () 加载自定义模块时，必须指定以 ./ 或 ../ 开头的路径标识符。在加载自定义模块时，如果没有指定 ./ 或 ../ 这样的路径标识符，则 node 会把它当作内置模块或第三方模块进行加载
  • ** 第三方模块的加载机制 : ** 如果传递给 require () 的模块标识符不是一个内置模块，也没有以 ./ 或 ../ 开头，则 Node.js 会从当前的父目录开始，尝试从 /node_modules 文件夹中加载第三方模块，== 如果没有找到对应的第三方模块，则移动到再上一层父目录中查找，直到找到文件系统的根目录

假设在 ‘C:\Users\realWong\project\foo.js’文件里调用了 require (‘tools’), 则 Node.js 会按以下顺序查找 :

  1. C:\Users\realWong\project\node_modules\tools
  2. C:\Users\realWong\node_modules\tools
  3. C:\Users\node_modules\tools
  4. C:\node_modules\tools
  5. 加载失败，终端报错

同时，在使用 require () 导入自定义模块时，如果省略了文件的扩展名，Node.js 会按顺序分别尝试加载以下文件

  1. 按照确切的文件名进行加载
  2. 补全.js 扩展名进行加载
  3. 补全.json 扩展名进行加载
  4. 补全.json 扩展名进行加载
  5. 加载失败，终端报错

# 目录作为模块

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

  1. 在被加载的目录下查找一个叫做 package.json 的文件，并寻找 main 属性，作为 require () 的加载入口
  2. 如果目录中没有 package.json 文件，或者 main 入口不存在或无法解析，则 Node.js 会试图加载目录下的 index.js 文件
  3. 如果以上两步都失败了，则 Node.js 在终端报错 : Error: Can not find module xxx
更新于 阅读次数 次