一、
1.1、什么是包
Node.is 中的第三方模块又叫做包
就像电脑和计算机指的是相同的东西,第三方模块和包指的是同一个概念,只不过叫法不同。
1.2、包来源
不同于 Node.js
中的内置模块与自定义模块,包是由第三方个人或团队开发出来的,免费供所有人使用。
注意:Node.js
中的包都是免费且开源的,不需要付费即可免费下载使用。
1.3、为什么需要包
由于 Node.js
的内置模块仅提供了一些底层的API
,导致在基于内置模块进行项目开发的时,效率很低。包是基于内置模块封装出来的,提供了更高级、更方便的 API,极大的提高了开发效率包和内置模块之间的关系,类似于jQuery
和 浏览器内置 API
之间的关系
1.4、从哪里下载包
国外有一家T 公司,叫做npm,Inc
,这家公司旗下有一个非常著名的网站: https://www.npmjs.com/
,它是全球最大的包共享平台,你可以从这个网站上搜索到任何你需要的包,只要你有足够的耐心!
到目前位置,全球约 1100
多万的开发人员,通过这个包共享平台,开发并共享了超过 120 多万个包 供我们使用,
npm,inc
,公司提供了一个地址为 https://registry.npmjs.org/
的服务器,来对外共享所有的包,我们可以从这个服务器上下载自己所需要的包。
1.5、如何下载包
npm,Inc
,公司提供了一个包管理工具,我们可以使用这个包管理工具,从 https://registry.npmjs.org/
服务器把需要的包下载到本地使用。
这个包管理工具的名字叫做 Node Package Manager
(简称 npm 包管理工具),这个包管理工具随着 Node;js 的安装包一起被安装到了用户的电脑上(不用单独安装)。
二、npm初体验
2.1传统方式实现日期格式化
2.1.1、格式化方法模块封装
/* 格式化工具 */
function dateFormate(dateStr) {
const dt = new Date(dateStr);
const y = dt.getFullYear();
const m = pdZero(dt.getMonth() + 1);
const d = pdZero(dt.getDate());
const hh = pdZero(dt.getHours());
const mm = pdZero(dt.getMinutes());
const ss = pdZero(dt.getSeconds());
return `${y}-${m}-${d} ${hh}:${mm}:${ss}`;
}
/* 补零工具 */
function pdZero(n) {
return n > 9 ? n : "0" + n;
}
/* 共享 */
module.exports = {
dateFormate,
};
2.1.2、格式化方法使用
/* 导入自定义格式化时间的模块 */
const TIME = require("./01dateFormate");
/* 调用方法对日期进行格式化 */
const dt = new Date();
/* 格式化之后的日期 */
const formateDt = TIME.dateFormate(dt);
console.log(formateDt);
image.png
2.2、npm包管理工具实现日期格式化
- 使用
npm
包管理工具具,在项目中安装格式化时间的包moment
- 使用
require()
入格式化时间的包 - 参考
moment
的官方API
文档对时间进行格式化
2.2.1、npm安装moment
image.png2.2.2、导入包
// 1. 导入需要的包
//注意:导入的名称,就是装包时候的名称
const moment = require("moment");
2.2.3、npmjs.com查看moment的文档
image.png安装使用
image.png
image.png
格式化操作
image.png image.png
// 1. 导入需要的包
//注意:导入的名称,就是装包时候的名称
const moment = require("moment");
const dt = moment().format("YYYY-MM-DD HH:mm:ss"); //2023-09-10 10:11:15
console.log(dt);
2.3、包安装成功后多出的文件说明
初次装包完成后,在项目文件夹下多一个叫做 node_modules
的文件夹和 package-lockjson
的配置文件.
其中
-
node_modules
文件夹用来存放所有已安装到项目中的包。
require()
导入第三方包时,就是从这个目录中查找并加载包,
image.png -
package-lock.json
配置文件用来记录node_modules
目录下的每一个包的下载信息,例如包的名字、版本号、下载地址等
image.png
2.4、如何安装指定版本的包
默认情况下,使用 npm install
命令安装包的时候,会自动安装最新版本的包。如果需要安装指定版本的包,可以在包名之后,通过 @
符号指定具体的版本,例如:
npm install moment@2.22.2
2.5、版本号的语义化
包的版本号是以“点分十进制”形式进行定义的,总共有三位数字,例如2.24.0其中每一位数字所代表的的含义如下:
- 第1位数字:大版本
- 第2位数字:功能版本
- 第3位数字:Bug修复版本
版本号提升的规则
:只要前面的版本号增长了,则后面的版本号归零
三、包管理配置文件
npm
规定,在项目根目录中,必须提供一个叫做 package.json
的包管理配置文件。用来记录与项目有关的一些配置信息。例如:
- 项目的名称、版本号、描述等
- 项目中都用到了哪些包
- 哪些包只在开发期间会用到
- 那些包在开发和部署时都需要用到
3.1、多人协作的问题
- 整个项目的体积是30.4M
- 第三方包的体积是28.8M
- 项目源代码的体积 1.6M
遇到的问题: 第三方包的体积过大,不方便团队成员之间共享项目源代码
解决方案: 共享时剔除node_modules
3.2、如何记录项目中安装了哪些包
在项目根目录中,创建一个叫做 package.json
的配置文件,即可用来记录项目中安装了哪些包。从而方便剔除node_modules
目录之后,在团队成员之间共享项目的源代码
注意:今后在项目开发中,一定要把 node_modules
文件夹,添加到gitignore
忽略文件中
3.3、快速创建package.json
npm
包管理工具提供了一个快捷命令,可以在执行命令时所处的目录中,快速创建 package.json
这个包管理配置文件:
// 作用: 在执行命令所处的目录中,快速新建 package.json 文件
npm init -y
上述命令只能在英文的目录下成功
- 所以,项目文件夹的名称一定要使用英文命名,不要使用中文,不能出现空格
- 运行
npm install
命安装包的时候,npm
包管理工具会自动把包的名称和版本号
,记录到package.json
中。
3.4、一次性安装所有包
当我们拿到一个剔除了 node_modules
的项目之后,需要先把所有的包下载到项目中,才能将项目运行起来否则会报类似于下面的错误:
Error:Cannot find module 'moment'
可以运行 npm install
命令( npm i
)一次性安装所有的依赖包:
// 执行 npm install 命令时,npm 包管理T具会先读取 package.json 中的 dependencies 节点
// 读取到记录的所有依赖包名称和版本号之后,npm 包管理工具会把这些包一次性下载到项目中
npm install
3.4、卸载包
可以运行npm uninstall
命令,来卸载指定的包:
注意:npm uninstall
命令执行成功后,会把卸载的包,自动从 package.son
的 dependencies
中移除掉
npm uninstall
3.5、devDependencies 节点
如果某些包只在项目开发阶段会用到,在项目上线之后不会用到,则建议把这些包记录到 devDependencies
节点中
与之对应的,如果某些包在开发和项目上线之后都需要用到,则建议把这些包记录到 dependencies
节点中
您可以使用如下的命令,将包记录到 devDependencies
节点中:
// 安装指定的包,并记录到 devDependencies 节点中
npm i 包名 -D
// 注意:上述命令是简写形式,等价于下面完整的写法:
npm install 包名 --save-dev
3.5.1、如何判断是否记录到devDependencies 节
访问npmjs.com
查找你的包,看一下安装指令就知道了
3.6、解决下包速度慢的问题
3.6.1、为什么下包速度慢
在使用npm
下包的时候,默认从国外的 https:/registry.npmjs.org/
服务器进行下载,此时,网络数据的传输需要经过漫长的海底光缆,因此下包速度会很慢。
3.6.2、淘宝NPM 镜像服务器
淘宝在国内搭建了一个服务器,专门把国外官方服务器上的包同步到国内的服务器,然后在国内提供下包的服务从而极大的提高了下包的速度
image.png
3.7、切换 npm 的下包镜像源
下包的镜像源,指的就是下包的服务器地址。
# 查看当前的下包镜像源
npm config get registry
#将下包的镜像源切换为淘宝镜像源
npm config set registry=https://registry.npm.taobao.org/
# 检查镜像源是否下载成功
npm config get registry
3.8、nrm
为了更方便的切换下包的镜像源,我们可以安装 nrm 这个小具,利用 nrm 提供的终端命令,可以快速查看和切换下包的镜像源。
# 通过 npm 包管理器,将 nrm 安装为全局可用的工具
npm i nrm -g
# 查看所有可用的镜像源
nrm ls
# 将下包的镜像源切换为 taobao 镜像
nrm use taobao
image.png
3.9、包分类
3.9.1、项目包
那些被安装到项目的 node_modules
日录中的包,都是项目包。
项目包又分为两类,分别是:
- 开发依赖包(被记录到
devDependencies
节点中的包,只在开发期间会用到) - 核心依赖包(被记录到
dependencies
节点中的包,在开发期间和项目上线之后都会用到)
3.9.1、全局包
在执行 npm install
命令时,如果提供了-g
参数,则会把包安装为全局包
全局包会被安装到C:\Users\26928\AppData\Roaming\npm\node_modules
目录下
npm i 包名 -g
#全局安装指定的包
npm uninstall 包名 -g#卸载全局安装的包
3.10、规范的包结构
在清楚了包的概念、以及如何下载和使用包之后,接下来,我们深入了解一下包的内部结构。
一个规范的包,它的组成结构,必须符合以下3 点要求:
- 包必须以单独的目录而存在
- 包的顶级目录下要必须包含
package.json
这个包管理配置文件 -
package.json
中必须包含name,version,main
这三个属性,分别代表包的名字、版本号、包的入口。
网友评论