npm与包

1、包

  1. nodejs中的第三方模块又叫做包
  2. 包是由第三方个人或团队开发出来的
    1. 包是基于node内置模块封装出来的,提供了更高级，更方便的API,极大的提高了开发效率
    2. 包和内置模块的关系，类似于jQuery于浏览器内置API的关系

2、npm安装

2.1、在项目中安装包的命令

1
2
3
npm install 包的完整名称
或者
npm i 包的完整名称

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

  • node_modules 文件夹用来存放所有已安装到项目中的包
  • package-lock.json 配置文件用来记录 node_modules 目录下每个包的下载信息，比如包的名字、版本号、下载地址
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
    "name": "test",
    "version": "1.0.0",
    "lockfileVersion": 1,
    "requires": true,
    "dependencies": {
        "bootstrap": {
            "version": "5.1.3",
            "resolved": "https://registry.npmmirror.com/bootstrap/-/bootstrap-5.1.3.tgz",
            "integrity": "sha512-fcQztozJ8jToQWXxVuEyXWW+dSo8AiXWKwiSSrKWsRB/Qt+Ewwza+JWoLKiTuQLaEPhdNAJ7+Dosc9DOIqNy7Q=="
        },
        "jquery": {
            "version": "3.6.0",
            "resolved": "https://registry.npmmirror.com/jquery/-/jquery-3.6.0.tgz",
            "integrity": "sha512-JVzAR/AjBvVt2BmYhxRCSYysDsPcssdmTFnzyLEts9qNwmjmu4JTAMYubEfwVOSwpQ1I1sKKFcxhZCI2buerfw=="
        }
    }
}

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

2.2、安装指定版本的包

npm install xxx 命令默认安装最新版本的包。如需安装指定版本的包，在包名后面，==@版本号==

1
npm i 包的完整名称@版本号

3、包管理的配置文件

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

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

多人协作问题

遇到的问题：第三方包的体积过大，不方便团队成员之间共享项目源代码。

解决方案：共享时剔除node_modules

如何记录项目中安装了哪些包

在项目的根目录package.json的配置文件用来记录项目中安装了那些包。从而方便剔除node_modules之后，在团队之间共享项目源代码

在开发中最好包node_modules文件夹添加到**.gitgnore**忽略文件中

快速创建package.json

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

1
npm init -y
  • 上述命令只能在英文目录下成功运行，所以项目的文件夹名称一定要使用英文命名，不能出现空格
  • 运行 npm install 命令安装包的时候 ，npm包管理工具会自动把包的名称和版本号记录到package.json文件中
    • package.json文件的 dependencies节点，专门用来记录你使用npm install命令安装了哪些包
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "name": "test",
    "version": "1.0.0",
    "description": "",
    "main": "index.js",
    "scripts": {
        "test": "echo \"Error: no test specified\" && exit 1"
    },
    "author": "",
    "license": "ISC",
    "dependencies": {
        "bootstrap": "^5.1.3",
        "jquery": "^3.6.0"
    }
}

3.1、一次性安装所有的包

  • 拿到了一个剔除了node_modules 的项目之后，需要先把所有的包下载到项目中才能将项目运行起来。否则会报类似于下面的错误

image-20220428171251653

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

3.2、卸载包

  • 运行 npm uninstall xxx 来卸载指定的包
1
npm uninstall 包名
  • npm uninstall 命令执行成功后，会把卸载的包自动从package.json的dependencies中移出掉

3.3、devDependencies节点

  • 如果某些包只在项目开发阶段会用到，在项目上线之后不会用到，则建议把这些包记录到devDependencies节点中。如果某些包在开发和项目上线之后都需要用到，则建议把这些包记录到dependencies节点中。可以使用如下命令将包记录到devDevpendencies节点中
1
2
3
npm install 包名 --save-dev
或
npm i 包名 -D

4、解决下包的速度慢的问题

4.1、切换npm下载包的镜像源

1
2
3
npm config get registry 	# 查看当前包镜像源
npm config set registry=http://registry.npm.taobao.org/ # 切换源头
npm config get registry 	# 检查镜像源是否下载成功

5、包的分类

使用npm包管理工具下载的包，共分为两大类，分别是

5.1、项目包

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

  1. 开发的依赖包（只在开发期间会用到） npm i 包名 -D
  2. 核心依赖包（开发期间和项目上线之后都会用到）npm i 包名

5.2、全局包

在执行npm install 命令时如果提供了-g参数，则会把包安装为全局包。全局包会被安装在你自己设置的目录下

比如 D:\Program Files (x86)\nodejs\node_global\node_modules

注意

  • 只有工具性质的包，才有全局安装的必要性。可以在终端随意访问
  • 判断某个包是否需要全局安装后才能使用，查看参考文档提供的使用说明即可

5.3、规范包的结构

  • 一个规范的包，它的组成结构，必须符合以下3点要求
    • 包必须以单独的目录存在
    • 包的顶级目录下必须包含package.json这个包管理配置文件
    • package.json中必须包含 name,version,main这三个属性，分别代表包的名字，版本号，包的入口