【Node.js】模块讲解、npm的使用

一、初识Node.js与内置模块

1.1 Node.js简介

Node.js是一个基于Chrome V8引擎的JavaScript运行环境。

• Node.js 中 JavaScript 运行环境

• 注意：
  • 浏览器是 JavaScript 的前端运行环境
  • Node.js 是 JavaScript 的后端运行环境
  • Node.js中无法调用DOM和BOM等浏览器内置API。

1.1.1 终端中的快捷键

• 在 Windows 的 powershell 或 cmd 终端中，我们可以通过如下快捷键，来提高终端的操作效率:
  • 使用 ↑ 键，可以快速定位到上一次执行的命令
  • 使用 tab 键，能够快速补全路径
  • 使用 esc 键，能够快速清空当前已输入的命令
  • 使用 cls 键，可以清空终端

1.2 fs文件系统模块

• fs模块是Node.js官方提供的、用来操作文件的模块。它提供了一系列的方法和属性，用来满足用户对文件的操作需求。
• 例如：
  • fs.readFile() 方法，用来读取指定文件中的内容
  • fs.writeFile() 方法，用来向指定的文件中写入内容
• 如果要在JavaScript 代码中，使用fs模块来操作文件，则需要使用如下的方式先导入它:

const fs = require('fs')

1.2.1 读取指定文件中的内容

• 使用fs.readFile()方法，可以读取指定文件中的内容，语法格式如下:

fs.readFile(path[,option],callback)

• path : 必选参数，字符串，表示文件的路径
• option : 可选参数，表示以什么编码格式来读取文件
• callback : 必选参数，文件读取完成后，通过回调函数拿到读取的结果

示例代码：

const fs = require('fs')
fs.readFile('./1.txt','utf8',function(err,datastr){
    console.log(err)
    console.log(datastr)
})

结果：

• 注意：
  • 如果读取成功，则 err 的值为 null
  • 如果读取失败，则 err 的值为错误对象，datastr 的值为 undefined

1.2.2 向指定文件中写入内容

• 使用fs.writeFile()方法，可以向指定的文件中写入内容，语法格式如下:

fs.writeFile(file,data[,option],callback)

• file : 必选参数，需要指定一个文件路径的字符串，表示文件的存放路径。
• data : 必选参数，表示要写入的内容
• option : 可选参数，表示以什么编码格式来写入文件内容
• callback : 必选参数，文件写入完成后的回调函数

示例代码：

const fs = require('fs')
fs.writeFile('./2.txt','Hello Node.js!','utf8',function(err){
    console.log(err)
})

1.2.3 动态路径拼接的问题

• 在使用fs模块操作文件时，如果提供的操作路径是以 ./ 或 …/ 开头的相对路径时，很容易出现路径动态拼接错误的问题。
• 原因：代码在运行的时候，会以执行node命令时所处的目录，动态拼接出被操作文件的完整路径。
• 解决方案：
  • 在使用fs模块操作文件时，直接提供完整的路径，不要提供，或…/开头的相对路径，从而防止路径动态拼接的问题。（移植性差，不利于维护）
  • __dirname表示当前文件所处的目录，示例如下

fs.writeFile(__dirname+'./2.txt','Hello Node.js!','utf8',function(err){})

1.3 path路径模块

• path模块是Node.js官方提供的、用来处理路径的模块。它提供了一系列的方法和属性，用来满足用户对路径的处理需求。
• 例如：
  • path.join()方法，用来将多个路径片段拼接成一个完整的路径字符串
  • path.basename()方法，用来从路径字符串中，将文件名解析出来
• 如果要在JavaScript 代码中，使用path模块来操作文件，则需要使用如下的方式先导入它:

const path = require('path')

1.3.1 路径拼接

• 使用path.join()方法，可以把多个路径片段拼接为完整的路径字符串，语法格式如下:

path.join([...paths])

• …psths: <string> 路径片段的序列
• 返回值：<string>

示例代码：

const pathStr = path.join('/a','/b/c','../','./d','e')
console.log(pathStr)	// 输出 \a\b\d\e

const pathStr2 = path.join(__dirname,'./1.txt')
console.log(pathStr2)	// 输出 当前文件所处目录\1.txt

注意： 今后凡是涉及到路径拼接的操作，都要使用path.join()方法进行处理。不要直接使用＋进行字符串的拼接。

1.3.2 获取路径中的文件名

• 使用path.basename()方法，可以获取路径中的最后一部分，经常通过这个方法获取路径中的文件名，语法格式如下:

path.basename(path[,ext])

• path: <string> 必选参数，表示一个路径的字符串
• ext: <string>可选参数，表示文件扩展名
• 返回: <string>表示路径中的最后一部分

示例代码：

const fpath = '/a/b/c/index.html'	// 文件的存放路径

var fullName = path.basename(fpath)
console.log(fullName)	// 输出 index.html

var nameWithoutExt = path.basename(fpath,'.html')
console.log(nameWithoutExt)	//输出index

1.3.3 获取路径中的文件扩展名

• 使用path.extname()方法，可以获取路径中的扩展名部分，语法格式如下:

path.extname(path)

• path: <string> 必选参数，表示一个路径的字符串
• 返回: <string>返回得到的扩展名字符串

1.4 http模块

http 模块是 Node.js 官方提供的、用来创建web服务器的模块。通过 http 模块提供的 http.createServer()方法，就能方便的把一台普通的电脑，变成一台Web服务器，从而对外提供Web资源服务

• 如果希望使用http模块创建web服务器，需要先导入它：

const http = require('http')

---

• 服务器和普通电脑的区别在于，服务器上安装了web服务器软件，例如：lIS、Apache等。通过安装这些服务器软件，就能把一台普通的电脑变成一台web 服务器。
• 在Node.,js 中，我们不需要使用IIS、Apache等这些第三方web服务器软件。因为我们可以基于Node.js 提供的http模块，通过几行简单的代码，就能轻松的手写一个服务器软件，从而对外提供web服务。

1.4.1 服务器相关的概念

1. IP地址
   • IP地址就是互联网上每台计算机的唯一地址，因此IP地址具有唯一性。
   • IP地址的格式:通常用“点分十进制”表示成(a.b.c.d)的形式，其中,ab,c,d都是0~255之间的十进制整数。例如:用点分十进表示的IP地址(192.168.1.1)
   • 注意：
     • 互联网中每台Web服务器，都有自己的IP地址，例如:大家可以在Windows的终端中运行ping www.baidu.com命令，即可查看到百度服务器的IP地址。
     • 在开发期间，自己的电脑既是一台服务器，也是一个客户端，为了方便测试，可以在自己的浏览器中输入127.0.0.1这个IP地址，就能把自己的电脑当做一台服务器进行访问了。
2. 域名和域名服务器
   • 尽管IP地址能够唯一地标记网络上的计算机，但IP地址是一长串数字，不直观，而且不便于记忆，于是人们又发明了另一套字符型的地址方案，即所谓的域名(Domain Name)地址。
   • IP地址和域名是一对多的关系，这份对应关系存放在一种叫做域名服务器(DNS， Domain name server)的电脑中。使用者只需通过好记的域名访问对应的服务器即可，对应的转换工作由域名服务器实现。因此，域名服务器就是提供IР地址和域名之间的转换服务的服务器。
   • 注意：
     • 在开发测试期间，127.0.0.1对应的域名是localhost，它们都代表我们自己的这台电脑，在使用效果上没有任何区别
3. 端口号
   • 在一台电脑中，可以运行成百上千个web服务。每个web服务都对应一个唯一的端口号。客户端发送过来的网络请求，通过端口号，可以被准确地交给对应的web服务进行处理。
   • 注意
     • 每个端口号不能同时被多个web服务占用
     • 在实际应用中，URL中的 80端口可以被省略

1.4.2 创建最基本的web服务器

// 1. 导入http模块
const http = require('http')
// 2. 创建web服务器实例
const server = http.createServer()
// 3. 为服务器绑定request事件，监听客户端的请求
server.on('request',function(req,res){
    console.log('Someone visit our web server')
})
// 4. 启动服务器
server.listen(8080,()=>{
    console.log('http server run at http://127.0.0.1');
})

• 在浏览器中输入 127.0.0.1:8080 ，可对服务器发起请求，结果如图：

1.4.3 req请求对象

• 只要服务器接收到了客户端的请求，就会调用通过server.on()为服务器绑定的request事件处理函数。
• 如果想在事件处理函数中，访问与客户端相关的数据或属性，可以使用如下的方式:

server.on('request',(res)=>{
	// req是请求对象，它包含了与客户端相关的数据和属性，例如:
	// req.url是客户端请求的 URL 地址
	// req.method 是客户端的 method 请求类型
    const str = 'Your request url is '+req.url+',and request method is '+req.method
	console.log(str)
})

1.4.4 res响应对象

• 在服务器的request事件处理函数中，如果想访问与服务器相关的数据或属性，可以使用如下的方式：

server.on('request',(res)=>{
    const str = 'Your request url is '+req.url+',and request method is '+req.method
    // res.end() 向客户端发送指定的内容，并结束这次的请求过程
	res.end(str)
})

1.4.5 解决中文乱码的问题

• 当调用res.end()方法，向客户端发送中文内容的时候，会出现乱码问题，此时，需要手动设置内容的编码格式:

server.on('request',(req,res)=>{
    const str = '您请求的 url 地址为 '+req.url+',请求的 method 类型是 '+req.method
    // 调用res.setHeader()方法，设置Content-Type响应头，解决中文乱码的问题
    res.setHeader('Content-Type','text/html; charset=utf-8')
	res.end(str)
})

1.4.6 根据不同的url响应不同的html内容

server.on('request',function(req,res){
    const url = req.url
    let content = '<h1>404 NOT found!</h1>'	//设置默认的内容
    if(url === '/' || url === '/index.html'){
        content = '<h1>首页</h1>'
    }else if(url === '/about.html'){
        content = '<h1>关于页面</h1>'
    }

    res.setHeader('Content-Type','text/html; charset=utf-8')
    res.end(content)
})

二、Node.js 中的模块化

2.1 模块化的基本概念

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

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

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

  1. 提高了代码的复用性
  2. 提高了代码的可维护性
  3. 可以实现按需加载

2.2 加载模块

• 使用require()方法，可以加载需要的内置模块、用户自定义模块、第三方模块进行使用。例如:

// 加载内置模块
const fs = require('fs')
// 加载用户的自定义模块
const custom = require('./custom.js')
// 加载第三方模块
const moment = require('moment')

• 注意： 当使用 require() 方法加载其它模块时，会执行被加载模块中的代码

2.3 模块作用域

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

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

1. module 对象
   • 在每个 .js 自定义模块中都有一个module对象，它里面存储了和当前模块有关的信息，打印如下:
     
2. module.exports 对象
   • 在自定义模块中，可以使用module.exports对象，将模块内的成员共享出去，供外界使用。
   • 外界用require()方法导入自定义模块时，得到的就是module.exports所指向的对象。

// 向module.exports对象上挂载username属性
module.exports.username = 'aaa'
// 向module.exports对象上挂载sayHello方法
module.exports.sayHello = function(){
	console.log('Hello!')
}

• 注意：
  • 使用require()方法导入模块时，导入的结果，永远以module.exports指向的对象为准。

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

const username = 'bbb'
exports.username = username

4. exports和module.exports的使用误区
   • 时刻谨记，require()模块时，得到的永远是module.exports指向的对象

2.3.2 Node.js 中的模块化规范

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

• CommonJS 规定：
  • 每个模块内部，module变量代表当前模块。
  • module变量是一个对象，它的exports属性(即 module.exports）是对外的接口。
  • 加载某个模块，其实是加载该模块的module.exports属性。require()方法用于加载模块。

三、npm与包

3.1 包

Node.js 中的第三方模块又叫做包。
不同于Node.,js 中的内置模块与自定义模块，包是由第三方个人或团队开发出来的，免费供所有人使用。
注意: Node.js 中的包都是免费且开源的，不需要付费即可免费下载使用。

• 由于Node,js的内置模块仅提供了一些底层的API，导致在基于内置模块进行项目开发的时，效率很
• 包是基于内置模块封装出来的，提供了更高级、更方便的API，极大的提高了开发效率。
• 包和内置模块之间的关系，类似于jQuery和浏览器内置API之间的关系。

3.2 初识npm

1. 在项目中安装包的命令

npm install 包的完整名称
npm i 包的完整名称

• 初次装包完成后，在项目文件夹下多一个叫做node_modules的文件夹和package-lock.json 的配置文件。
  • node_modules文件夹用来存放所有已安装到项目中的包。require()导入第三方包时，就是从这个目录中查找并加载包。
  • package-lock.json配置文件用来记录node_modules 目录下的每一个包的下载信息，例如包的名字、版本号、下载地址等。

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

npm i moment@2.22.2

3.3 包管理配置文件

• npm规定，在项目根目录中，必须提供一个叫做package.json的包管理配置文件。用来记录与项目有关的一些配置信息。例如:
  • 项目的名称、版本号、描述等
  • 项目中都用到了哪些包
  • 哪些包只在开发期间会用到
  • 哪些包在开发和部署时都需要用到
• 注意：在项目开发中，一定要把 node_modules文件夹，添加到 .gitignore忽略文件中。

3.3.1 快速创建 package.json

// 作用:在执行命令所处的目录中，快速新建package.json文件
npm init -y

• 注意：
  • 上述命令只能在英文的目录下成功运行！所以，项目文件夹的名称一定要使用英文命名，不要使用中文，不能出现空格。
  • 运行npm install命令安装包的时候，npm包管理工具会自动把包的名称和版本号，记录到package.json中。

3.3.2 dependencies 节点

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

3.3.3 一次性安装所有包

• 当拿到剔除了 node_moudles 文件夹的项目时，我们要先安装项目所需的所有包
• 执行npm install 命令时，npm包管理工具会先读取package.json 中的 dependencies节点
• 读取到记录的所有依赖包名称和版本号之后，npm包管理工具会把这些包一次性下载到项目中

npm install
npm i

3.3.4 卸载包

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

npm uninstall moment

• 注意: npm uninstall命令执行成功后，会把卸载的包，自动从 package.json的dependencies 中移除掉。

3.3.5 devDependencies 节点

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

// 安装指定的包，并记录到devDependencies节点中
npm i 包名 -D
//注意:上述命令是简写形式，等价于下面完整的写法:
npm install 包名 --save-dev

3.4 包的分类

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

1. 项目包
   • 那些被安装到项目的node_modules目录中的包，都是项目包。
   • 项目包又分为两类：
     • 开发依赖包 (被记录到devDependencies 节点中的包，只在开发期间会用到)
     • 核心依赖包 (被记录到dependencies 节点中的包，在开发期间和项目上线之后会用到)
2. 全局包
   • 在执行npm install 命令时，如果提供了-g参数，则会把包安装为全局包。
   • 注意：
     • 只有工具性质的包，才有全局安装的必要性。因为它们提供了好用的终端命令。
     • 判断某个包是否需要全局安装后才能使用，可以参考官方提供的使用说明即可。

3.4.1 i5ting_toc

• i5ting_toc是一个可以把 md文档转为 html页面的小工具，使用步骤如下:

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

3.5 规范的包结构

• 一个规范的包，它的组成结构，必须符合以下3点要求:
  • 包必须以单独的目录存在
  • 包的顶级目录下要必须包含 package.json 这个包管理配置文件
  • package.json中必须包含name，version，main这三个属性，分别代表包的名字、版本号、包的入口。

3.6 把包发布到npm上

npm login

• 切换到包的根目录，注意包名不能雷同

npm publish

• 删除已发布的包

npm unpublish 包名 --force

• 注意：
  • npm unpublish命令只能删除72小时以内发布的包
  • npm unpublish删除的包，在24小时内不允许重复发布
  • 发布包的时候要慎重，尽量不要往npm 上发布没有意义的包!

四、模块的加载机制

4.1 优先从缓存中加载

• 模块在第一次加载后会被缓存。这也意味着多次调用require()不会导致模块的代码被执行多次。
• 注意：不论是内置模块、用户自定义模块、还是第三方模块，它们都会优先从缓存中加载，从而提高模块的加载效率。

4.2 模块的加载机制

• 内置模块的加载机制
  • 内置模块是由Node.js 官方提供的模块，内置模块的加载优先级最高。
  • 例如，require('fs')始终返回内置的fs模块，即使在node_modules目录下有名字相同的包也叫做fs
• 自定义模块的加载机制
  • 使用require()加载自定义模块时，必须指定以 ./ 或 …/ 开头的路径标识符。在加载自定义模块时，如果没有指定 ./ 或 …/ 这样的路径标识符，则 node会把它当作内置模块或第三方模块进行加载。
  • 同时，在使用require()导入自定义模块时，如果省略了文件的扩展名，则Node.js 会按顺序分别尝试加载以下的文件：
    1. 按照确切的文件名进行加载
    2. 补全 .js扩展名进行加载
    3. 补全 .json扩展名进行加载
    4. 补全 .node扩展名进行加载
    5. 加载错误，终端报错
• 第三方模块的加载机制
  • 如果传递给require()的模块标识符不是一个内置模块，也没有以 ‘./’ 或 ‘…/’ 开头，则Nodejs 会从当前模块的父目录开始，尝试从/node_modules文件夹中加载第三方模块。

4.3 目录作为模块

• 当把目录作为模块标识符，传递给require()进行加载的时候，有三种加载方式:
  1. 在被加载的目录下查找一个叫做package.json 的文件，并寻找 main属性，作为require()加载的入口
  2. 如果目录里没有package.json文件，或者main 入口不存在或无法解析，则Nodejs将会试图加载目录下的 index.js 文件。
  3. 如果以上两步都失败了，则Node.js 会在终端打印错误消息，报告模块的缺失:Error:Cannot find module 'xoox'