Node.js进阶-包与模块化

轩不丢

已于 2024-03-03 19:15:35 修改

阅读量171

点赞数 6

分类专栏：后端文章标签： node.js npm 后端 javascript https

于 2023-11-14 09:18:22 首次发布

本文链接：https://blog.csdn.net/ning_xiao_xuan/article/details/134165005

版权

后端专栏收录该内容

4 篇文章 0 订阅

订阅专栏

一、模块化

1、概念

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

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

2、node.js的模块

内置模块(内置模块是由Node.js官方提供的，例如fs、path. http 等)

自定义模块(用户创建的每个.js文件,都是自定义模块)

第三方模块(由第三方开发出来的模块,并非官方提供的内置模块,也不是用户创建的自定义模块,使用前需要先下载)

3、加载模块

使用强大的 $re q u i re ()$ 方法，可以加载需要的内置模块、用户自定义模块、第三方模块进行使用。

// 1.加载内置的fs模块
const fs = require('fs')
// 2.加载用户的自定义模块，去掉.js也能成功加载
const custom = require(' ./custom.js ' )   //需要路径
// 3.加载第三方模块(关于第三方模块的下载和使用，会在后面的课程中进行专门的讲解)
const moment = require( ' moment ' )

注意：使用require0方法加载其它模块时,会执行被加载模块中的代码。

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

模块内的变量和方法只能模块内部使用，即使加载模块也无法使用，想要共享，可以使用 $m o d u l e$ 对象
在每个js自定义模块中都有一个 $m o d u l e$ 对象,它里面存储了和当前模块有关的信息， $co n so l e . l o g (m o d u l e)$ 打印如下:
在这里插入图片描述
通过exports属性可以对外共享数据
在自定义模块中，可以使用module.exports对象，将模块内的成员共享出去，供外界使用。
外界用require方法导入自定义模块时，得到的就是module.exports所指向的对象。
程序员可以选择想要暴露的属性

const age = 20
//向module. exports 对象上挂载username 馬性
module.exports.username =' zs'
//向module.exports对象上挂载sayHello方法
module.exports.sayHello = function() {
	console.log( 'Hello!')
}

由于 $m o d u l e . e x p or t s$ 单词写起来比较复杂，为了简化向外共享成员的代码，Node提供了 $e x p or t s$ 对象。默认情况下， $e x p or t s$ 和 $m o d u l e . e x p or t s$ 指向同一个对象。最终共享的结果，还是以 $m o d u l e . e x p or t s$ 指向的对象为准。
时刻谨记，require()模块时，得到的永远是module.exports指向的对象: .
在这里插入图片描述
为了防止混乱，建议大家不要在同一个模块中同时使用exports和module.exports

5、模块化规范

Nodejs遵循了CommonJS模块化规范, CommonJS 规定了模块的特性和各模块之间如何相互依赖。
CommonJS规定:
①每个模块内部，module 变量代表当前模块。
②module变量是一个对象，它的exports属性(即module.exports)是对外的接口。
③加载某个模块，其实是加载该模块的module.exports属性。require(方法用于加载模块。

二、npm与包

1、概念

Node.js中的第三方模块又叫做包。
由于Node.js的内置模块仅提供了一些底层的API,导致在基于内置模块进行项目开发的时,效率很低。
包是基于内置模块封装出来的，提供了更高级、更方便的API,极大的提高了开发效率。

2、包的来源

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

3、包的下载与使用

国外有一家IT公司,叫做npm, Inc. 这家公司旗下有一个非常著名的网站：npm，是目前全球最大的包共享平台。（可在官网网站查阅文档）
npm, Inc. 公司提供了一个的服务器,来对外共享所有的包，我们可以从这个服务器上下载自己所需要的包。
注意服务器地址打不开，npm, Inc.公司提供了一个包管理工具,我们可以使用这个包管理工具，从服务器把需要的包下载到本地使用。
这个包管理工具的名字叫做Node Package Manager (简称npm包管理工具) , 这个包管理工具随着Node.js的安装包一起被安装到了用户的电脑上。
可以在终端中执行 $n p m - v$ 命令,来查看自己电脑上所安装的npm包管理工具的版本号
安装指定名称的包，使用如下命令

npm install 包的完整名称[@版本号]/npm i 完整的包名称[@版本号]
不写版本号默认最新版本
重新安装不需要卸载，会直接覆盖

包的使用和模块使用方式一样，具体用处见官方文档npm

4、下载速度慢的解决方法

PS：在使用npm下包的时候，默认从国外的服务器进行下载,此时，网络数据的传输需要经过漫长的海底光缆，因此下包速度会很慢。
使用镜像服务器：
一些公司在国内搭建了一个服务器，专]把国外官方服务器上的包同步到国内的服务器，然后在国内提供下包的服务。从而极大的提高了下包的速度。此时应该切换npm的下包镜像源：
下包镜像源，指的就是下包的服务器地址

#查看当前的下包镜像源
	npm config get registry 
#将下包的镜像源切换为淘宝镜像源
	npm config set registry=https://registry.npm.taobao.org/
#检查镜像源是否下载成功
	npm config get registry

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

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

三、npm

1、npm初体验

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

2、包管理配置文件

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

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

1）多人协作问题

一般一个项目中自己写的源代码体积很小，主要是第三方包占据主要内存，因此在共享时只需要传输自己源代码，第三方包需要剔除，因此需要记录，因此package.json就是用来记录第三方包的。package.json文件中，有一个dependencies节点，专门用来记录您使用npm install
命令安装了哪些包。
今后在项目开发中，一定要把node.modules文件夹,添加到.gitignore忽略文件中。（不让git将node.modules上传）
npm包管理工具提供了一个快捷命令 ,可以在执行命令时所处的目录中，快速创建packagejson这个包管理配置文件:

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

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

2）一次性安装所有包

当我们拿到一个副除了node _modules的项目之后,需要先把所有的包下载到项目中，才能将项目运行起来。
因为package.json还在，可以运行npm install命令(或npm i) 一次性安装所有的依赖包。执行npm install 命令时，rpm包管理工具先读取package.json中的dependencies 节点
被取到的所有依赖包名称版本号之后。npm包管理工具会把这些包一次性下载到项目中

3）卸载包

可以运行npm uninstall 包名命令,来卸载指定的包：
npm uninstall命令执行成功后，会把卸载的包，自动从package.json的dependencies中移除

4）调试包

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

npm -i 包名 -D //npm install 包名 --save-dev

3、包的分类

1）项目包

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

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

2）全局包

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

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

只有工具性质的包，才有全局安装的必要性。因为它们提供了好用的终端命令。
判断某个包是否需要全局安装后才能使用，可以参考官方提供的使用说明即可
常见包：i5ting_ toc
i5ting_ toc是一一个可以把md文档转为html页面的小工具，使用步骤如下:

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

4、规范包结构

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

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

5、开发属于自己的包

1）步骤

新建一个自命名的文件夹，作为包的根目录。
在根目录中，新建如下三个文件：
package.json（包管理配置文件）

{
	"name": 自定义 ，
	"version": "1.0.0",
	"main": "index.js",
	"description":”简单说明这个包的功能" ,
	"keywords": [" itheima",” dateFormat", "escape"] ,  //搜索的关键字，自行写
	"license":” ISC"   //遵循的开源许可协议
}

        关于license相关信息，参考协议
    index.js(包的入口文件)
    README.md（包的说明文档）

2）模块化拆分

若是一个包里面实现了很多功能，全放在index.js不太好，因此可以分类整理
将不同的功能，拆分到对应src -> 自定义命名.js中，并用module.exports将功能暴露出去
在index.js中，导入各个模块，得到需要向外共享的方法。

const 自定义命名 = require('./src/自定义命名');

在index.js中,使用module.exports把对应的方法共享出去

3）README.md

包根目录中的README.md文件,是包的使用说明文档。通过它,我们可以事先把包的使用说明，以markdown的格式写出来,方便用户参考。
README文件中具体写什么内容,没有强制性的要求;只要能够清晰地把包的作用、用法、注意事项等描述清楚即可。
我们所创建的这个包的README.md文档中，会包含以下6项内容:
安装方式、导入方式、内部实现方法（举例说明一下）、开源协议

6、发布包

1）注册npm账号

访问网站，点击sign up按钮,进入注册用户界面
填写账号相关的信息: Full Name、Public Email、Username、 Password
点击Create an Account按钮，注册账号
登录邮箱，点击验证链接,进行账号的验证

2）登录npm账号

这里所指的登录，不是在网站上登录，而是在终端上登录。
npm账号注册完成后，可以在终端中执行npm login命令,依次输入用户名、密码、邮箱后,即可登录成功。
注意:在运行npm login命令之前，必须先把下包的服务器地址切换为npm的官方服务器。否则会导致发布包失败

3）发布包

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

4）删除已发布的包

运行npm unpublish 包名 --force命令,即可从npm删除已发布的包。
npm unpublish命令只能删除72小时以内发布的包
npm unpublish删除的包，在24小时内不允许重复发布

7、模块加载机制

1）缓存机制

模块在第一次加载后会被缓存。这也意味看多次调用require0不会导致模块的代码被执行多次，只能执行一次。
注意:不论是内置模块、用户自定义模块、还是第三方模块，它们都会优先从缓存中加载，从而提高模块的加载效率。

2）优先级

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

3）自定义模块

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

4）第三方模块

如果传递给require0的模块标识符不是一个内置模块, 也没有以’I’ 或…/” 开头，则Node.js会从当前模块的父目录开始，尝试从/node_ modules 文件夹中加载第三方模块。
如果没有找到对应的第三:方模块，则移动到再上- -层父目录中，进行加载，直到文件系统的根目录。
例如，假设在’C:\Users\itheima\project\foo.js’文件里调用了require(toos),则Node.js会按以下顺序查找:
    ①C:\Users\itheima\project\node_ modules\tools
    ②C:\Users\itheima\node_ modules\tools
    ③C:\Users\node_ modules\tools
    ④C:\node modules\tools
    ⑤加载失败，终端报错

5）目录作为模块

当把目录作为模块标识符,传递给require0进行加载的时候,有三种加载方式:
    ①在被加载的目录下查找一个叫做package.json的文件,并寻找main属性,作为require0加载的入口
    ②如果目录里没有package.json 文件,或者main入口不存在或无法解析,则Node.js将会试图加载目录下的index.js文件
    ③如果以上两步都失败了，则Node.js会在终端打印错误消息，报告模块的缺失: Error: Cannot find module ‘xxx’