JZTXT

Nodejs包管理工具

发布时间 2023-06-29 21:55:42作者: wdszh

Nodejs包管理工具

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

包管理工具可以对「包」进行下载安装，更新，删除，上传等操作，借助包管理工具，可以快速开发项目，提升开发效率
包管理工具是一个通用的概念，很多编程语言都有包管理工具，所以掌握好包管理工具非常重要
有了模块化之后我没就有许多的包，那么包管理工具就是来管理我没这些包

常用的包管理工具

  • npm
  • yarn
  • cnpm

npm

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

npm的安装

node.js在安装时会自动安装 npm，所以如果你已经安装了node.js可以直接使用npm

参考: Nodejs介绍与安装

npm基本使用

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

package.json内容示例：

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

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

  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

搜索包

搜索包的方式有两种

  1. 命令行 npm s/search 关键字
  2. 网站搜索npmjs官网

下载安装包

通过npm install或npm i命令安装包

# 格式
npm install <包名>
npm i <包名>

# 示例
npm install uniq
npm i uniq

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

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

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

require导入npm包基本流程

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

生产依赖与开发依赖

开发依赖是只在开发阶段使用的依赖包，而生产依赖是开发阶段和最终上线运行阶段都用到的依赖包

我们可以在安装时设置选项来区分依赖的类型

  • 生产依赖

    # -S 等效于 --save， -S 是默认选项
# 包信息保存在package.json中dependencies属性
# 比如安装 uniq
npm i -S uniq
# 或者
npm i --save uniq

  • 开发依赖

    # -D 等效于 --save-dev
# 包信息保存在package.json中devDependencies属性

npm i -D less
# 或者
npm i --save-dev less

全局安装

我们可以执行安装选项-g进行全局安装

# 比如全局安装nodemon
npm i -g nodemon

# 启动node应用
# nodemon [your node app]
nodemon index.js

全局安装完成之后就可以在命令行的任何位置运行nodemon命令
该命令的作用是修改js文件后自动重启node应用程序

说明：

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

安装包依赖

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

npm i
npm install

node_modules文件夹不会存入版本库(git、svn)

安装指定版本的包

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

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

删除依赖

## 当前项目删除
npm remove uniq
npm r uniq

## 全局删除
npm remove -g nodemon

配置命令别名

通过配置命令别名可以更简单的执行命令

配置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有自动向上级目录查找的特性(查找上级目录的package.json)，跟require函数也一样
  • 对于陌生的项目，我们可以通过查看scripts属性来参考项目的一些操作

npm管理工具

nrm(npm registry manager): 用来管理npm的仓库地址

# 安装 nrm
npm i -g nrm

# 修改镜像
nrm use taobao

# 检查是否配置成功
npm config list

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

cnpm

介绍

  • cnpm是一个淘宝构建的npmjs.com的完整镜像（只读的），也称为『淘宝镜像』
  • cnpm服务部署在国内阿里云服务器上，可以提高包的下载速度
  • 官方也提供了一个全局工具包cnpm，操作命令与npm大体相同

安装

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

使用cnpm全局安装的一些cli命令，必须将其配置到环境变量中否则无法在其它任意位置使用命令

操作命令

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

虽然cnpm可以提高速度，但是npm也可以通过淘宝镜像进行加速，所以npm的使用率还是高于cnpm

yarn

yarn介绍

yarn是由Facebook在2016年推出的新的Javascript包管理工具，官方网址

yarn特点

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

yarn安装

# 使用npm安装yarn
npm i -g yarn

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

全局安装的包不可用(比如一些cli命令)，yarn全局安装包的位置可以通过 yarn global bin来查看，然后将其配置到环境变量中

yarn配置淘宝镜像

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

# 查看 yarn 的配置项是否生效
yarn config list

npm和yarn选择

  • 新项目，哪个工具都可以，可以根据自己的喜好来选择
  • 已经存在的项目，用已有的。可以通过锁文件判断项目的包管理工具
    • npm的锁文件为package-lock.json
    • yarn的锁文件为yarn.lock

包管理工具不要混着用（混用会出问题），切记，切记，切记

管理发布包

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

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

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

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

删除包 npm unpublish --force

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

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