Node.js--npm&yarn包管理工具

一、概念介绍

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

  • 可以通过npm -v查看版本号测试

2.2 npm基本使用

2.2.1 初始化

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

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

  • 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" #开源证书
}

  • 初始化的注意事项：

    • package.json(包名)不能使用中文、大写，默认值是`文件夹的名称`,所以文件夹名称也不能使用中文和大写

    • version(`版本号`)要求x.x.x的形式定义，x必须是数字，默认值1.0.0

    • ISC证书与MIT证书功能上是相同的，关于开源证书扩展阅读 http://www.ruanyifeng.com/blog/2011/05/how_to_choose_free_software_licenses.html

    • 使用npm init -y 或者npm init --yes极速创建package.json

2.2.2 搜索包

搜索包的方式有两种

  1. 命令行’npm s/search 关键字’

  2. 网站搜索，网址是https://www.npmjs.com

2.2.3 下载安装包

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

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

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

  • node_modules 文件夹：存放下载的包

  • package-lock.json 包的锁文件：用来锁定包的版本

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

2.2.4 require导入npm包基本流程

  1. 在当前文件夹下node_modules中寻找同名的文件夹

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

2.3 生产环境与开发环境

  • 开发环境是程序员专门用来写代码的环境，一般是指程序员的电脑，开发环境的项目一般只能由程序员自己访问

  • 生产环境是项目代码正式运行的环境，一般是指正式的服务器电脑，生产环境的项目一般每个客户都可以访问

2.4 生产依赖与开发依赖

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

  1. 生产依赖，命令：npm i -S uniq npm i --save uniq
    -S 等效于 --save, -S 是默认选项 包信息保存在package.json中的dependencies属性

  2. 开发依赖，命令：npm i -D less
    -D等效于-save-dev包信息保存在package.json中devDependencies

2.5 全局安装

执行安装选项-g进行全局安装

npm i -g nodemon

全局安装完成之后可以在命令行的任何位置运行nodemon命令

该命令的作用是自动重启 node 应用程序

2.5.1 修改windows执行策略

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

  1. 以管理员身份打开powershell命令行

  2. 键入命令set-executionPolicy remoteSigned

  3. 键入A然后敲回车

  4. 如果不生效，可以尝试重启vscode

2.5.2 环境变量 Path

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

  • 如果希望某个程序在任何工作目录下都能正常运行，就应该就该程序的所在目录配置到环境变量path

  • sindows下查找命令的所在位置

    • cmd 命令行中执行where nodemon

    • powershell命令行执行get-command nodemon

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中的script属性

{
	.
	.
	.
	"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的完整镜像，也称为’淘宝镜像’，网址https://npmmirror.com/

  • cnpm 服务部署在国内阿里云服务器上，可以提高包的下载速度

  • 官方也提供了一个全局工具包cnpm，操作命令与npm大体相同

3.2 安装

可以通过npm来安装cnpm工具

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

3.3 操作命令

  1. 初始化：cnpm init/cnpm init

  2. 安装包：

    1. cnpm i uniq

    2. cnpm i-S uniq

    3. cnpm i -D uniq

    4. cnpm i -g nodemon

  3. 安装项目依赖：cnpm i

  4. 删除：cnpm r uniq

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地址是否为https://registry.npmmirror.com/，如果是则表明成功

  • 建议使用第二种方式进行镜像配置，因为后续修改起来会比较方便

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

四、yarn

4.1 yarn介绍

yarn是由Facebook在2016年推出的心得JavaScript包管理工具，官方网址：https://yarnpkg.com/

4.2 yarn特点

  • 速度超过：yarn缓存了每个下载过的包，所以再次使用时无需重复下载。同时利用并行下载以最大化资源利用率，因此安装速度更快

  • 超级安全：在执行代码之前，yarn会通过算法校验每个安装包的完整性

  • 超级可靠：使用详细、简洁的锁文件格式和明确的安装算法，yarn能够保证系统上无差异的工作

4.3 yarn安装

可以使用npm安装yarn

npm i -g yarn

4.4 yarn常用命令

  1. 初始化：yarn init / yarn init -y

  2. 安装包：

    1. yarn add uniq 生产依赖

    2. yarn add less --dev 开发依赖

    3. yarn global add nodemon 全局安装

  3. 删除包：

    1. yarn remove uniq 删除项目依赖包

    2. yarn global remove nodemon 全局删除包

4.5 yarn配置淘宝镜像

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

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

4.6 npm和yarn选择

根据不同的场景进行选择

  1. 个人项目

    1. 根据自己的喜好

  2. 公司项目

    1. 可以通过锁文件判断项目的包管理工具

      1. npm的锁文件为package-lock.json

      2. yarn的锁文件为yarn.lock

包管理工具不要混着用

五、管理发布包

5.1 创建与发布

将自己开发的工具包上传到npm服务上，操作步骤如下：

  1. 创建文件夹，并创建文件index.js，在文件中声明函数，使用module.exports暴露

  2. npm初始化工具包，package.json填写包的信息（包的名字是唯一的）

  3. 注册账号https://www.npmjs.com/signup

  4. 激活账号(一定要激活账户)

  5. 修改为官方的官方镜像(命令行中运行nrm use npm)

  6. 命令行下npm login填写相关用户信息

  7. 命令行下npm publish提交包

5.2 更新包

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

  1. 更新包中的代码

  2. 测试代码是否可用

  3. 修改package.json中的版本号

  4. 发布更新：npm publish

5.3 删除包

npm unpublish --force

  • 删除包需要满足一定的条件，https://docs.npmjs.com/policies/unpublish

    • 你是包的作者

    • 发布小于24小时

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

Node.js--npm&yarn包管理工具
http://localhost:8090//archives/node.js--npm-yarnbao-guan-li-gong-ju
作者
文希希
发布于
2024年12月15日
许可协议