Node.js模块化与包管理详解-优快云博客

本文链接：https://blog.youkuaiyun.com/GJM_Memory/article/details/123021519

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

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

提高了代码的复用性

提高了代码的可维护性

可以实现按需加载

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

内置模块

自定义模块

第三方模块

什么是模块作用域？

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

模块作用域的好处：防止了全局变量污染的问题

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

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

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

// 在一个自定义模块中，默认情况下，module.exports={}
const age=20
module.exports.username='zs'

module.exports.sayHello=function(){
    console.log('hello')
}
module.exports.age=age

// 让module.exports指向一个全新的对象
module.exports={
    nickname:'小黑',
    sayHi(){
        console.log('h1')
    }
}

exports对象

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

// console.log(exports)
// console.log(module.exports)
// console.log(exports===module.exports)

const username='zs'
exports.username=username
exports.age=20
exports.sayHello=function(){
    console.log('大家好')
}

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

nodejs中的模块化规范

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

CommonJS规定：

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

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

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

npm与包

nodejs中的第三方模块又叫做包。

在项目中安装包的命令

npm install 包的完整名称
//或
npm i 包的完整名称

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

其中：

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

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

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

安装指定版本的包

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

npm i moment@2.22.2

包的语义化版本规范

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

第一位数字：大版本第二位数字：功能版本第三位数字：bug修复版本

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

包管理配置文件

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

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

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

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

快速创建package.json

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

//作用：在执行命令所处的目录中，快速新建package.json文件
npm init -y

注意：

①上述命令只能在英文的目录下成功运行！所以，项目文件夹的名称一定要使用英文命名，不要使用中文，不能出现空格。

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

一次性安装所有的包

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

//执行npm install命令时，npm包管理工具先读取package.json中的dependencies节点，读取到记录的所有依赖包名称和版本号之后，npm包管理工具会把这些包一次性下载到项目中。
npm install

卸载包

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

npm uninstall moment

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

devDependencies节点

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

//安装指定的包，并记录到devDependencies节点中
npm i 包名 -D
//完整写法
npm install 包名 --save-dev

为什么下包速度慢

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

解决下包速度慢的问题

切换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 ls
//将下包的镜像源铁环为淘宝镜像
nrm use taobao

如果报错禁止运行，以管理员身份打开powershell输入 set-ExecutionPolicy RemoteSigned 即可。

包的分类

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

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

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

开发依赖包（被记录到devDependencies节点中的包，只在开发期间会用到）

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

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

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

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

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

注意：

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

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

规范的包结构

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

①包必须以单独的目录而存在

②包的顶级目录下要必须包含package.json这个包管理配置文件

③package.json中必须包含name，version，main这三个属性，分别代表包的名字、版本号、包的入口

开发属于自己的包

新建itheima-tools文件夹，作为包的根目录

在itheima-tools文件夹中，新建如下三个文件：

package.json（包管理配置文件）

index.js（包的入口文件）

README.md（包的说明文档）

模块的加载机制

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

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

内置模块的加载机制

内置模块是有nodejs官方提供的模块，内置模块的加载优先级最高。

自定义模块的加载机制

使用require()加载自定义模块时，必须指定以./或../开头的路径标识符。在加载自定义模块时，如果没有指定./或../这样的路径标识符，则node会把它当做内置模块或第三方模块进行加载。

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

①按照确切的文件名进行加载

②补全.js扩展名进行加载

③补全.json扩展名进行加载

④补全.node扩展名进行加载

⑤加载失败，终端报错

第三方模块的加载机制

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

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

目录作为模块

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

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

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

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