包管理工具

更新时间: 2024-11-04 17:11:04

# 包管理工具介绍

常用的包管理工具

  • npm
  • yarn
  • cnpm

# npm介绍与安装

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

nodejs在安装时会自动安装npm,所以如果已经安装了nodejs,可以直接使用npm,可以通过npm -v查看版本号,如果显示版本号说明安装成功。

# npm初始化包

创建一个空目录,然后以此目录作为工作目录 启动命令行工具,执行 npm init

npm init 命令作用是将文件初始化为一个包,交互式创建package.json 文件

package.json是包的配置文件,每个包都必须要有package.json

初始化的过程中还有一些注意事项

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

# npm搜索包

搜索包的方式有两种

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

# npm下载安装包

我们可以通过 npm install 和 npm i 命令安装包

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

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

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

// 1. 导入uniq包  
const uniq = require('uniq')  

// 2. 使用函数  
let arr = [1,2,3,4,5,3,4,2,3,2,1]

const result = uniq(arr)

console.log(result)
1
2
3
4
5
6
7
8
9

:::

# require导入npm模块的基本流程

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

# 开发依赖与生产依赖

# 生产环境与开发环境

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

# 生产依赖与开发依赖

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

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

::: success 举个例子方便大家理解,比如说做蛋炒饭需要 大米,油,葱,鸡蛋,锅,煤气,铲子等
其中锅,煤气,铲子属于开发依赖,只在制作阶段使用
而大米,油,葱,鸡蛋属于生产依赖,在制作与最终使用都会用到
所以开发依赖是只在开发阶段使用的依赖包,而生产依赖是开发阶段和最终上线运行阶段都用到的依赖包
:::

# npm全局安装

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

注意

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

# 修改windows执行策略


windows默认不允许npm全局命令执行脚本文件,所以需要修改执行策略

  1. 以管理员身份打开 powershell命令行
  2. 键入命令 set-ExecutionPolicy remoteSigned

# 环境变量Path

Path是操作系统的一个环境变量,可以设置一些文件夹的路径,在当前工作目录下找不到可执行文件时,就会在环境变量Path的目录中挨个的查找,如果找到则执行,如果没有找到就会报错

::: success 补充说明

  • 如果希望某个程序在任何工作目录下都能正常运行,就应该将该程序的所在目录配置到环境变量Path中
  • windows下查找命令所在位置
    • cmd命令行中执行 where nodemon
    • powershell命令行执行 get-command nodemon
      :::

# npm安装包的所有依赖

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

npm i
npm install

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

# npm安装指定版本包与删除包

# 安装指定版本的包

项目中可能会遇到版本不匹配的情况,有时就需要安装指定版本的包,可以使用下面的命令的:
npm i jquery@1.11.2

# 删除依赖

项目中可能需要删除某些不需要的包,可以使用下面的命令

  • 局部删除
    npm remove uniq
    npm r uniq

  • 全局删除
    npm remove -g nodemon

# npm配置命令别名

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

{
    ...
    "script":{
        "sever": "node server.js",
        "start": "node index.js"
    }
    ...
}
1
2
3
4
5
6
7
8

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

npm run server  
npm run start  
1
2

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

::: success 补充说明

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

# cnpm介绍

cnpm 是淘宝构建的 npmjs.com 的完整镜像,也称淘宝镜像,网址 https://npmmirror.com/ (opens new window)

cnpm 服务部署在国内阿里云服务器上,可以提高包的下载速度
官方也提供了一个全局工具包cnpm, 操作命令与npm大体相同

# 安装

我们可以通过npm来安装cnpm工具
npm install -g cnpm --registry=https://registry.npmmirror.com

# 操作命令

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

# npm配置淘宝镜像

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

  • 直接配置
  • 工具配置

# 直接配置

执行如下命令即可完成配置
npm config set registry https://registry.npmmirror.com/

# 工具配置

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

  1. 安装nrm
    npm i -g nrm

  2. 修改镜像
    nrm use taobao

  3. 检查是否配置成功(选做)
    npm config list
    检查registry地址是否为 https://registry.npmmirror.com/, 如果是则表明成功

注意

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

# yarn的介绍与操作

yarn是有Facebook在2016年推出的新的JavaScript包管理工具,官方网址:https://yarnpkg.com/ (opens new window)

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

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

  3. yarn配置淘宝镜像
    可以通过如下命令配置淘宝镜像
    yarn config set registry https://registry.npmmirror.com/

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

# npm与yarn的选择

大家可以根据不同的场景进行选择

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

切记!

包管理工具不要混着用!

# npm发布一个包

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

  1. 创建文件夹,并创建文件index.js,在文件中声明函数,使用module.exports暴露
  2. npm 初始化工具包,package.json 填写包的信息(包的名字是唯一的)
  3. 注册账号 https://www.npmjs.com/signup (opens new window)
  4. 激活账号(一定要激活账号)
  5. 修改为官方的官方镜像(命令行中运行 nrm use npm)
  6. 命令行下 npm login 填写相关用户信息
  7. 命令行下 npm publish 提交包

# npm包的更新与删除

# 更新包

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

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

# 删除包

执行如下命令删除包
npm unpublish

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

  • 你是包的作者
  • 发布小于24小时 如果一定要删 添加 --force
  • 大于24小时后,没有其他包依赖,并且每周小于300下载量,并且只有一个维护者
    :::

# 包管理工具扩展介绍

在很多语言中都有包管理工具,比如:

语言 包管理工具
PHP composer
Pyhton pip
Java maven
Go go mod
JavaScript npm/yarn/cnpm/other
Ruby rubyGems

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

操作系统 包管理工具 网址
Centos yum https://packages.debian.org/stable/ (opens new window)
Ubuntu apt https://packages.ubuntu.com/ (opens new window)
MacOS homebrew https://brew.sh/ (opens new window)
Windows chocolatey https://chocolatey.org/ (opens new window)

# nvm的介绍与使用

nvm 全程 Node Version Manager 顾名思义他是用来管理node版本的工具,方便切换不同版本的Node.js

# 下载安装

首先下载nvm,下载地址https://github.com/coreybutler/nvm-windows/releases (opens new window)
选择nvm-setup.exe下载即可

# 常用命令

命令 说明
nvm list available 显示所有可以下载的Node.js版本
nvm list 显示已安装的版本
nvm install 18.12.1 安装18.12.1版本的Node.js
nvm install latest 安装最新版的Node.js
nvm uninstall 18.12.1 删除某个版本的Node.js
nvm use 18.12.1 切换18.12.1的Node.js