目录
模块化的基本概念
Node.js中模块化
Node.js 中模块的分类
加载模块
Node.js 中的模块作用域
模块作用域
向外共享模块作用域中的成员
Node.js 中的模块化规范
npm与包
在项目中安装包
包的语义化版本规范
包管理配置文件
1.如何记录项目中安装了哪些包
2.快速创建 package.json
3.dependencies节点
4.一次性安装所有的包
5.卸载包
6.devDependencies节点
解决下包速度慢的问题
切换npm 的下包镜像源
包的分类
项目包
全局包
i5ting_toc
规范的包结构
开发自己的包并发布
模块的加载机制
优先从缓存中加载
内置模块的加载机制
自定义模块的加载机制
第三方模块的加载机制
目录作为模块
模块化的基本概念
模块化是指解决一个复杂问题时,自顶向下逐层把系统划分成若干模块的过程。对于整个系统来说,模块是可组合、分解和更换的单元。
Node.js中模块化
Node.js 中模块的分类
Node.js中根据模块来源的不同,将模块分为了3 大类,分别是:
-
内置模块(内置模块是由Node.js官方提供的,例如fs、path、http等)
-
自定义模块(用户创建的每个.js文件,都是自定义模块)
-
第三方模块(由第三方开发出来的模块,并非官方提供的内置模块,也不是用户创建的自定义模块,使用前需要先下载)
加载模块
//1.加载内置的fs模块
const fs = require('fs')
//2.加载用户自定义模块
const custom = require('./custom.js')
//3.加载第三方模块
const moment = require('moment')
//使用require()方法加载模块时,会执行被加载模块的代码
Node.js 中的模块作用域
模块作用域
和函数作用域类似,在自定义模块中定义的变量、方法等成员,只能在当前模块内被访问,这种模块级别的访问限制,叫做模块作用域。
我们在08模块中我们定义了一个username和函数sayHello,在09中加载了08模块,并在终端中执行09,可以看到的是在执行后我们并不能访问到08中的成员,只是给我们打印出一个空对象{},而这个空对象就是自定义模板中的module.exports{}
向外共享模块作用域中的成员
1.module对象
在每个 .js自定义模块中都有一个module对象,它里面存储了和当前模块有关的信息
在module对象中exports的属性值默认为一个空对象
2.module.exports 对象
在自定义模块中,可以使用module.exports对象,将模块内的成员共享出去,供外界使用。
外界用require() 方法导入自定义模块时,得到的就是module.exports所指向的对象。
使用require()方法导入模块时,导入的结果,永远以 module.exports 指向的对象为准。
Node.js 中的模块化规范
Node.js遵循了CommonJS模块化规范,CommonJS规定了模块的特性和各模块之间如何相互依赖。
CommonJS规定:
①每个模块内部,module 变量代表当前模块。
②module 变量是一个对象,它的exports属性(即module.exports)是对外的接口。
③加载某个模块,其实是加载该模块的 module.exports属性。require() 方法用于加载模块。
npm与包
Node.js中的第三方模块又叫做包。
由于Node.js的内置模块仅提供了一些底层的API,导致在基于内置模块进行项目开发的时,效率很低。
包是基于内置模块封装出来的,提供了更高级、更方便的 API,极大的提高了开发效率。
包和内置模块之间的关系,类似于jQuery和浏览器内置 API 之间的关系。
从 npm 网站上搜索自己所需要的包
从 https://registry.npmjs.org/ 服务器上下载自己需要的包
在项目中安装包
npm install 包的名称
//简写: npm i 包的名称
安装格式化时间的包,并调用这个包对时间进行格式化输出
初次装包完成后,在项目文件夹下多一个叫做node_modules的文件夹和package-lock.json 的配置文件。
其中:
node_modules 文件夹用来存放所有已安装到项目中的包。require()导入第三方包时,就是从这个目录中查找并加载包。
package-lock.json 配置文件用来记录 node_modules 目录下的每一个包的下载信息,例如包的名字、版本号、下载地址等。
默认情况下,使用npm install 命令安装包的时候,会自动安装最新版本的包。如果需要安装指定版本的包,可以在包名之后,通过 @ 符号指定具体的版本,例如:
npm i moment@2.22.2
包的语义化版本规范
包的版本号是以“点分十进制”形式进行定义的,总共有三位数字,例如2.24.0
其中每一位数字所代表的的含义如下:
第1位数字:大版本
第2位数字:功能版本
第3位数字:Bug修复版本
版本号提升的规则:只要前面的版本号增长了,则后面的版本号归零。
包管理配置文件
npm规定,在项目根目录中,必须提供一个叫做package.json 的包管理配置文件。用来记录与项目有关的一些配置信息。例如:
-
项目的名称、版本号、描述等
-
项目中都用到了哪些包
-
哪些包只在开发期间会用到
-
那些包在开发和部署时都需要用到
当我们多人协作制作项目时,第三方包的体积过大,不方便团队成员之间共享项目源代码,可以在共享时剔除node_modules
1.如何记录项目中安装了哪些包
在项目根目录中,创建一个叫做 package.json 的配置文件,即可用来记录项目中安装了哪些包。从而方便剔除node_modules目录之后,在团队成员之间共享项目的源代码。
2.快速创建 package.json
现在在我们下载包的时候会自动帮我们创建好这个文件,不用手动创建了
npm包管理工具提供了一个快捷命令,可以在执行命令时所处的目录中,快速创建 package.json这个包管理配置文件:
//在执行命令所处的目录中,快速新建package.json文件
npm init -y
①上述命令只能在英文的目录下成功运行!所以,项目文件夹的名称一定要使用英文命名,不要使用中文,不能出现空格。
②运行 npminstall 命令安装包的时候,npm 包管理工具会自动把包的名称和版本号,记录到 package.json 中。
3.dependencies节点
package.json文件中,有一个dependencies节点,专门用来记录您使用npm install 命令安装了哪些包。
4.一次性安装所有的包
当我们拿到一个剔除了 node_modules 的项目之后,需要先把所有的包下载到项目中,才能将项目运行起来。否则报错:
Error:Cannot find module 'moment'
可以运行 npm install 命令(或 npm i)一次性安装所有的依赖包:
//执行npm install 命令时,npm包管理工具会先读取package.json中的dependencise节点
//读取到记录的所有依赖包名称和版本号之后,npm包管理工具会把这些包一次性下载到项目中
npm install
5.卸载包
可以运行npm uninstall 命令,来卸载指定的包:
// npm uninstall 具体包名
npm uninstall moment
npm uninstall 命令执行成功后,会把卸载的包,自动从package.json的 dependencies中移除掉
6.devDependencies节点
如果某些包只在项目开发阶段会用到,在项目上线之后不会用到,则建议把这些包记录到 devDependencies节点中。与之对应的,如果某些包在开发和项目上线之后都需要用到,则建议把这些包记录到dependencies节点中。
您可以使用如下的命令,将包记录到 devDependencies节点中
//安装指定的包,并记录到devDependencies节点中
npm i 包名 -D
//上面是简写,下面是完整写法
npm install 包名 --sava-dav
解决下包速度慢的问题
在使用npm下包的时候,默认从国外的https://registry.npmjs.org/服务器进行下载,此时,网络数据的传输需要经过漫长的海底光缆,因此下包速度会很慢。
切换npm 的下包镜像源
//查看当前下包镜像源(下包的镜像源,指的就是下包的服务器地址)
npm config get registry
//查看所有可用的镜像源
nrm ls
//将下包镜像源切换为 taobao 镜像
nrm use taobao
包的分类
项目包
那些被安装到项目的 node_modules目录中的包,都是项目包。
项目包又分为两类,分别是:
开发依赖包(被记录到 devDependencies 节点中的包,只在开发期间会用到)
核心依赖包(被记录到 dependencies 节点中的包,在开发期间和项目上线之后都会用到)
npm i 包名 -D //开发依赖包(会被记录到 DevDependencies 节点下)
npm i 包名 //核心依赖包(会被记录到 dependencies 节点下)
全局包
在执行 npm install 命令时,如果提供了 -g 参数,则会把包安装为全局包。
全局包会被安装到 C:\Users\用户目录\AppData\Roaming\npm\node_modules 目录下。
npm i 包名 -g // 全局安装指定的包
npm uninstall 包名 -g // 卸载全局安装的包
注意:
①只有工具性质的包,才有全局安装的必要性。因为它们提供了好用的终端命令。
②判断某个包是否需要全局安装后才能使用,可以参考官方提供的使用说明即可。
i5ting_toc
i5ting_toc 是一个可以把 md 文档转为 html 页面的小工具,使用步骤如下:
// 将 i5ting_toc 安装为全局包
npm install -g i5ting_toc
// 调用 i5ting_toc 实现md转html的功能
i5ting_toc -f 要转换的md文件路径 -o
规范的包结构
一个规范的包,它的组成结构,必须符合以下3点要求:
①包必须以单独的目录而存在
②包的顶级目录下要必须包含 package.json 这个包管理配置文件
③package.json 中必须包含name,version,main这三个属性,分别代表包的名字、版本号、包的入口。
开发自己的包并发布
黑马node.js公开课有详细说明04.发布包-初始化基础的包结构_哔哩哔哩_bilibili
模块的加载机制
优先从缓存中加载
模块在第一次加载后会被缓存。 这也意味着多次调用 require() 不会导致模块的代码被执行多次。
注意:不论是内置模块、用户自定义模块、还是第三方模块,它们都会优先从缓存中加载,从而提高模块的加载效率。
内置模块的加载机制
内置模块是由 Node.js 官方提供的模块,内置模块的加载优先级最高。
例如,require('fs') 始终返回内置的 fs 模块,即使在 node_modules 目录下有名字相同的包也叫做 fs。
自定义模块的加载机制
使用 require() 加载自定义模块时,必须指定以./ 或 ../ 开头的路径标识符。在加载自定义模块时,如果没有指定 ./ 或 ../ 这样的路径标识符,则 node 会把它当作内置模块或第三方模块进行加载。
同时,在使用 require() 导入自定义模块时,如果省略了文件的扩展名,则Node.js 会按顺序分别尝试加载以下的文件:
①按照确切的文件名进行加载
②补全 .js 扩展名进行加载
③补全 .json 扩展名进行加载
④补全 .node 扩展名进行加载
⑤加载失败,终端报错
第三方模块的加载机制
如果传递给 require() 的模块标识符不是一个内置模块,也没有以‘./’ 或 ‘../’ 开头,则 Node.js 会从当前模块的父目录开始,尝试从/node_modules 文件夹中加载第三方模块。
如果没有找到对应的第三方模块,则移动到再上一层父目录中,进行加载,直到文件系统的根目录。
例如,假设在 'C:\Users\itheima\project\foo.js' 文件里调用了 require('tools'),则 Node.js 会按以下顺序查找:
① C:\Users\itheima\project\node_modules\tools
② C:\Users\itheima\node_modules\tools
③ C:\Users\node_modules\tools
④ C:\node_modules\tools
目录作为模块
当把目录作为模块标识符,传递给require() 进行加载的时候,有三种加载方式:
①在被加载的目录下查找一个叫做package.json 的文件,并寻找 main 属性,作为 require() 加载的入口
②如果目录里没有 package.json 文件,或者 main 入口不存在或无法解析,则 Node.js 将会试图加载目录下的 index.js 文件。
③如果以上两步都失败了,则 Node.js 会在终端打印错误消息,报告模块的缺失:Error: Cannotfind module 'xxx'