# 模块化基本概念
# 模块化介绍
模块化是指解决一个复杂问题时,自顶向下逐层把系统划分成若干模块的过程
编程领域中的模块化,就是遵守固定的规则,把一个大文件拆成独立并互相依赖的多个小模块
提高了代码的复用性,可维护性,实现按需加载
# 模块化规范
模块化规范就是对代码进行模块化的拆分与组合时,需要遵守的那些规则
# Node.js 中模块化
# Node.js 中模块的分类
# 内置模块
内置模块是由 Node.js 官方提供的,例如 fs、path、http 等
# 自定义模块
用户创建的每个 .js 文件,都是自定义模块
# 第三方模块
由第三方开发出来的模块,并非官方提供的内置模块,也不是用户创建的自定义模块,使用前需要先下载
# 加载模块
使用强大的 require () 方法,可以加载需要的内置模块、用户自定义模块、第三方模块进行使用
const fs = require('fs'); | |
const custom = require('./custom.js'); | |
const moment = require('moment'); |
# Node.js 中的模块作用域
和函数作用域类似,在自定义模块中定义的变量、方法等成员,只能在当前模块内被访问,这种模块级别的访问限制,叫做模块作用域
# 向外共享模块作用域的成员
# module 对象
在每个 .js 自定义模块中都有一个 module 对象,它里面存储了和当前模块有关的信息
# moudle.exports 对象
在自定义模块中,可以使用 module.exports 对象,将模块内的成员共享出去,供外界使用
外界用 require () 方法导入自定义模块时,得到的就是 module.exports 所指向的对象
# 共享成员时注意点
使用 require () 方法导入模块时,导入的结果,永远以 module.exports 指向的对象为准
# exports 对象
由于 module.exports 单词写起来比较复杂,为了简化向外共享成员的代码,Node 提供了 exports 对象。默认情况
下,exports 和 module.exports 指向同一个对象
# Node.js 中的模块化规范
Node.js 遵循了 CommonJS 模块化规范,CommonJS 规定了模块的特性和各模块之间如何相互依赖
① 每个模块内部,module 变量代表当前模块。
② module 变量是一个对象,它的 exports 属性(即 module.exports)是对外的接口。
③ 加载某个模块,其实是加载该模块的 module.exports 属性。require () 方法用于加载模块。
# npm 与包
# 包介绍
Node.js 中的第三方模块又叫做包
# npm 初体验
# 包的来源
不同于 Node.js 中的内置模块与自定义模块,包是由第三方个人或团队开发出来的,免费供所有人使用
# 为什么需要包
由于 Node.js 的内置模块仅提供了一些底层的 API,导致在基于内置模块进行项目开发的时,效率很低。
包是基于内置模块封装出来的,提供了更高级、更方便的 API,极大的提高了开发效率
# 包的下载途径
国外有一家 IT 公司,叫做 npm, Inc. 这家公司旗下有一个非常著名的网站: https://www.npmjs.com/
# 下载包
npm install 包的完整名称@版本
# 包管理配置文件
npm 规定,在项目根目录中,必须提供一个叫做 package.json 的包管理配置文件。用来记录与项目有关的一些配置
信息
- 项目的名称、版本号、描述
- 项目中都用到了哪些包
- 哪些包只在开发期间会用到
- 那些包在开发和部署时都需要用到
# 多人协作问题
整个项目占比中,第三方包占比体积大,不方便成员之间共享项目资源代码
# 如何记录项目中安装了哪些包
在项目根目录中,创建一个叫做 package.json 的配置文件,即可用来记录项目中安装了哪些包。从而方便剔除
node_modules 目录之后,在团队成员之间共享项目的源代码
注意:今后在项目开发中,一定要把 node_modules 文件夹,添加到 .gitignore 忽略文件中
# 快速创建 package.json 文件
npm 包管理工具提供了一个快捷命令,可以在执行命令时所处的目录中,快速创建 package.json 这个包管理
配置文件
npm init -y
# dependencies 节点
package.json 文件中,有一个 dependencies 节点,专门用来记录您使用 npm install
命令安装了哪些包
# 一次性安装所有包
可以运行 npm install 命令(或 npm i)一次性安装所有的依赖包
npm install
# 卸载包
npm uninstall
# 3.7 devDependencies 节点
如果某些包只在项目开发阶段会用到,在项目上线之后不会用到,则建议把这些包记录到 devDependencies 节点中
npm i 包名 -D
npm install 包名 --save-dev
# 解决下包慢问题
# 下包慢的原因
在使用 npm 下包的时候,默认从国外的 https://registry.npmjs.org/ 服务器进行下载,此时,网络数据的传输需要经
过漫长的海底光缆,因此下包速度会很慢
# 淘宝镜像服务器
淘宝在国内搭建了一个服务器,专门把国外官方服务器上的包同步到国内的服务器,然后在国内提供下包的服务。从而极大的提高了下包的速度
镜像(Mirroring)是一种文件存储形式,一个磁盘上的数据在另一个磁盘上存在一个完全相同的副本即为镜像
# 切换 npm 的下包镜像源
- 查看当前下包的镜像源:
npm config get registry
- 将下载的包的镜像切换为淘宝镜像源:
npm config set registry=https://registry.npm.taobao.org/
# nrm
为了更方便的切换下包的镜像源,我们可以安装 nrm 这个小工具,利用 nrm 提供的终端命令,可以快速查看和切换下
包的镜像源
- 通过 npm 包管理器,将 nrm 安装为全局可用工具:
npm install nrm -g
- 查看可用的镜像源:
nrm ls
- 将下包的镜像源切换为 taobao 镜像:
nrm use taobao
# 包分类
# 项目包
那些被安装到项目的 node_modules 目录中的包,都是项目包
- 开发依赖包(被记录到 devDependencies 节点中的包,只在开发期间会用到)
- 核心依赖包(被记录到 dependencies 节点中的包,在开发期间和项目上线之后都会用到)
npm i 包名 -D
开发依赖包
npm i 包名
核心依赖包
# 全局包
在执行 npm install 命令时,如果提供了 -g 参数,则会把包安装为全局包
npm i 包名 -g
npm uninstall 包名 -g
# i5ting_top
i5ting_toc 是一个可以把 md 文档转为 html 页面的小工具
- 将 i5ting_toc 安装为全局包
npm i -g i5ting_toc
- 调用 i5ting_toc,轻松实现 md 转换 html 功能:
i5ting_toc -f 要转换的md文件路径 -o
# 模块的加载机制
# 优先从缓存中加载
模块在第一次加载后会被缓存。 这也意味着多次调用 require () 不会导致模块的代码被执行多次
# 内置模块加载机制
内置模块是由 Node.js 官方提供的模块,内置模块的加载优先级最高
# 自定义模块加载机制
使用 require () 加载自定义模块时,必须指定以 ./ 或 ../ 开头的路径标识符。在加载自定义模块时,如果没有指定 ./ 或 ../
这样的路径标识符,则 node 会把它当作内置模块或第三方模块进行加载
# 第三方模块加载机制
如果传递给 require () 的模块标识符不是一个内置模块,也没有以 ‘./’ 或 ‘../’ 开头,则 Node.js 会从当前模块的父
目录开始,尝试从 /node_modules 文件夹中加载第三方模块