Node的包管理器
JavaScript缺少包结构的定义,而CommonJS定义了一系列的规范。而NPM的出现则是为了在CommonJS规范的基础上,实现解决包的安装卸载,依赖管理,版本管理等问题。
CommonJS是一个致力于构建统一的JS生态系统,它可以兼容web服务器、桌面应用、命令行应用、浏览器等。它定义了各种开发的规范和API不仅仅模块化相关的规范)
官网的说明: a group with a goal of building up the JavaScript ecosystem for web servers, desktop and command line apps and in the browser.
CommonJS的模块主要如下:
- binary: Binary Data Objects (byte arrays and/or strings) (proposals, discussion, early implementations)
- encodings: Encodings and character sets (proposals, discussion, early implementations)
- io: I/O Streams (proposals, discussion)
- fs, fs-base: Filesystem (proposals, discussion, early implementations)
- system: System Interface (stdin, stdout, stderr, &c) (1.0, amendments proposed)
- assert, test: Unit Testing (1.0, amendment proposals pending)
- sockets: Socket I/O TCP/IP sockets (early proposals)
- event-queue: Reactor Reactor/Event Queue (early proposals)
- worker: Worker Worker (concurrent shared nothing process/thread) (proposal)
- console: console (proposal)
包结构
一个符合CommonJS规范的包应该是如下这种结构:
- 一个package.json文件应该存在于包顶级目录下
- 二进制文件应该包含在bin目录下。
- JavaScript代码应该包含在lib目录下。
- 文档应该在doc目录下。
- 单元测试应该在test目录下。
package.json 说明
package.json文件就是当前项目或者包(js模块、组件)的配置文件,所有当前项目的依赖的第三方模块,当前项目的配置等都定义在package.json文件中,当前它有一定的规范,我们可以通过npm命令初始化和创建package.json文件。
创建package.json文件步骤:
# 打开命令行,确保您已经安装好了node
mkdir demos
cd demos
# 初始化当前项目的package.json文件,-y表示默认参数。
npm init -y
######当前demos目录下就会增加一个package.json文件,内容如下:###### { "name": "demos", // 项目名称 "version": "1.0.0", // 项目的版本号 "description": "", // 项目描述 "main": "index.js", // 引用目录模块的入口文件 "scripts": { // 可以通过npm运行的shell命令脚本 "test": "echo \"Error: no test specified\" && exit 1" // 可以通过npm run test 启动 }, "keywords": [], // 项目的关键词 "author": "", // 作者,一般可以写上邮箱 "license": "ISC" // 当前项目或者包的开源协议 }
package.json文件说明:
-
name。包名,需要在NPM上是唯一的。不能带有空格。
-
description。包简介。通常会显示在一些列表中。
-
version。版本号。一个语义化的版本号(http://semver.org/ ),通常为x.y.z。
- x(Major): 主版本号:当你做了不兼容的 API 修改,一般一个比较完整大改版,需要修改x(一般增加1)
- y(Minor): 次版本号:当你做了向下兼容的功能性新增
- z(Patch): 修订号:当你做了向下兼容的问题修正。
- 其他参考中文翻译
-
keywords。关键字数组。用于NPM中的分类搜索。
-
maintainers。包维护者的数组。数组元素是一个包含name、email、web三个属性的JSON对象。
-
contributors。包贡献者的数组。第一个就是包的作者本人。在开源社区,如果提交的patch被merge进master分支的话,就应当加上这个贡献patch的人。格式包含name和email。如:
"contributors": [{ "name": "Jackson Tian", "email": "mail @gmail.com" }, { "name": "fengmk2", "email": "mail2@gmail.com" }],
-
bugs。一个可以提交bug的URL地址。可以是邮件地址(mailto:mailxx@domain),也可以是网页地址(http://url)。
-
licenses。包所使用的许可证。
-
repositories。托管源代码的地址数组。
-
dependencies。当前包需要的依赖。这个属性十分重要,NPM会通过这个属性,帮你自动加载依赖的包。
参考一个express框架的的包配置文件:
// 以下包,并不是完整的,我截取了部分内容。
{
"name": "express",
"description": "Fast, unopinionated, minimalist web framework", "version": "4.16.3", "author": "TJ Holowaychuk <tj@vision-media.ca>", "contributors": [ "Aaron Heckmann <aaron.heckmann+github@gmail.com>", "Ciaran Jessup <ciaranj@gmail.com>", ], "license": "MIT", "repository": "expressjs/express", "homepage": "http://expressjs.com/", "keywords": [ "express", "framework", ], "dependencies": { "accepts": "~1.3.5", "array-flatten": "1.1.1", "statuses": "~1.4.0", "type-is": "~1.6.16", "utils-merge": "1.0.1", "vary": "~1.1.2" }, "devDependencies": { "after": "0.8.2", "cookie-parser": "~1.4.3", "cookie-session": "1.3.2", "ejs": "2.5.7", "connect-redis": "~2.4.1", "vhost": "~3.0.2" }, "engines": { "node": ">= 0.10.0" }, "files": [ "LICENSE", "History.md", "Readme.md", "index.js", "lib/" ], "scripts": { "lint": "eslint .", "test": "mocha --require test/support/env --reporter spec --bail --check-leaks --no-exit test/ test/acceptance/", } }
npm进行包管理
npm(node package manager)本来是Node.js的包管理工具,但随着JS这几年的蓬勃发展, npm已经不再局限于node平台,尤其是Webpack的广泛应用,前端包管理基本由npm统一管理了。
npm相关学习资源:
- npm[官网(https://www.npmjs.com/)
- npm中文文档
npm安装本地包
安装第三方包到本地,只需要打开命令行,通过cd命令进入我们项目的根目录(确保您之前已经初始化了package.json文件)。
然后执行npm的install命令,如下:
语法:npm install <package> --save-prod
$ cd demos
$ npm install lodash --save-prod # 输出如下: npm notice created a lockfile as package-lock.json. You should commit this file. + lodash@4.17.5 # 有个+号,代表安装当前。 added 1 package in 1.091s # 这里告诉我们天津一个包用了1.091秒
解释:
install
: 代表安装第三方包的意思,可以直接用i
代替。--save-prod
: 代表把当前安装包的配置写入到当前package.json文件中, 可以用-P
代替。
我们项目文件夹会有两个变化:第一个就是增加了package.json文件和node_modeules文件夹
以下是package.json的增加的内容
{
"name": "demos",
"version": "1.0.0", "description": "", "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "keywords": [], "author": "", "license": "ISC", + "dependencies": { // 增加 + "lodash": "^4.17.5" // 增加lodash的安装包 + } // 增加 }
node_modeules文件夹存放我们刚刚安装包的文件。
命令简写的形式:
$ npm install lodash --save-prod
$ npm i lodash -P
################################################## ## 老版本中 --save 或者 -S,现在还支持,但建议用-P代替## ################################################## $ npm i lodash -S $ npm install lodash --save
安装开发阶段依赖的本地包
有时候我们需要一些第三方的包,仅仅在开发阶段依赖,则需要把npm的install命令添加--save-dev
参数。
例如,我们开发阶段需要用gulp进行打包,则需要安装gulp包。
$ npm install gulp --save-dev
# 以下是简写形式, -D === --save-dev
$ npm i gulp -D
开发依赖,会在package.json文件的devDependencies下添加安装包的配置。如下所示:
{
"name": "demos",
"version": "1.0.0",
"description": "", "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "keywords": [], "author": "", "license": "ISC", "dependencies": { "lodash": "^4.17.5" }, + "devDependencies": { + "gulp": "^3.9.1" + } }
自动根据配置package.json文件下载安装依赖的包
package.json文件可以帮我们进行包的管理和配置,如果在项目根目录下直接运行npm install
,npm会自动的根据package.json文件中的dependencies
和devDependencies
中配置的第三方包进行安装。这尤其是在团队开发和项目部署时非常有用。
只需要: npm i
package.json文件中对模块的依赖可以使用~、^、*
来控制。
~
: 安装兼容模块新发布的补丁版本,也就是说主版本号和次版本号不能变,最后一位修改号(补丁)可变化。例如:~1.1.0^
: (默认)主版本号不能变,后面两个版本可变,兼容模块新发布的次版本、补丁版本:^1.1.0*
: 兼容模块新发布的大版本、小版本、补丁版本:任何版本都可以。
设置国内镜像
npm安装的包的时候,先检查本地是否有缓存,如果最近刚安装过,而且本地有缓存的话,直接用缓存。如果没有缓存会到npm的在线仓库下载并安装。默认的仓库地址:https://registry.npmjs.org/.
但是由于服务器在国外,而且国内你懂得,有时候下载比较大点的第三方包会非常慢,而且经常断掉。建议使用国内比较稳定快速的镜像,比如淘宝的npm镜像。
设置npm下载包的镜像为淘宝的镜像,设置方式:
打开终端(windows下请使用powershell)
# 设置淘宝镜像
$ npm config set registry https://registry.npm.taobao.org # 验证是否配置成功 $ npm config get registry # 输出如下则表示成功: https://registry.npm.taobao.org/
另外一种办法:用cnpm替代npm。
# 首先安装cnpm:
$ npm install -g cnpm --registry=https://registry.npm.taobao.org
# 使用 $ cnpm install expresstall express
控制安装的版本号
我们通过npm安装第三方包的时候,可以指定安装的具体版本,在包的后面添加一个@符号和具体版本号就可以了。
# 安装0.1.1版本的sax
$ npm install sax@0.1.1
# 安装最新的sax $ npm install sax@latest # 还可以指定范围 $ npm install sax@">=0.1.0 <0.2.0"
安装全局依赖的包
有些包不仅仅需要我们本地开发运行时依赖,有时候也需要我们在命令行的任意位子启动和使用第三方包,那么就需要进行全局安装。
语法: npm install -g <package>
比如,gulp我们有时候在任何一点地方都可能用到gulp命令工具,则需要全局安装gulp。
$ npm install gulp --global
# 简写
$ npm i -g gulp # 安装成功后,我们就可以随时随地都可以运行gulp命令了 $ gulp -v
更新安装包
更新本地的安装包:在 package.json 文件所在的目录中执行 npm update
命令。
更新全局的安装包:
$ npm update -g jshint
卸载安装包
卸载本地安装包
$ npm uninstall --save-prod lodash
# 简写
$ npm un -P lodash
卸载全局安装包
$ npm uninstall -g lodash
其他npm常用命令
更新升级npm
$ npm i npm
罗列出当前安装的所有的包
$ npm list
# 控制列出所有包的目录层级 --depth 控制层级
$ npm list --depth=0 # 可以用ls 替代 list $ npm ls --depth=1 # 罗列全局的安装的包 $ npm -g list --depth=0 # 以下是我的安装的包 /usr/local/lib ├── autoprefixer@7.2.3 ├── babel-cli@6.18.0 ├── bower@1.8.2 ├── create-react-app@1.0.2 ├── egg-init@1.9.0 ├── eslint@3.12.2 ├── generator-keystone@0.5.1 ├── grunt-cli@1.2.0 ├── gulp@3.9.1 ├── json-server@0.12.1 ├── live-server@1.2.0 ├── n@2.1.5 ├── nodemon@1.11.0 ├── npm@5.6.0 ├── npm-check@5.4.0 ├── npm-check-updates@2.8.8 ├── parcel-bundler@1.4.1 ├── sails@0.12.13 ├── static-server@2.0.5 ├── typescript@2.2.1 ├── vue-cli@2.9.3 ├── vue-migration-helper@1.1.1 ├── UNMET PEER DEPENDENCY webpack@>=1.3.0 <3 ├── webpack-dev-server@1.16.2 └── yo@1.8.5
npm后续
- 发布npm包
npm不仅仅可以帮助我们进行安装第三包,我们也可以自己发布一个包,供全世界的开发人员使用。
这块内容可以,查看官网的npm publish部分。
- npm scripts 使用
我们可以通过npm编写一些使用频率非常高的:打包、运行测试、运行部署等shell命令到package.json文件的 scripts配置节点,方便我们执行一些复杂的重复性很高的任务。
具体学习:请移步阮一峰老师的教程。
以下只是简单介绍一下原理和使用:
npm 脚本的原理非常简单。每当执行npm run,就会自动新建一个 Shell,在这个 Shell 里面执行指定的脚本命令。因此,只要是 Shell(一般是 Bash)可以运行的命令,就可以写在 npm 脚本里面。
比如:
// package.json文件
{
// ...
"scripts": {
"dev": "gulp dev" // 通过npm run dev 可以直接在shell中执行gulp dev命令。 } }
在scripts中定义的脚本,我们可以直接通过npm run <keyname>
运行,跟在shell中运行一样。
常见的一般使用技巧:
// package.json文件
{
// ...
"scripts": {
"dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
"start": "npm run dev",
"unit": "cross-env BABEL_ENV=test karma start test/unit/karma.conf.js --single-run",
"test": "npm run unit",
"lint": "eslint --ext .js,.vue src test/unit",
"build": "node build/build.js"
}
}
# 以下是执行对应的任务
npm run build # 运行打包任务
npm run dist # 运行生成dist目录文件的命令
npm run dev # 运行开发调试
npm run test # 运行测试
# 以下有几个内置的可以简写:
npm start # => npm run start
npm stop # => npm run stop的简写
npm test # => npm run test的简写
yarn 是npm之外的另一种选择
yarn是Facebook出的一款替代npm的包管理工具,npm的功能它都有对应,而且使用方法也都很相似。那为什么Facebook再造一个重复的轮子呢?
在yarn之前的npm版本的问题:(当然部分问题已经修复)
- npm 安装包(packages)的速度不够快,是顺序下载,不是并行。
- 拉取的 packages 可能版本不同(最新的版本已经可以把版本锁住:package-lock.json)
- npm 允许在安装 packages 时执行代码,这就埋下了安全隐患
yarn能兼容npm的配置文件package.json,使用方式也非常接近npm,所以我们可以基本上无缝从npm迁移到yarn。而且yarn的确的确够快、够稳定、够优秀。yarn的优点:
- 速度快:Yarn 缓存了每个下载过的包,所以再次使用时无需重复下载。 同时利用并行下载以最大化资源利用率,因此安装速度更快。并行下载安装包,速度真的是杠杠的。
- 比较安全:在执行代码之前,Yarn 会通过算法校验每个安装包的完整性。
- 可靠:使用详细、简洁的锁文件格式和明确的安装算法,Yarn 能够保证在不同系统上无差异的工作。
- 不管安装顺序如何,相同的依赖关系将在每台机器上以相同的方式安装。
- 将依赖包的不同版本归结为单个版本,以避免创建多个副本。
- 重试机制确保单个请求失败并不会导致整个安装失败。
yarn的安装
mac下安装:
brew install yarn
windows安装:直接下载安装包。
测试是否安装成功:
yarn --version
# 以下输出的是yarn的版本号,笔者的是如下,你的可能跟我不一样。
0.24.5
npm和yarn的cli差异
以下只是简单介绍一下yarn的使用方法:
初始化一个新的项目
yarn init
# 对应npm
npm init
添加一个依赖包
yarn add [package]
yarn add [package]@[version]
yarn add [package]@[tag]
# 对应npm
npm install [package]
更新一个依赖包
yarn upgrade [package]
yarn upgrade [package]@[version]
yarn upgrade [package]@[tag]
# 对应npm
npm update [package]
删除一个依赖包
yarn remove [package]
# 对应npm
npm uninstall [package]
安装所有的依赖包
yarn
or
yarn install
# 对应npm
npm install
全局安装依赖包
yarn global add [package]
npm i [package] -g
yarn global remove [package]
npm un [package] -g
yarn upgrade [package]
npm update [package]
注意:yarn全局安装了一些命令包之后,可能全局范围内不能访问,这时候需要把yarn的全局的bin目录加入到操作系统的环境变量中。
# 查看yarn的全局bin目录
yarn global bin
# 输出(mac下)
/usr/local/Cellar/node/9.9.0/bin
总结
至此,我们已经基本掌握了nodejs的包管理、包加载机制等基本原理,后面就是我们怎么应用他们进行开发了。
参考: