Node.js 模块化处理(4)

[就爱开摆]

模块化

模块化是指解决一个复杂问题时，自顶向下逐层把系统划分为若干模块的过程。对整个系统来说，模块是可组合、分解和更换的单元。

编程领域中的模块化，就是遵守固定的规则，把一个大文件拆成独立并相互依赖的多个小模块。

 

把代码进行模块化拆分的好处：

1.提高了代码的复用性

2.提高了代码的可维护性

3.可以实现按需加载

 

模块化规范

模块化规范就是对代码进行模块化的拆分与组合的时，需要遵守的规则

eg:

1.使用什么样的语法格式引入模块

2.在模块中使用什么样的语法向外暴露成员

模块化规范的好处：大家遵守同样的模块化规范写代码，降低沟通的成本，极大方便了各个模块之间的互相调用，利人利己

 

 

Node.js中的模块化

Node.js中模块的分类

Node.js中根据模块来源的不同，将模块分为三大类：

1.内置模块：由Node.js官方提供的，如fs,path,http

2.自定义莫：用户创建的每个.js文件，都是自定义模块

3.第三方模块：由第三方开发出来的模块

 

 

加载模块

使用强大的Require（）方法，可以加载内置模块，用户定义模块，第三方模块。

 const fs = require('fs')
 //自定义，可以省略.js后缀名
 cosnt custom = require('./custom.js')

使用require方法加载其他模块时，会执行被加载模块中的代码

 

Node.js中的模块作用域

和函数作用域类似，在自定义模块中定义变量，方法等成员，只能在当前模块内被访问，这种模块级别的访问限制，叫做模块作用域

 

模块作用域的好处

防止全局变量污染的问题，无法被外界所访问

 

向外共享模块作用域中的成员

1.module对象

每个.js对象自定义模块中都有一个module对象，它储存了和当前模块有关的信息，打印如下：

 

其中exports属性向外共享成员

 

2.moudule.exports对象

在自定义模块中，可以使用module.exports对象，将模块内的成员共享出去，供外界使用

外界使用require方法导入自定义模块时，得到的就是module.exports所指的对象

注意：

使用require方法导入模块时，导入的结果，永远以module.exports指向的对象为准

 

在以上例子中，打印的对象为下面的结果而不是上者

 

3.exports对象

由于module.exports单词写起来比较复杂，为了简化向外共享成员的代码，Node提供了exports对象。默认情况下，exports和module.exports指向同一个对象，最终共享的结果，还是以module.exports指向的对象为基准

 

 

exports与module.exports的使用误区

require模块时，得到的永远是module.exports所指向的对象

例如

 exports.username = 'zs'
 module.exports ={
     gender:'男'
     age:22
 }

则打印出这个对象会显示：{gender：‘男’，age：22}

 

 

但如果：

 module.exports.username = 'zs'
 exports ={
     gender:'男'
     age:22
 }

打印结果则为：{username：'zs'}

 

 

注意：为了防止混乱，建议大家不要在同意模块中同时使用exports与module.exports对象

 

 

Node.js中的模块化规范

Node.js遵循了CommonJS模块化规范，CommonJS规定了模块的特性和各模块之间如何相互依赖

CommonJS规定：

1.每个模块内部，module变量代表当前模块

2.module变量是一个对象，它的exports属性(即module.exports)是对外的接口

3.加载某个模块，其实就是加载该模块的module.exports属性，require属于加载模块

 

npm与包

包的定义

Node.js中第三方模块又叫做包

 

包的来源

不同的Node.js中内置模块与自定义模块，包是由第三方个人或者团队开发出来的，免费供所有人使用

 

原因：Node.js内置模块仅提供了一些底层的API，导致在基于内置模块进行开发项目时，效率很低

包是基于内置模块封装出来，提供更高级，更方便的API，极大的提高了开发效率

包与内置模块之间的关系，类似于jQurey与浏览器内置API之间的关系

 

1.http://www.npmjs.com/是全球最大的包共享平台

2.http://registry.npmjs.org/对外共享包的下载

 

 

例子：npm格式化时间的高级做法

1.使用npm包管理工具，在项目中安装格式化时间的包moment

2.使用require()导入格式化时间的包

3.参考moment的官方API文档对时间进行格式化

 

 

在项目中安装指定名称的包

 npm install 包的完整名称
 //可简写为
 npm i 包的完整名称

 

 

 const moment = require('moment');
 const dt = moment().format('YYYY-MM-DD HH:mm:ss');
 console.log(dt);

 

 

初次安装包后多了哪些文件？

初次安装包完成后，在项目文件夹下多了一个叫做node_module的文件夹和package-lock.json的配置文件

其中，node_module的文件夹用来存放所有已安装到项目中的包

require导入第三方包时，就是从这个目录中查找并加载包

package-lock.json配置文件用来记录node_modules目录下每个包下载信息，例如包的名字，版本号和下载地址

注意：程序员不要手动修改node_module或者package-lock.json文件中的任何代码，npm包管理工具会自动维护它们

 

安装指定版本的包

默认情况下，使用npm install 命令安装包时，会自动安装最新版本的包。如果需要安装指定版本的包，可以在包名之后，通过@符号指定具体的版本，如：

 npm i moment@2.22.2

 

包的语义化版本规范

包的版本号是以‘点分十进制’形式进行定义的，总共三位数字，例如:2.24.0

参数解读：

第一位数字：大版本

第二位数字：功能版本

第三位数字：Bug修复版本

版本号提升的规则：只要前面的版本号增长了，则后面的版本号归零

 

 

包管理配置文件

npm规定，在项目根目录中，必提供一个叫做package.json的包管理文件。用来记录与项目有关的一些配置消息，例如：

1.项目的名称、版本号、描述等

2.项目中用到了哪些包

3.哪些包只会在开发的期间用到

4.哪些包在开发和部署的时候需要用到

 

多人协作问题

 

问题：第三方包的体积过大，不方便团队成员之间共享项目源代码

解决方案：共享的时候剔除掉node_modules

 

如何记录项目中安装了哪些包？

在项目根目录中，创建一个叫做package.json的配置文件，即可用来记录项目中安装了哪些包。从而方便剔除node_module目录之后，在团队成员之间共享项目的源代码

 

注意：在项目开发中，一定要把node_module文件夹添加到.gitignore忽略文件中

 

快速创建package.json

npm包管理工具提供了一个快捷命令，可以在执行命令时所处的目录中，快速创建package.json这个包管理配置文件：

 npm init -y

作用：在执行命令所处的目录中，快速创建package.json文件

注意：

1.上述命令只能在英文的目录下成功运行！项目文件名称一定要使用英文命令，不要使用中文，不能出现空格！

2.运行npm install 命令安装包的时候，npm包管理工具会自动把包的名称和版本号记录到package.json中

 

denpendencies节点

package.json文件中，有一个denpendencies节点，专门用来记录使用npm install 命令安装了哪些包

 

其中内容包括版本号之类的信息

 

一次性安装所有的包

当我们拿到一个剔除了node_module的项目之后，需要先把所有的包下载到项目中，才能将项目运行起来

可以运行 npm install 命令 一次性安装所有的依赖包：

 

卸载包

可以运行npm uninstall命令来卸载指定的包

 

devDependencies节点

如果某些包只在开发阶段会用到，在项目上线之后就不会用到，则建议把这些包的记录到devDenpendencies节点中，与之相应的，如果某些包和项目上线后都需要用到，则把包记录到Denpendencies节点中

使用以下命令：

 //简写
 npm init 包名 -D
 //完整写法
 npm install 包名 --save-dev
 //包名的顺序不重要 前后均可

 

 

解决下包慢的问题

原因

在使用npm下包的时候，默认从国外的http://registry.npmjs.org/服务器下载，此时，网络数据传输需要经过漫长的海底光缆，因此下包速度慢

 

 

 

镜像

镜像(Mirroring)是一种文件储存方式，一个磁盘上的数据在另一个磁盘上存在一个完全相同的副本

 

切换npm的下包镜像源

下包的镜像源就是下包的服务器地址

//查看当前下包镜像源
npm config get registry
//将下包的镜像源切换为淘宝镜像源
npm config set registry=http://registry.npm.taobao.org/
//检查镜像源是否下载成功
npm config get registry

 

 

 

改变下载的镜像源为淘宝国内服务器会大大提高下载速度

 

nrm

为了更加方便切换下包的镜像源，安装nrm这个小工具，利用nrm提供的终端命令，可以快速查看和切换下包的镜像源

//通过npm包管理器 将nrm设置为全局可用的工具
npm i nrm -g
//查看可用的镜像源
nrm ls
//将下包的镜像源切换为taobao的镜像源
nrm use taobao

包的分类

使用npm包管理工具下载的包，共分为两大类，分别是： 项目包和全局包

 

项目包

被安装到项目的node_modules目录的包

1.项目依赖包(被记录到devDenpendencies节点中的包，只会在开发期间用到)

2.核心依赖包(被记录到denpendencies节点中的包，在开发期间和项目上线后都会用到)

//项目依赖包 devDenpendencies
npm i 包名 -D
//核心依赖包 denpendencies
npm i 包名 

 

全局包

在执行npm install命令时，提供了-g参数，则会把包安装为全局包

全局包会安装到C:\Uesrs\用户目录\AppData\Roaming\npm\node_modules目录下

例如：我的电脑中安装在C:\Users\zyh\AppData\Roaming\npm\node_modules

 

 

 

npm i 包名 -g //安装全局包
npm uninstall 包名 -g //卸载全局包

注意：

1.只有工具性质的包，才有全局安装的必要性。因为它们提供了好用的终端命令

2.判断某个包是否需要全局安装后才能使用，参考官方提供的使用说明即可

 

 

i5ting_toc

i5ting_toc是一个可以把md文档转换为html页面的小工具：

//将i5ting_toc安装为全局包
npm install i5ting_toc -g
//调用i5ting_toc 实现功能
i5ting_toc -f 要转换md文档路径 -o

 

规范的包结构

深入了解包的内部结构

一个规范的包，它的组成结构，必须符合以下3点要求：

1.包必须以单独的目录存在

2.包的顶级目录必须包含package.json这个包管理配置文件

tip:(JavaScript Object Notation, JS对象简谱）是一种轻量级的数据交换格式

3.package.json中必须包含name,verson,main三个属性，分别代表包的名字，版本号，包的入口

注意：以上 3 点要求是一个规范的包结构必须遵守的格式，关于更多的约束，可以参考如下网址：

https://yarnpkg.com/zh-Hans/docs/package-json

 

 

开发属于自己的包

1.新建文件夹，作为包的根目录

2.新建三个文件夹

package.json 包管理配置文件

index.js 包的入口文件

REMADE.md 包的说明文档

3.初始化package.json

{
    "name":"demo",
    "version":"1.0.0",
    "main":"index.js",
    "description":"提供...的功能",
    "keyword":[
    "itheima",
    "dataFormat",
    "escape"
    ],
	"license":"ISC"
}

4.在index.js中自定义函数方法

5.将不同功能进行模块化拆分，然后再在index.js中导入模块吗，使用 module.exports 把对应的方法共享出去

注意：...可以扩展对象

6.编写包的说明文档

包根目录中的 README.md 文件，是包的使用说明文档。通过它，我们可以事先把包的使用说明，以 markdown 的

格式写出来，方便用户参考。

README 文件中具体写什么内容，没有强制性的要求；只要能够清晰地把包的作用、用法、注意事项等描述清楚即可。

我们所创建的这个包的 README.md 文档中，会包含以下 6 项内容：

安装方式、导入方式、格式化时间、转义 HTML 中的特殊字符、还原 HTML 中的特殊字符、开源协议

 

发布包

注册 npm 账号

1.访问 https://www.npmjs.com/ 网站，点击 sign up 按钮，进入注册用户界面

2.填写账号相关的信息：Full Name、Public Email、Username、Password

3.点击 Create an Account 按钮，注册账号

4.登录邮箱，点击验证链接，进行账号的验证

 

npm 账号注册完成后，可以在终端中执行 npm login 命令，依次输入用户名、密码、邮箱后，即可登录成功

 

 

注意：在运行 npm login 命令之前，必须，先把下包的服务器地址切换为 npm 的官方服务器。否则会导致发布包失败！

 

把包发布到 npm 上

将终端切换到包的根目录之后，运行 npm publish 命令，即可将包发布到 npm 上（注意：包名不能雷同）

删除已发布的包

运行 npm unpublish 包名 --force 命令，即可从 npm 删除已发布的包

 npm unpublish 包名 --force 

注意：

1.npm unpublish 命令只能删除 72 小时以内发布的包

2.npm unpublish 删除的包，在 24 小时内不允许重复发布

3.发布包的时候要慎重，尽量不要往 npm 上发布没有意义的包！

 

 

模块的加载机制

模块在第一次加载后会被缓存。 这也意味着多次调用 require() 不会导致模块的代码被执行多次。

注意：不论是内置模块、用户自定义模块、还是第三方模块，它们都会优先从缓存中加载，从而提高模块的加载效率

 

内置模块的加载机制

内置模块是由 Node.js 官方提供的模块，内置模块的加载优先级最高。

例如，require('fs') 始终返回内置的 fs 模块，即使在 node_modules 目录下有名字相同的包也叫做 fs

 

自定义模块的加载机制

使用 require() 加载自定义模块时，必须指定以 ./ 或 ../ 开头的路径标识符。在加载自定义模块时，如果没有指定 ./ 或 ../

这样的路径标识符，则 node 会把它当作内置模块或第三方模块进行加载。

同时，在使用 require() 导入自定义模块时，如果省略了文件的扩展名，则 Node.js 会按顺序分别尝试加载以下的文件：

1.按照确切的文件名进行加载

2.补全 .js 扩展名进行加载

3.补全 .json 扩展名进行加载

4.补全 .node 扩展名进行加载

5.加载失败，终端报错

 

第三方模块的加载机制

如果传递给 require() 的模块标识符不是一个内置模块，也没有以 ‘./’ 或 ‘../’ 开头，则 Node.js 会从当前模块的父

目录开始，尝试从 /node_modules 文件夹中加载第三方模块

如果没有找到对应的第三方模块，则移动到再上一层父目录中，进行加载，直到文件系统的根目录

例如，假设在 'C:\Users\itheima\project\foo.js' 文件里调用了 require('tools')，则 Node.js 会按以下顺序查找：

1.C:\Users\itheima\project\node_modules\tools

2.C:\Users\itheima\node_modules\tools

3.C:\Users\node_modules\tools

4.C:\node_modules\tools

 

目录作为模块

当把目录作为模块标识符，传递给 require() 进行加载的时候，有三种加载方式：

1.在被加载的目录下查找一个叫做 package.json 的文件，并寻找 main 属性，作为 require() 加载的入口

2.如果目录里没有 package.json 文件，或者 main 入口不存在或无法解析，则 Node.js 将会试图加载目录下的 index.js 文件。

3.如果以上两步都失败了，则 Node.js 会在终端打印错误消息，报告模块的缺失：Error: Cannot find module 'xxx