模块化

1. 模块化的基本概念

1.1 什么是模块化

  1. 定义: 模块化是指解决一个复杂问题时,自顶向下逐层把系统划分成若干模块的过程。对于整个系统来说,模块是可组合、分解和更换的单元。
  2. 编程领域中的模块化
    • 编程领域中的模块化,就是遵守固定规则,把一个大文件拆成独立并相互依赖的多个小文件
    • 代码进行模块化拆分的好处:
      1. 提高了代码的复用性
      2. 提高了代码的可维护性
      3. 可是实现按需加载

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 对象
    在每个模块中都有一个 module 对象,module 对象里存储了和当前模块相关的信息。

  2. module.exports 对象

    • exportsmodule 的一个属性,默认指向一个空对象。
    • 通过exports属性,将模块内的共享成员共享出去,共外界使用。
    • 使用的 require() 方法的导入模块时,得到的就是 module.exports 所指向的对象。
  3. exports 对象

    • exportsmodule.exports 的简写形式,默认情况下,exportsmodule.exports 指向的是同一个对象。
  4. 共享对象注意点

    • 使用 require() 方法导入模块时,永远是module.exports指向的对象;
    • 换句话说,在一个模块中,如果已经改变了 module.exports 的指向,那么再使用 exports 共享模块内的成员是无效的。
    • 在模块内共享模块内成员时,不要同时使用 exportsmodule.exports

2.5 Node.js中的模块化规范

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

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

3. npm与包

3.1 包

  1. 什么是包
    Node.js中的第三方模块又叫做包。

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

  3. 为什么需要包

    • Node.js的内置模块仅提供了一些底层的API,导致在基于内置模块进行项目开发时,效率低下。
    • 包是基于内置模块封装出来的,提供了更方便的API,极大地提高了开发效率。
    • 包与内置模块的关系,类似于 jQuery 和 浏览器内置 API 之间的关系。
  4. 从哪里下载包
    国外有一家 IT 公司,叫做 npm, Inc. 这家公司旗下有一个非常著名的网站: (https://www.npmjs.com/) ,它是全球最大的包共享平台,你可以从这个网站上搜索到任何你需要的包。
    npm, Inc. 公司提供了一个地址为 (https://registry.npmjs.org/) 的服务器,来对外共享所有的包,我们可以从这个服务器上下载自己所需要的包。

  5. 如何下载包
    npm, Inc. 公司提供了一个包管理工具,我们可以使用这个包管理工具,从 (https://registry.npmjs.org/) 服务器把需要的包下载到本地使用。
    这个包管理工具的名字叫做 Node Package Manager(简称 npm 包管理工具),这个包管理工具随着 Node.js 的安装包一起被安装到了用户的电脑上。
    可以在终端中执行 npm -v 命令,来查看自己电脑上所安装的 npm 包管理工具的版本号。

3.2 切换npm源

  1. 在使用 npm 下包的时候,默认从国外的服务器进行下载,此时,网络数据的传输需要经过漫长的海底光缆,因此下包速度会很慢。
  2. 淘宝 NPM 镜像服务器
    淘宝在国内搭建了一个服务器,专门把国外官方服务器上的包同步到国内的服务器,然后在国内提供下包的服务。从而极大的提高了下包的速度。
  3. nrm
    • nrm 是管理 npm 源的工具,使用 nrm 提供的终端命令,可以快速查看和切换下载包的镜像源。
    # 查看当前的包镜像源  
    npm config get registry  
    # 通过 npm 包管理器,将 nrm 安装为全局可用的工具  
    npm i nrm -g
    # 查看所有可用的镜像源  
    nrm ls  
    # 将包的镜像源切换为 taobao 镜像  
    nrm use taobao  
    

3.3 包的分类

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

  1. 全局包

    • 在执行 npm install 命令时,如果提供了 -g 参数,则会把包安装为全局包。
        npm i 包名 -g           # 全局安装指定的包  
        npm uninstall 包名 -g   # 卸载全局安装的包  
      
    • 只有工具性质的包,才有全局安装的必要,判断某个包是否需要全局安装,参考官方提供的使用说明即可。
  2. 项目包
    项目包又分为两类:

    • 开发依赖包(被记录到devDependencies节点中的包,只在开发期间会用到)
    • 核心依赖包(被记录到dependencies节点中的包,在开发期间和项目上线之后都会用到)
    npm i 包名 -D    # 开发依赖包(会被记录到 devDependencies 节点下)  
    npm i 包名       # 核心依赖包(会被记录到 dependencies 节点先)  
    
  3. 安装指定版本的包
    默认情况下,使用npm install 命令安装包时,会自动安装最新版本的包。如果需要安装指定版本的包,可以在包名之后,通过@符号指定具体的版本。

    npm i 包名@版本号
    
  4. 包的语义化版本规范
    包的版本号是以 "点分十进制" 形式进行定义的,总共有三位数字,例如: 2.24.0
    其中每一位数字所代表的含义如下:

    • 第一位数字:大版本
    • 第二位数字:功能版本
    • 第三位数字:Bug修复版本

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

3.4 在项目使用包

  1. 包管理配置文件

    1. npm 规定,在项目根目录中,必须提供一个叫做 package.json 的包管理配置文件。用来记录与项目有关的一些配置信息。例如:
      • 项目中的名称、版本号、描述等。
      • 项目中都用到了那些包
      • 哪些包只会在开发期间用到的
      • 哪些包在开发和部署时都会用到
    2. 新建项目之后,使用 npm init -y 命令快速创建 package.json 文件
      1. 上述命令只能在英文目录下成功运行,所以项目文件夹的名称一定要使用英文命名,不要使用中文,不能出现空格。
      2. 运行 npm install 命令安装包时,npm会自动把包的名称和版本号,记录到 package.json 中。
      3. 核心依赖包会记录在 package.json 中 dependencies 节点中,开发者依赖包会记录在 package.json 中 devDependencies 节点中。
      4. 使用 npm uninstall 命令卸载包时,npm 会自动将包的相关信息从 package.json 文件中移出。
  2. node_modules文件夹与package-lock.json配置文件
    初次安装项目包完成后,在项目根目录下会生成一个 node_modules 的文件夹和 package-lock.json 文件

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

    : 不要修改 node_modules 或 package-lock.json 文件中的任何代码,包管理工具npm会自动维护他们。

  3. 多人协作开发与包的管理

    1. 问题:在项目中,由于第三方包体积过大,不方便团队成员之间共享项目源码。
    2. 解决方案:共享时剔除 node_modules 文件夹(可以将 node_modules 文件夹添加到 .gitignore 忽略文件中)。
    3. 当拿到了一个剔除 node_modules 的项目后,执行 npm i 命令。
    4. 执行 npm i 命令时,npm 会根据 package.json 中的 dependencies 节点中的包的相关信息一次性安装所有核心依赖包

4. 模块加载机制

4.1 优先从缓存中加载

模块在第一次加载后会被缓存,这意味着多次调用 require() 不会导致模块的代码被执行多次。
不论是内置模块、用户自定义模块、还是第三方模块,都会优先从缓存中加载,从而提高模块的加载效率。

4.2 内置模块的加载机制

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

4.3 自定义模块的加载机制

  • 使用 require() 方法加载自定义模块时,必须指定以 ./../ 开头的路径标识符。
  • 在加载自定义模块时,如果没有指定 ./../ 这样的路径标识符,那么node会把它当做内置模块第三方模块进行加载。
  • 同时,在使用require() 导入自定义模块时,如果省略了文件的扩展名,则node会按顺序分别尝试加载以下的文件:
    1. 按照确切的文件名进行加载
    2. 补全 .js 扩展名进行加载
    3. 补全 .json 扩展名进行加载
    4. 补全 .node 扩展名进行加载
    5. 加载失败,会在终端打印错误消息,报告模块的缺失:Error: Cannot find module 'xxx'

4.4 第三方模块的加载机制

  • 如果传递给require() 的模块表示符不是一个内置模块,也没有以 ././ 开头,则node会从当前模块的父目录开始,尝试从 node_modules 文件夹中加载第三方模块。
  • 如果没有找到对应的第三方模块,则移动到上一层父目录中,进行加载; 重复执行此步骤,直到文件系统的根目录。
  • 如果最终没找到,则会报错 Error: Cannot find module '模块名'

4.5 目录作为模块

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

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

PS: 如果本文对你有帮助,请点个赞吧!

原文地址:https://www.cnblogs.com/discourage/p/13849905.html