Node.js - 包管理工具

98 阅读8分钟

一、概念

1.1 包是什么

包英文单词是 package , 代表了一组特定功能的源码集合

1.2 包管理工具

管理包的应用软件,可以对包进行下载、更新、删除、上传 等操作
借助包管理工具,可以快速开发项目,提升开发效率
包管理工具是一个通用的概念,很多编程语言都有包管理工具,所以掌握好包管理工具非常重要

1.3 常用的包管理工具

  • npm
  • yarn
  • cnpm

二、npm

npm 全称 Node Package Manager ,翻译为中文意思为【 Node 的包管理工具】 npm 是 node.js 官方内置的包管理工具,是必须要掌握的工具

2.1 npm 的安装

node.js 中安装时会自动安装 npm, 所以如果已经安装了node.js,可以直接使用npm
可以通过 npm -v 查看版本号测试,如果显示版本号说明安装成功,反之安装失败
image.png

2.2 npm基本使用

2.2.1 初始化

创建一个空目录,然后以此目录作为工作目录启动命令行工具,执行npm init
(vscode终端截图)⬇️ image-1.png npm init 命令的作用是将文件夹初始化为一个包,交互式创建 package.json 文件
package.json 是包的配置文件,每个包都必须要有 package.json package.json 内容示例:

{
  "name": "package", // 包的名字
  "version": "1.0.0", // 包的版本
  "description": "",  // 包的描述
  "main": "index.js", // 包的入口文件
  "scripts": { // 脚本配置
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "", // 作者
  "license": "ISC" // 开源证书
}

初始化过程注意事项:

  • package name (包名)不能使用中文、大写,默认值是文件夹的名称,所以文件夹名称也不能使用中文和大写
  • version (版本号)要求x.x.x的形式定义,x必须是数字,默认值是1.0.0
  • ISC 证书与 MIT证书功能上是相同的
  • package.json 可以手动创建与修改
  • 使用 npm init -y 或者 npm init --yes 极速创建package.json

2.2.2 搜索包

搜索包的方式有两种

  1. 命令行 npm s/search 关键字
  2. 网站搜索 网址是 https://www.npmjs.com/

2.2.3 下载安装包

通过 npm installnpm i 命令安装包

## 格式
npm install <包名>
npm i <包名>
## 示例
npm install uniq
npm i uniq

使用这个包

// 使用uniq
// 1、导入 uniq 包
const uniq = require('uniq');

// 2、使用函数
let arr = [1, 2, 3, 4, 54, 1, 2, 4, 6];

console.log(uniq(arr)); // [ 1, 2, 3, 4, 54, 6 ]

运行后文件夹下会增加两个资源

  • node_modules 文件夹存放下载的包
  • package-lock 包的锁文件,用来锁定包的版本号

安装 uniq 之后,uniq 就是当前这个包的一个依赖包,简称为依赖
比如我们创建一个包的名字为A,A中安装了包名字是B,我们就说B是A的一个依赖包,也会说A依赖B

2.2.4 require导入npm包基本流程

  1. 在当前文件夹下 node_modules 中寻找同名的文件夹
  2. 中上级目录下的 node_modules 中寻找同名的文件夹,直到找到磁盘根目录

2.3 生产环境与开发环境

开发环境是程序员专门用来写代码的环境,一般是指程序员的电脑,开发环境的项目一般只能程序员自己访问
生产环境是项目代码正式运行的环境,一般是指正式的服务器电脑,生产环境一般每个客户都可以访问

2.4 生产依赖与开发依赖

可以在安装时设置选项来区分依赖的类型,目前分为两类:

类型命令补充
生产依赖npm i -S uniq
npm i --save uniq
-S等效于 --save ,-S是默认选项
包信息保存在 package.json 中 dependencies 属性
开发依赖npm i -D less
npm i --save-dev less
-D 等效于 --save-dev
包信息保存在 package.json 中 devDependencies 属性

2.5 全局安装

执行安装选项 -g 进行全局安装 npm i -g nodemon 全局安装完成之后就可以在命令行的任意位置运行 nodemon 命令 该命令的作用是 自动重启 node 应用程序

说明:

  • 全局安装的命令不受工作目录位置影响
  • 可以通过 npm root -g 查看全局安装包的位置
  • 不是所有的包都适合全局安装,只有全局类的工具才适合,可以通过查看包的官方文档来确定安装方式

2.6 安装包依赖

项目协作中有一个常用的命令就是npm i,通过该命令可以依据 package.json 和 package-lock.json 的依赖声明安装项目依赖

npm i
npm install

node_modules 文件夹大多数情况都不会存入版本库

2.7 安装指定版本的包

在项目中遇到版本不匹配的情况时,就需要安装指定版本的包

## 格式
npm i <包名@版本号>
## 示例
npm i jquery@1.11.2

2.8 删除依赖

项目中可能需要删除某些不需要的包

## 局部删除
npm remove uniq
npm r uniq
## 全局删除
npm remove -g nodemon

2.9 配置命名别名

通过配置命名别名可以更简单的执行命令 配置 package.json 中的 scripts 属性

  "scripts": {
    "server": "node server.js",
    "start": "node index.js",
  },

配置完成后可以使用别名执行命令

npm run server
npm run start

start 别名比较特别,使用时可以省略run

npm start

补充说明:

  • npm start是项目中常用的一个命令,一般用来启动项目
  • npm run有自动向上级目录查找到特性,跟require函数一样
  • 对于陌生的项目,可以通过查看 scripts 属性来参考项目的一些操作

三、cnpm

3.1 介绍

cnpm 是淘宝构建的 npmjs.com 的完整镜像,也称为淘宝镜像,网址 npmmirror.com/
cnpm 服务部署在国内阿里云服务器上,可以提高包的下载速度
官方也提供了一个全局工具包 cnpm,操作命令与npm大致相同

3.2 安装

可以通过npm来安装cnpm工具

npm install -g cnpm --registry=https://registry.npmmirror.com

3.3 操作命令

功能命令
初始化cnpm init
安装包cnpm i uniq
cnpm i -S uniq
cnpm i -D uniq
cnpm i -g nodemon
安装项目依赖cnpm i
删除cnpm r unig

3.4 npm配置淘宝镜像

用npm也可以使用淘宝镜像,配置方式有两种

  • 直接配置
  • 工具配置

3.4.1 直接配置

执行命令即可完成配置

npm config set registry https://registry.npmmirror.com/

3.4.2 工具配置

使用 nrm 配置 npm 的镜像地址 npm registry manager

  1. 安装nrm
npm i -g nrm

2. 修改镜像

nrm use taobao

3. 检查是否配置成功(选做)

npm config list

检查registry地址是否为 registry.npmmirror.com/,如果是则表明成功

补充说明:

  • 建议使用第二种方式进行镜像配置,因为后续修改起来会比较方便
  • 虽然cnpm 可以提高速度,但是 npm 也可以通过淘宝镜像进行加速,所以npm的使用率还是高于cnpm

四、yarn

4.1 yarn介绍

yarn是由 Facebook 在2016年推出的新的javascript包管理工具,官方地址:yarnpkg.com/

4.2 yarn 特点

yarn 官方宣称的一些特点

  • 速度超快:yarn 缓存了每个下载过的包,所以再次使用时无需重复下载。同时利用并行下载以最大化资源利用率,因此安装速度更快
  • 超级安全:在执行代码之前,yarn会通过算法校验每个安装包的完整性
  • 超级可靠:使用详细、简洁的锁文件格式和明确的安装算法,yarn能够保证在不同系统上无差异的工作

4.3 yarn安装

可以通过npm来安装yarn

npm i -g yarn

4.4 常用命令

功能命令
初始化yarn init / yarn init -y
安装包yarn add uniq
yarn add less --dev
yarn global add nodemon
生产依赖
开发依赖
全局安装
删除yarn remove unig
yarn global remove nodemon
删除项目依赖包
全局删除包
安装项目依赖yarn
运行命令别名yarn <别名>#不需要添加run

4.5 yarn配置淘宝镜像

yarn config set registry https://registry.npmmirror.com/

可以通过yarn config list 来查看yarn的配置项

4.6 npm 和 yarn 选择

根据不同的场景进行选择

  1. 个人项目 如果是个人项目,哪个工具都可以,可以根据自己的喜好来选择
  2. 公司项目 如果是公司要根据项目代码来选择,可以通过锁文件判断项目的包管理工具
  • npm 的锁文件为 package-lock.json
  • yarn 的锁文件为yarn.lock

包管理工具不要混着用!!!

五、管理发布包

5.1 创建与发布

可以将自己开发的工具包发布到npm服务上,方便自己和其他开发者使用,操作步骤:

  1. 创建文件夹,并创建文件index.js,在文件中声明函数,使用 module.exports 暴露
  2. npm初始化工具包,package.json 填写包信息(包的名字是唯一的)
  3. 注册账号 www.npmjs.com/signup
  4. 激活账号(一定要激活账号)
  5. 如果使用了淘宝镜像,要修改为官方镜像(命令执行nrm use npm,可以通过 npm config list 查看registry地址是否为官方地址)
  6. 命令行下 npm login 填写相关用户信息
  7. 命令行下 npm publish 提交包

5.2 更新包

后续可以对自己发布的包进行更新,操作步骤:

  1. 更新包中的代码
  2. 检查代码是否可用
  3. 修改 package.json 中的版本号
  4. 发布更新 npm publish

5.3 删除包

npm unpublish

删除包需要满足一定的条件

  • 你是包的作者
  • 发布小于24小时
  • 大于24小时后,没有其他包依赖,并且每周小于300下载量,并且只有一个维护者

六、扩展

很多语言都有包管理工具

语言包管理工具
PHPcomposer
Pythonpip
Javamaven
Gogo mod
JavaScriptnpm/yarn/cnpm/other
RubyrubyGems

除了编程语言领域有包管理工具之外,操作系统层面也存在包管理工具,不过这个包指的是软件包

操作系统包管理工具网址
Centosyumpackages.debian.org/stable/
Ubuntuaptpackages.ubuntu.com/
MacOShomebrewbrew.sh/
Windowschocolateychocolatey.org/