# nodejs_notes
**Repository Path**: js-class/nodejs_notes
## Basic Information
- **Project Name**: nodejs_notes
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-18
- **Last Updated**: 2024-12-28
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
## Node 第 1 天
### 1. 学习目标
◆ 能够知道什么是 `Node.js`
◆ 能够知道 `Node.js` 可以做什么
◆ 能够说出 `Node.js` 中的 `JavaScript` 的组成部分
◆ 能够使用 `fs` 模块读写操作文件
◆ 能够使用 `path` 模块处理路径
◆ 能够使用 `http` 模块写一个基本的 `web` 服务器
---
### 2. 回顾和思考
#### 2.1 为什么 JavaScript 可以在浏览器中执行
##### 2.1.1 已经掌握了哪些技术

##### 2.1.2 浏览器中的 JavaScript 的组成部分

##### 2.1.3 为什么 JavaScript 可以在浏览器中被执行

#### 2.2 JavaScript 可以操作 `DOM` 和 `BOM`
- 每个浏览器都内置了 `DOM`、`BOM` 这样的 `API` 函数,因此,浏览器中的 `JavaScript` 才可以调用它们。

#### 2.3 浏览器中的 JavaScript 运行环境
运行环境是指代码正常运行所需的必要环境
总结:
1. `V8` 引擎负责解析和执行 `JavaScript` 代码
2. 内置 `API` 是由运行环境提供的特殊接口,只能在所属的运行环境中被调用
#### 2.4 JavaScript 能否做后端开发
1. `JavaScript` 可以做后台开发,只不过需要借助 `Node.js`
2. `JavaScript` 作为一门语言,代码的执行肯定需要运行环境,浏览器能够解析 `JavaScript` 代码,因为浏览器是一个运行环境,恰好,`Node.js` 也集成了一个 `JavaScript` 运行环境,也可以对 `JavaScript` 代码进行解析,不过 `Node` 是一个后端的运行环境,也是因此 `JavaScript` 能够进行后台的开发
---
### 3. 初识 `Node`
#### 3.1 什么是 `Node`
> 能够了解 Node 是一个运行环境,并不是一门后台语言
`Node.js` 是一个基于 `Chrome V8` 引擎的 `JavaScript` 运行环境
**Node 实际上就是一个 `JavaScript` 运行环境,它集成了 `v8` 引擎, 从而能对 `JavaScript` 代码进行解析**

#### 3.2 `Node` 中的 `JavaScript` 环境
> 能够知道 Node 运行环境包含哪两个部分
>
> 能够知道 Node 运行环境和 浏览器运行环境的区别
1. Node 运行环境包含两个部分,分别是:
- `V8` 引擎,主要负责解析 `JavaScript` 代码
- 内置 `API`,我们学习 `Node.js` 重点就是学习这些内置的 `API`,从而能够完成后台的开发
2. `Node` 运行环境和 浏览器运行环境的区别
- 浏览器是 `JavaScript` 的前端运行环境
- `Node.js` 是 `JavaScript` 的后端运行环境
- `Node` 环境中 **没有 `DOM` 和 `BOM` 的 `API`**,即在 `Node` 中无法调用 `DOM` 和 `BOM` 等浏览器内置 `API`
同理,在浏览器中也不能够调用 `Node` 内置 `API`

#### 3.3 Node 学习路径
##### 3.3.1 Node 可以做什么
`Node` 作为一个 JavaScript 的运行环境,仅仅提供了基础的功能和 `API`。然而,基于 `Node` 提供的这些基础能,很多强大
的工具和框架如雨后春笋,层出不穷,所以学会了 `Node` ,可以让前端程序员胜任更多的工作和岗位
1. 基于 [Express 框架](http://www.expressjs.com.cn/),可以快速构建 `Web` 应用
2. 基于 [Electron 框架](https://electronjs.org/),可以构建跨平台的桌面应用
3. 基于 [restify 框架](http://restify.com/),可以快速构建 `API` 接口项目
4. 读写和操作数据库、创建实用的命令行工具辅助前端开发、etc…
##### 3.3.2 Node 学习路径
JavaScript 基础语法 --> **`Node.js` 内置 `API` 模块**(`fs`、`path`、`http` 等) --> **第三方 `API` 模块**(express、`mysql` 等)
#### 3.4 下载并安装 Node
##### 3.4.1 下载 Node 的方式
1. 如果希望通过 `Node.js` 来运行 `Javascript` 代码,则必须在计算机上安装 `Node.js` 环境才行
2. 安装包在 `Node.js` 官网首页直接[下载](https://nodejs.org/en/),点击绿色的按钮,下载所需的版本后,双击直接安装即可

##### 3.4.2 区分 `LTS` 版本和 Current 版本的不同
1. **`LTS `为长期稳定版**,对于追求稳定性的企业级项目来说,推荐安装 `LTS` 版本的 `Node.js`
2. **`Current` 为新特性尝鲜版**,对热衷于尝试新特性的用户来说,推荐安装 `Current` 版本的 `Node.js`。但是,`Current` 版本中可能存在隐藏的 `Bug` 或安全性漏洞,因此不推荐在企业级项目中使用 `Current` 版本的 `Node.js`
#### 3.5 查看已安装的 Node 的版本号
1. 打开终端,在终端输入命令 `node –v` 后,按下回车键,即可查看已安装的 `Node.js` 的版本号
2. Windows 系统快速打开终端的方式:使用快捷键 (Windows徽标键 + R) 打开运行面板,输入 `cmd` 后直接回车,即可打开终端

#### 3.6 什么是终端
1. 终端(英文:Terminal)是专门为开发人员设计的,用于实现人机交互的一种方式
2. 作为一名合格的程序员,我们有必要识记一些常用的终端命令,来辅助我们更好的操作与使用计算机
#### 3.7 Node 环境执行 JavaScript 代码
1. 在项目根目录下打开终端
2. 输入 node 要执行的 `js`文件的路径,例如
```js
node 1.js
```

#### 3.8 更快捷的打开终端
1. 在文件夹地址栏区域,输入 cmd ,既可以打开终端
2. 按照鼠标 shift,同时点击鼠标左键,在此处打开 `powershell`
#### 3.9 终端中的快捷键
在 `Windows` 的 `powershell` 或 `cmd` 终端中,我们可以通过如下快捷键,来提高终端的操作效率:
1. 使用 `↑` 键,可以快速定位到上一次执行的命令
2. 使用 `tab` 键,能够快速补全路径
3. 使用 `esc` 键,能够快速清空当前已输入的命令
4. 输入 `cls` 命令,可以清空终端
---
### 4. `fs` 文件系统
#### 4.1 `fs` 文件系统模块
1. `fs` 模块是 `Node.js` 官方提供的、用来**操作文件**的模块。它提供了一系列的方法和属性,用来满足用户对文件的操作需求
- `fs.readFile()` 方法,用来读取指定文件中的内容
- `fs.writeFile()` 方法,用来向指定的文件中写入内容
2. 如果要在 `JavaScript` 代码中,使用 `fs` 模块来操作文件,则需要使用如下的方式先导入它
```js
const fs = require('fs')
```
#### 4.2 读取指定文件中的内容
##### 4.2.1 `fs.readFile()` 的语法格式
使用 `fs.readFile()` 方法,可以读取指定文件中的内容,语法格式如下:
```js
fs.readFile(path[, options], callback)
```
参数解读:
1. 参数1:必选参数,字符串,表示文件的路径
2. 参数2:可选参数,表示以什么编码格式来读取文件
3. 参数3:必选参数,文件读取完成后,通过回调函数拿到读取的结果
##### 4.2.2 `fs.readFile()` 的示例代码
```js
// 1. 导入 fs 模块
const fs = require('fs')
// 2. 调用 fs.readFile() 方法读取文件
// 参数 1: 读取文件的存放路径
// 参数 2: 读取文件时候的编码格式,一般默认是 utf8
// 参数 3: 回调函数,拿到读取失败和成功的结果, err 以及 data
fs.readFile('./Tom.txt', 'utf8', function (err, data) {
// 3. err
// 如果读取失败,则 err 的值为 null
// 如果读取失败,则 err 的值为错误对象, data 的值为 undefined
console.log(err)
// 4. data 打印成功的结果
console.log(data)
})
```
##### 4.2.3 判断文件是否读取成功
可以判断 err 对象是否为 null,从而知晓文件读取的结果
1. 结果是 null ,说明文件读取成功
2. 如果不为 null,说明文件读取失败
```js
const fs = require('fs')
fs.readFile('./Tom.txt', 'utf8', function (err, data) {
// 判断 err 对象是否为 null
if (err) {
return console.log('文件读取失败:', err.message)
}
console.log('文件读取成功,内容是:', data)
})
```
#### 4.3 向指定的文件中写入内容
##### 4.3.1 `fs.writeFile()` 的语法格式
使用 `fs.writeFile()` 方法,可以向指定的文件中写入内容,语法格式如下
```js
fs.writeFile(file, data[, options], callback)
```
参数解读:
1. 参数1:必选参数,需要指定一个文件路径的字符串,表示文件的存放路径
2. 参数2:必选参数,表示要写入的内容
3. 参数3:可选参数,表示以什么格式写入文件内容,默认值是 `utf8`
4. 参数4:必选参数,文件写入完成后的回调函数
##### 4.3.2 `fs.writeFile()` 的示例代码
```js
// 1. 导入 fs 文件系统模块
const fs = require('fs')
// 2. 调用 fs.writeFile() 方法,写入文件的内容
// 参数 1:表示文件的存放路径
// 参数 2:表示要写入的内容
// 参数 3:回调函数
fs.writeFile('./Tom.txt', ' Jerry', function (err) {
// 3. err
// 3.1 如果文件写入成功,则 err 的值等于 null
// 3.2 如果文件写入失败,则 err 的值等于一个错误对象
console.log(err)
})
```
##### 4.3.3 判断文件是否写入成功
可以判断 err 对象是否为 null,从而知晓文件写入的结果
```js
const fs = require('fs')
fs.writeFile('./Tom.txt', 'Tom And Jerry', function (err) {
if (err) {
return console.log('文件写入失败', err.message)
}
console.log('文件写入成功')
})
```
#### 4.4 `fs` 整理考试成绩案例
##### 4.4.1 需求分析
使用 `fs` 文件系统模块,将素材目录下成绩 `.txt` 文件中的考试数据,整理到 `成绩-ok.txt` 文件中,整理前,`成绩.txt` 文件中的数据格式如下:
```js
小红=99 小白=100 小黄=70 小黑=66 小绿=88
```
整理完成之后,希望得到的 `成绩-ok.txt` 文件中的数据格式如下:
```js
小红: 99
小白: 100
小黄: 70
小黑: 66
小绿: 88
```
##### 4.4.2 实现思路分析
1. 导入需要的 `fs` 文件系统模块
2. 使用 `fs.readFile()` 方法,读取素材目录下的 `成绩.txt` 文件
3. 判断文件是否读取失败
4. 文件读取成功后,处理成绩数据
5. 将处理完成的成绩数据,调用 `fs.writeFile()` 方法,写入到新文件 `成绩-ok.txt` 中
##### 4.4.3 实现步骤
1. 读取成绩文件
```js
// 1. 导入 fs 文件系统
const fs = require('fs')
// 2.调用 fs.rendFile() 读取文件的内容
fs.readFile('./成绩.txt', 'utf8', function (err, data) {
// 3. 判断是否读取成功
if (err) {
return console.log('读取文件失败!', err.message)
}
console.log('读取文件成功', data)
})
```
2. 处理成绩
```js
// 1. 导入 fs 文件系统
const fs = require('fs')
// 2.调用 fs.rendFile() 读取文件的内容
fs.readFile('./成绩.txt', 'utf8', function (err, data) {
// 3. 判断是否读取成功
if (err) {
return console.log('读取文件失败!', err.message)
}
// 4.1 将成绩按照空格进行分割
const oldArr = data.split(' ')
// 4.2 循环分割后的数组,对每一项数据,进行字符串的替换操作
const newArr = []
oldArr.forEach(item => {
// console.log(item)
newArr.push(item.replace('=', ': '))
})
// 4.3 将新数组中的每一项,进行合并,得到一个新的字符串
const newStr= newArr.join('\r\n')
console.log(newStr)
})
```
3. 将整理好的成绩写入到新文件
```js
// 1. 导入 fs 文件系统
const fs = require('fs')
// 2.调用 fs.rendFile() 读取文件的内容
fs.readFile('./成绩.txt', 'utf8', function (err, data) {
// 3. 判断是否读取成功
if (err) {
return console.log('读取文件失败!', err.message)
}
// 4.1 将成绩按照空格进行分割
const oldArr = data.split(' ')
// 4.2 循环分割后的数组,对每一项数据,进行字符串的替换操作
const newArr = []
oldArr.forEach(item => {
// console.log(item)
newArr.push(item.replace('=', ': '))
})
// 4.3 将新数组中的每一项,进行合并,得到一个新的字符串
const newStr= newArr.join('\r\n')
// console.log(newStr)
fs.writeFile('./成绩-ok.txt', newStr, function (err) {
if (err) {
return console.log('文件写入失败' + err.message)
}
console.log('成绩写入成功')
})
})
```
### 5. `fs` 路径问题
#### 5.1 `fs` 模块路径动态拼接的问题
在使用 `fs` 模块操作文件时,如果提供的操作路径是以 `./` 或 `../ `开头的相对路径时,很容易出现路径动态拼接错误的问题
原因:代码在运行的时候,会以`执行 node 命令时所处的目录`,动态拼接出被操作文件的完整路径
解决方案:在使用 `fs` 模块操作文件时,直接提供完整的路径,不要提供 `./` 或 `../` 开头的相对路径,从而防止路径动态拼接的问题
#### 5.2 使用完整路径替换相对路径
使用完整路径替换相对路径,但这种写法移植性比较差,不利于后期的维护
```js
const fs = require('fs')
fs.readFile('F:\\001 - 双元大课程\\009 - 服务器编程node\\003 - Node Code\\Day_001\\Tom.txt', 'utf8', function (err, data) {
// 判断 err 对象是否为 null
if (err) {
return console.log('文件读取失败:', err.message)
}
console.log('文件读取成功,内容是:', data)
})
```
#### 5.3 使用 `__dirname` 解决路径拼接问题
`__dirname` 属性 `Node` 给提供的一个全局的属性,表示当前文件所处的目录
```js
const fs = require('fs')
// __dirname 属性解决路径拼接问题
fs.readFile(__dirname + '/Tom.txt', 'utf8', function (err, data) {
// 判断 err 对象是否为 null
if (err) {
return console.log('文件读取失败:', err.message)
}
console.log('文件读取成功,内容是:', data)
})
```
### 6. `path` 路径模块
#### 6.1 什么是 path 路径模块
1. `path` 模块是 `Node.js` 官方提供的、用来处理路径的模块。它提供了一系列的方法和属性,用来满足用户对路径的处理需求,例如:
- `path.join()` 方法,用来将多个路径片段拼接成一个完整的路径字符串
- `path.basename()` 方法,用来从路径字符串中,将文件名解析出来
2. 如果要在 JavaScript 代码中,使用 path 模块来处理路径,则需要使用如下的方式先导入它
```js
const path = rquire('path')
```
#### 6.2 path 路径拼接
##### 6.2.1 `path.join()` 的语法格式
使用 `path.join()` 方法,可以把多个路径片段拼接为完整的路径字符串,语法格式如下
```js
path.join([...paths])
```
参数解读:
1. `...paths` 路径片段的序列
2. 返回值:
##### 6.2.2 `path.join()` 的代码示例
使用 `path.join()` 方法,可以把多个路径片段拼接为完整的路径字符串
注意:今后凡是涉及到路径拼接的操作,**都要使用 `path.join()` 方法进行处理**。不要直接使用 + 进行字符串的拼接
```js
const fs = require('fs')
const path = require('path')
// 使用 path.join() 做路径分割
fs.readFile(path.join(__dirname, '/Tom.txt'), 'utf8', function (err, data) {
// 判断 err 对象是否为 null
if (err) {
return console.log('文件读取失败:', err.message)
}
console.log('文件读取成功,内容是:', data)
})
```
#### 6.3 获取路径中的文件名
##### 6.3.1 `path.basename()` 的语法格式
使用 `path.basename()` 方法,可以获取路径中的最后一部分,经常通过这个方法获取路径中的文件名,语法格式如下
```js
path.basename(path[, ext])
```
参数解读:
1. path 必选参数,表示一个路径的字符串
2. ext 可选参数,表示文件扩展名
3. 返回: 表示路径中的最后一部分
##### 6.3.2 `path.basename()` 的代码示例
使用 `path.basename()` 方法,可以从一个文件路径中,获取到文件的名称部分
```js
const path = require('path')
const fpath = '/a/b/c/d/index.html' // 文件的存放路径
var fullName = path.basename(fpath)
console.log(fullName) // index.html 打印出文件的名称
var extName = path.basename(fpath, '.html')
console.log(extName) // index 打印文件的名称,但是忽略后缀名
```
#### 6.4 获取路径中的文件扩展名
##### 6.4.1 `path.extname()` 的语法格式
使用 `path.extname()` 方法,可以获取路径中的扩展名部分,语法格式如下
```js
path.extname(path)
```
参数解读:
1. `path` 必选参数,表示一个路径的字符串
2. 返回: 返回得到的扩展名字符串
##### 6.4.2 `path.extname()` 的代码示例
使用 `path.extname()` 方法,可以获取路径中的扩展名部分
```js
const path = require('path')
const fpath = '/a/b/c/d/index.html' // 文件的存放路径
var fullName = path.extname(fpath)
console.log(fullName) // .html 返回文件的拓展名
```
---
### 7. 时钟案例
#### 7.1 案例介绍
1. 案例要实现的功能
2. 案例的实现步骤
- 创建两个正则表达式,分别用来匹配 ` 标签的正则
// \s 表示空白字符 \S 表示非空字符 * 表示匹配任意次
const regStyle = /
const r1 = regStyle.exec(htmlStr)
// 3.3 将提取出来的样式字符串,做进一步的处理
const newCss = r1[0].replace('', '')
// 3.4 将提取出来的 css 样式,写入到 index.css 文件中
fs.writeFile(path.join(__dirname, '/style/index.css'), newCss, err => {
if (err) return console.log('写入 css 样式表失败 !', err.message)
console.log('写入文件成功')
})
}
```
4. 自定义 `resolveJS`方法
```js
// 4.1 处理 js 脚本
function resolveJs (htmlStr) {
// 4.2 使用正则表达式提取出页面中的 标签
const r2 = regScript.exec(htmlStr)
// 4.3 将提取出来的脚本字符串,做进一步处理
const newJs = r2[0].replace('', '')
// 4.4 将提取出来的 js 脚本,写入到 index.js 文件中
fs.writeFile(path.join(__dirname, '/script/index.js'), newJs, err => {
if (err) return console.log('写入 JavaScript 脚本失败', err.message)
console.log('写入脚本文件成功 !')
})
}
```
5. 自定义 `resolveHTML` 方法
```js
// 5.1 处理 html 文件函数
function resolveHtml(htmlStr) {
// 5.2 使用字符串的 replace 方法,把内嵌的 ')
// 5.3 将替补完成之后的 html 代码,写入到 index.html 中
fs.writeFile(path.join(__dirname, '/time.html'), newHtml, err => {
if (err) return console.log('写入文件失败', err.message)
console.log('写入 html 页面成功 !')
})
}
```
6. 案例的两个注意点
- `fs.writeFile()` 方法只能用来创建文件,不能用来创建路径
- 重复调用 `fs.writeFile()` 写入同一个文件,新写入的内容会覆盖之前的旧内容
## Node 第 2 天
### 1. 学习目标
◆ 能够使用 `http` 模块写一个基本的 `web` 服务器
◆ 能够说出模块化的好处
◆ 能够知道 `CommonJS` 规定了哪些内容
◆ 能够说出 `Node.js` 中模块的三大分类各自是什么
◆ 能够使用 `npm` 管理包
### 2. `http` 模块
#### 2.1 什么是 `http` 模块
1. `http` 模块是 `Node.js` 官方提供的、用来创建 `web` 服务器的模块。通过 `http` 模块提供的 `http.createServer()` 方法,就能方便的把一台普通的电脑,变成一台 `Web` 服务器,从而对外提供 `Web` 资源服务
2. 如果要希望使用 `http` 模块创建 `Web` 服务器,则需要先导入它
```js
const http = require('http')
```
#### 2.2 进一步理解 `http` 模块的作用
1. 服务器和普通电脑的区别在于,服务器上安装了 `web` 服务器软件
- 例如:`IIS`、`Apache` 等。通过安装这些服务器软件,就能把一台普通的电脑变成一台 web 服务器
2. 在 `Node.js` 中,我们不需要使用 `IIS`、`Apache` 等这些第三方 `web` 服务器软件。因为我们可以基于 `Node.js` 提供的 `http` 模块,通过几行简单的代码,就能轻松的手写一个服务器软件,从而对外提供 `web` 服务
### 3. 服务器相关的概念
#### 3.1 `ip` 地址
1. `IP 地址`就是互联网上每台计算机的唯一地址,因此 `IP 地址` 具有唯一性
2. `IP 地址` 的格式:通常用“点分十进制”表示成`(a.b.c.d)`的形式,其中,`a,b,c,d` 都是 0~255 之间的十进制整数
- 例如:用点分十进表示的 `IP`地址`(192.168.1.1)`
**注意事项**:
1. **互联网中每台 `Web` 服务器,都有自己的 `IP` 地址**
- 例如:大家可以在 `Windows` 的终端中运行 `ping www.baidu.com` 命令,即可查看到百度服务器的 `IP 地址`
2. 在开发期间,自己的电脑既是一台服务器,也是一个客户端,为了方便测试,可以在自己的浏览器中输入 `127.0.0.1` 这个 `IP 地址`,就能把自己的电脑当做一台服务器进行访问了
#### 3.2 域名和域名服务器
1. 尽管 `IP 地址` 能够唯一地标记网络上的计算机,但 `IP地址` 是一长串数字,不直观,而且不便于记忆,于是人们又发明了另一套字符型的地址方案,即所谓的**域名地址(Domain Name)**
2. `IP地址 `和 `域名` 是一一对应的关系,这份对应关系存放在一种叫做域名服务器 `(DNS,Domain name server)` 的电脑中。使用者只需通过好记的域名访问对应的服务器即可,对应的转换工作由域名服务器实现。因此,**域名服务器就是提供 `IP 地址` 和域名之间的转换服务的服务器**
**注意事项:**
1. 单纯使用 `IP 地址`,互联网中的电脑也能够正常工作。但是有了域名的加持,能让互联网的世界变得更加方便
2. 在开发测试期间, `127.0.0.1` 对应的域名是 `localhost`,它们都代表我们自己的这台电脑,在使用效果上没有任何区别
#### 3.3 端口号
1. 在一台电脑中,可以运行成百上千个 `web 服务`
2. 每个`web 服务` 都对应一个唯一的端口号
3. 客户端发送过来的网络请求,通过端口号,可以被准确地交给对应的 `web 服务` 进行处理

### 4. 创建web服务器
#### 4.1 实现步骤和核心代码
1. 导入 `http 模块`
```js
const http = require('http')
```
2. 创建 `web` 服务器实例
```js
// 调用 http.createServer() 方法,即可快速创建一个 web 服务器实例
const server = http.createServer()
```
3. 为服务器实例绑定 `request` 事件
```js
// 为服务器实例绑定 request 事件,即可监听客户端发送过来的网络请求
// 使用服务器实例的 .on() 方法,为服务器绑定一个 request 事件
server.on('request', (req, res) => {
// 只要有客户端来请求我们自己的服务器,就会被触发 request 事件,从而调用这个事件处理程序
console.log('访问服务器成功')
})
```
4. 启动服务器
```js
// 调用服务器实例的 .listen() 方法,即可启动当前的 web 服务器实例
server.listen(80, () => {
console.log('running……')
})
```
#### 4.2 创建基本的服务器
```js
// 1. 导入 http 模块
const http = require('http')
// 2. 创建 web 服务器实例
const server = http.createServer()
// 3. 为服务器实例绑定 request 事件,监听客户端的请求
server.on('request', function (req, res) {
console.log('访问服务器成功')
})
// 4. 启动服务器
server.listen(8080, function () {
console.log('running……')
})
```
#### 4.3 `req` 请求对象
服务器接收到客户端的请求,就会调用通过 `server.on()` 为服务器绑定的 **request 事件处理程序**,如果想在事件处理程序中,访问与客户端相关的数据和属性,可以使用如下方式:
```js
server.on('request', function (req, res) {
// req 是请求对象,它包含了与客户端相关的数据和属性
// req.url 获取客户端请求的 url 地址
// req.method 获取客户端请求的类型
const str = `${req.url} -- ${req.method}`
console.log(str)
})
```
#### 4.4 `res` 响应对象
在服务器的 request 事件处理程序中,如果想访问与服务器相关的数据和属性,可以使用如下方式
```js
server.on('request', function (req, res) {
// res 是响应对象,它包含了与服务器相关的数据和属性
// 例如:将字符串发送到客户端
const str = `${req.url} -- ${req.method}`
// res.end() 方法的作用
// 向客户端发送指定的内容,并结束这次请求的处理过程
res.end(str)
})
```
#### 4.5 解决中文乱码问题
当调用 `res.end()` 方法,向客户端发送中文内容的时候,会出现乱码问题,此时,需要手动设置内容的编码格式
```js
server.on('request', function (req, res) {
// 发送包含中文的内容
const str = `您请求的 url 地址是:${req.url},请求的 method 类型是:${req.method}`
// 为了防止中文乱码问题,需要设置响应头,
res.setHeader('Content-Type', 'text/html; charset=utf-8')
// 把包含中文的内容返回给客户端
res.end(str)
})
```
### 5. 根据不同的 `url` 响应不同的内容
#### 5.1 核心实现步骤
1. 获取请求的 `url` 地址
2. 设置默认的响应内容为 `404 Not found`
3. 判断用户请求的是否为 `/` 或 `/index.html` 首页
4. 判断用户请求的是否为 `/about.html` 关于页面
5. 设置 `Content-Type` 响应头,防止中文乱码
6. 使用 `res.end()` 把内容响应给客户端
#### 5.2 动态响应内容
```js
server.on('request', function (req, res) {
// 1、获取请求的 url 地址
const url = req.url
// 2、设置默认的内容为 404 Not Found
let content = '404 Not Found
'
// 3、用户请求的是首页
if (url === '/' || url === '/index.html') {
content = '首页
'
} else if (url === '/about.html') {
// 4、用户请求的是关于我们页面
content = '关于我们
'
}
// 5、设置 Content-Type 响应头,防止中文乱码
res.setHeader('Content-Type', 'text/html; charset=utf-8')
// 6、将内容发送给客户端
res.end(content)
})
```
### 6. 时钟 `web` 服务器案例
#### 6.1 核心思路
把文件的实际存放路径,作为每个资源的请求 `url 地址`

#### 6.2 实现思路
1. 导入需要的模块
2. 创建基本的 `web` 服务器
3. 将资源的请求 `url 地址` 映射为文件的存放路径
4. 读取文件内容并响应给客户端
5. 优化资源的请求路径
#### 6.3 实现步骤
1. 导入需要的模块
```js
// 1.1 导入 http 模块
const http = require('http')
// 1.2 导入 fs 文件系统模块
const fs = require('fs')
// 1.3 导入 path 路径处理模块
const path = require('path')
```
2. 创建基本的 web 服务器
```js
// 2.1 创建 web 服务器
const server = http.createServer()
// 2.2 监听 web 服务器的 request 事件
server.on('request', (req, res) => {})
// 2.3 启动 web 服务器
server.listen(80, () => {
console.log('running……')
})
```
3. 将资源的请求 `url` 地址映射为文件的存放路径
```js
server.on('request', (req, res) => {
// 3.1 获取到客户端请求的 url 地址
const url = req.url
// 3.2 把请求的 url 地址,映射为本地文件的存放路径
const fpath = path.join(__dirname, url)
})
```
4. 根据映射过来的文件路径读取文件
```js
// 4.1 根据映射过来的文件路径读取文件
fs.readFile(fpath, 'utf8', (err, dataStr) => {
// 4.2 读取文件失败后,向客户端响应固定的 "错误消息"
if (err) return res.end('404 Not Fount')
// 4.3 读取文件成功后,将 "读取成功的内容" 响应给客户端
res.end(dataStr)
})
```
5. 优化资源的请求路径
```js
// // 3.2 把请求的 url 地址,映射为本地文件的存放路径
// const fpath = path.join(__dirname, url)
// 5.1 预定义空白的文件存放路径
let fpath = ''
if (url === '/') {
// 5.2 如果请求的路径是 / ,则手动指定文件的存放路径
fpath = path.join(__dirname, './clock/index.html')
} else {
// 5.3 如果请求的路径不为 / ,则动态拼接文件的存放路径
fpath = path.join(__dirname, './clock', url)
}
```
### 7. 模块化
#### 7.1 什么是模块化
1. 模块化是指解决一个复杂问题时,自顶向下逐层**把系统划分成若干模块的过程**。对于整个系统来说,**模块是可组合、分解和更换的单元**
2. 编程领域中的模块化,就是**遵守固定的规则**,把一个**大文件**拆成**独立并互相依赖的多个小模块**
3. 把代码进行模块化拆分的好处
- 提高了代码的复用性
- 提高了代码的可维护性
- 可以实现按需加载
#### 7.2 模块化相关的概念
1. 模块化规范就是对代码进行模块化的拆分与组合时,需要遵守的那些规则,例如:
- 使用什么样的语法格式来引用模块
- 在模块中使用什么样的语法格式向外暴露成员
2. 模块化规范的好处:大家都遵守同样的模块化规范写代码,降低了沟通的成本,极大方便了各个模块之间的相互调用,利人利己
### 8. `Node` 中的模块化
#### 8.1 了解 `Node` 中模块的 3 个大类
`Node.js` 中根据模块来源的不同,将模块分为了 3 大类,分别是:
1. 内置模块(内置模块是由 `Node.js` 官方提供的,例如 `fs`、`path`、`http` 等)
2. 自定义模块(用户创建的每个 `.js` 文件,都是自定 义模块)
3. 第三方模块(由第三方开发出来的模块,并非官方提供的内置模块,也不是用户创建的自定义模块,**使用前需要先下载**)
#### 8.2 使用 `require` 方法加载模块
使用强大的 `require()` 方法,可以加载需要的**内置模块**、**用户自定义模块**、**第三方模块**进行使用。例如:
```js
// 1. 加载内置的 fs 模块
const fs = require('fs')
// 2. 加载用户的自定义模块
const custom = require('./custom.js')
// 3. 加载第三方模块,(使用第三方模块,下面会进行讲解)
const moment = require('moment')
```
**注意事项 1: 使用 require() 方法加载其他模块时,会执行被加载模块中的代码**
```js
// 加载模块.js
require('./被加载的模块.js')
```
```js
// 被加载模块.js
console.log('我会被打印')
```
**注意事项2: 在使用 `require` 加载用户自定义模块期间,可以省略 `.js` 后缀名**
```js
// 加载模块.js
require('./被加载的模块')
```
#### 8.3 了解模块作用域的概念以及好处
##### 8.3.1 什么是模块作用域
和函数作用域类似,在自定义模块中定义的变量、方法等成员,只能在当前模块内被访问,外部文件是访问不到的,这种模块级别的访问限制,叫做模块作用域
```js
// 被加载的模块.js
const username = '张三'
function sayHello () {
console.log('说话')
}
```
```js
// 加载模块.js
const custom = require('./被加载的模块')
```
##### 8.3.2 模块作用域的好处
防止了全局变量污染、文件依赖等问题的产生
#### 8.4 `module` 对象
##### 8.4.1 了解 `module` 对象
在每个 `.js` 自定义模块中都有一个 `module` 对象,它里面存储了和当前模块有关的信息,打印如下:

##### 8.4.2 了解 `module.exports` 对象的作用
1. 在自定义模块中,可以使用 `module.exports` 对象,将模块内的成员共享出去,供外界使用
2. 外界用 `require()` 方法导入自定义模块时,得到的就是 `module.exports` 所指向的对象
```js
// 记载模块.js
const mo = require('./被加载的模块')
console.log(mo) // {}
```
```js
// 被加载的模块.js
// 当外界使用 require 导入一个自定义模块的时候,得到的成员,就是模块中,通过 module.exports 指向的那个对象
// console.log('我会被加载')
```
##### 8.4.3 使用 `module.exports` 向外共享成员
```js
// 加载模块.js
const mo = require('./被加载的模块.js')
console.log(mo)
```
```js
// 被加载的模块.js
// 向 module.exports 对象上挂载 username 属性
module.exports.username = 'zs'
// 向 module.exports 对象上挂载 sayHello 方法
module.exports.sayHello = function () {
console.log('Hellp')
}
```
##### 8.4.4 共享成员时的注意点
使用 `require()` 方法导入模块时,导入的结果,永远以 `module.exports` 指向的对象为准
```js
// 加载模块.js
const mo = require('./被加载的模块.js')
console.log(mo) // { username: '小黑', sayHi: [Function: sayHi] }
```
```js
// 被加载模块.js
// 当外界使用 require 导入一个自定义模块的时候,得到的成员,就是模块中,通过 module.exports 指向的那个对象
// console.log(module)
// 向 module.exports 对象上挂载 username 属性
module.exports.username = 'zs'
// 向 module.exports 对象上挂载 sayHello 方法
module.exports.sayHello = function () {
console.log('Hellp')
}
// 使用 module.exports 指向一个全新的对象
module.exports = {
username: '小黑',
sayHi() {
console.log('小黑')
}
}
```
#### 8.5 `exports` 对象
由于 `module.exports` 单词写起来比较复杂,为了简化向外共享成员的代码,`Node` 提供了 `exports` 对象。默认情况下,`exports` 和 `module.exports` 指向同一个对象。最终共享的结果,还是以 `module.exports` 指向的对象为准
```js
console.log(exports)
console.log(module.exports)
// 默认情况下,`exports` 和 `module.exports` 指向同一个对象
console.log(exports === module.exports) // true
```
```js
// 将私有成员共享出去
exports.username = 'zs'
// 直接挂载方法
exports.sayHello = function () {
console.log('Hellp')
}
```
#### 8.6 `exports` 和 `module.exports` 的使用误区
1. 时刻谨记,`require()` 模块时,得到的永远是 `module.exports` 指向的对象
2. **注意:为了防止混乱,建议大家不要在同一个模块中同时使用 `exports` 和 `module.exports`**
```js
exports.username = 'Tom' // 不会被打印
module.exports = {
gender: '男',
age: 22
}
```
```js
module.exports.username = 'Tom'
// 不会被执行
exports = {
gender: '男',
age: 22
}
```
```js
// 两个都会执行
module.exports.username = 'Tom'
exports.gender = '男'
```
```js
// 三个都会打印
exports = {
gender: '男',
age: 22
}
module.exports = exports
module.exports.username = 'Tom'
```
#### 8.7 `CommonJS` 模块化规范
1. `Node.js` 遵循了 `CommonJS` 模块化规范,`CommonJS `规定了**模块的特性和各模块之间如何相互依赖**
2. `CommonJS` 规定:
- 每个模块内部,`module` 变量代表当前模块
- `module` 变量是一个对象,它的 `exports` 属性(即 `module.exports`)是对外的接口
- 加载某个模块,其实是加载该模块的 `module.exports` 属性。require() 方法用于加载模块
### 9. 包
#### 9.1 什么是包
1. `Node.js` 中的第三方模块又叫做包
#### 9.2 包的来源
1. 不同于 `Node.js` 中的内置模块与自定义模块,包是由第三方个人或团队开发出来的,免费供所有人使用
2. 注意: `Node.js` 中的包都是免费且开源的,不需要付费即可免费下载使用
#### 9.3 为什么需要包
1. 由于 `Node.js` 的内置模块仅提供了一些底层的 `API`,导致在基于内置模块进行项目开发的时,效率很低
2. 包是基于内置模块封装出来的,提供了更高级、更方便的 `API`,极大的提高了开发效率
3. 包和内置模块之间的关系,类似于 `jQuery` 和 浏览器内置 `API` 之间的关系
#### 9.4 从哪里下载包
在学习和以后的实际开发中,下载包,都是从 [npm](https://www.npmjs.com/) 这个网站下载
#### 9.5 如何下载包
1. 下载包使用 `npm` ,全名叫做 `Node Package Manager`(简称 `npm` 包管理工具),这个包管理工具随着 `Node.js` 的安装包一起被安装到了用户的电脑上。
2. 可以在终端中执行 `npm -v` 命令,来查看自己电脑上所安装的 `npm` 包管理工具的版本号

### 10. `npm` 初体验
#### 10.1 格式化时间的传统做法
```js
// 格式化时间方法.js
// 1. 定义格式化时间的方法
function dateFormat(dtStr) {
const dt = new Date(dtStr)
const y = dt.getFullYear()
const m = padZero(dt.getMonth() + 1)
const d = padZero(dt.getDate())
const hh = padZero(dt.getHours())
const mm = padZero(dt.getMinutes())
const ss = padZero(dt.getSeconds())
return `${y}-${m}-${d} ${hh}:${mm}:${ss}`
}
// 定义补零的函数
function padZero(n) {
return n > 9 ? n : '0' + n
}
module.exports = {
dateFormat
}
```
```js
// 对时间进行格式化.js
// 导入自定义的格式化时间的模块
const TIME = require('./014 - timeformat')
// 调用方法,进行时间的格式化
const dt = new Date()
// console.log(dt)
const newDT = TIME.dateFormat(dt)
console.log(newDT)
```
#### 10.2 使用第三方包对时间进行格式化
##### 10.2.1 实现思路分析
1. 使用 `npm` 包管理工具,在项目中安装格式化时间的包 `moment`
2. 使用 `require()` 导入格式化时间的包
3. 参考 `moment` 的官方 `API` 文档对时间进行格式化
```js
// 1.moment
const moment = require('moment')
// 2.参考 moment 官方 API 文档,调用对应的方法,对时间进行格式化
// 2.1 调用 moment() 方法,得到当前的事件
// 2.2 针对当前的时间,调用 format() 方法,按照指定的格式进行时间的格式化
const dt = moment().format('YYYY-MM-DD HH:mm:ss')
console.log(dt)
```
##### 10.2.3 `npm install` 命令安装包
1. 如果想在项目中安装指定名称的包,需要运行如下的命令
```js
npm install 包的完整名称
```
2. 上述的装包命令,可以简写成如下格式
```js
npm i 包的完整名称
npm i moment
```
##### 10.2.4 `moment` 对时间格式化
```js
// 1.moment
const moment = require('moment')
// 2.参考 moment 官方 API 文档,调用对应的方法,对时间进行格式化
// 2.1 调用 moment() 方法,得到当前的事件
// 2.2 针对当前的时间,调用 format() 方法,按照指定的格式进行时间的格式化
const dt = moment().format('YYYY-MM-DD HH:mm:ss')
console.log(dt)
```
#### 10.3 `node_modules` 和 `pageage-lock.json` 的作用
初次装包完成后,在项目文件夹下多一个叫做 `node_modules` 的文件夹和 `package-lock.json` 的配置文件,他们的作用是:
1. `node_modules` 文件夹用来存放所有已安装到项目中的包。`require()` 导入第三方包时,就是从这个目录中查找并加载包
2. `package-lock.json` 配置文件用来记录 `node_modules` 目录下的每一个包的下载信息,例如包的名字、版本号、下载地址等
#### 10.4 安装指定版本的包
默认情况下,使用 `npm install` 命令安装包的时候,会自动安装最新版本的包。如果需要安装指定版本的包,可以在包名之后,通过 `@ `符号指定具体的版本,例如:
```js
npm i moment@2.22.2
```
#### 10.5 包的语义化版本
`npm` 规定,在项目根目录中,必须提供一个叫做 `package.json` 的包管理配置文件。用来记录与项目有关的一些配置信息。例如:
1. 项目的名称、版本号、描述等
2. 项目中都用到了哪些包
3. 哪些包只在开发期间会用到
4. 那些包在开发和部署时都需要用到
## Node 第 3 天
### 1. 学习目标
◆ 能够说出模块化的好处
◆ 能够知道 `CommonJS` 规定了哪些内容
◆ 能够说出 `Node.js` 中模块的三大分类各自是什么
◆ 能够使用 `npm` 管理包
◆ 能够了解什么是规范的包结构
◆ 能够了解模块的加载机制
### 2. 包管理配置
#### 2.1 包管理配置的概念
`npm` 规定,在项目根目录中,必须提供一个叫做 `package.json` 的包管理配置文件,用来记录与项目有关的一些配置信息,例如:
- 项目的名称、版本号、描述等
- 项目中都用到了哪些包
- 哪些包只会在开发期间会用到
- 哪些包在开发和部署时都需要用到
#### 2.2 理解 `package.json` 配置文件的作用
##### 2.2.1 多人协作的问题
1. 包的体积
- 整个项目的体积是 `30.4M`
- 第三方包的体积是 `28.8M`
- 项目源代码的体积 `1.6M`
2. 遇到的问题
- 第三方包的体积过大,不方便团队成员之间共享项目源代码
3. 解决方案
- 共享时剔除node_modules

##### 2.2.2 如何记录项目中安装了哪些包
- 在项目根目录中,创建一个叫做 **`package.json`**的配置文件,即可用来记录项目中安装了哪些包。从而方便剔除 `node_modules` 目录之后,在团队成员之间共享项目的源代码
- 今后在项目开发中,一定要把 `node_modules` 文件夹,添加到 `.gitignore` 忽略文件中
#### 2.3 快速创建 `package.json`
`npm` 包管理工具提供了一个快捷命令,可以在执行命令时所处的目录中,快速创建 `package.json` 这个包管理配置文件
```js
npm init
```
注意:
1. 上述命令**只能在英文的目录下成功运行!**所以,项目文件夹的名称**一定要使用英文命名,不要使用中文,不能出现空格**
2. 运行 `npm install` 命令安装包的时候,`npm` 包管理工具会自动把包的名称和版本号,记录到 `package.json` 中
#### 2.4 了解 dependencies 节点的作用
`package.json` 文件中,有一个 `dependencies` 节点,专门用来记录您使用 `npm install` 命令安装了哪些包
```js
// 安装一个包
npm i xxx
// 安装多个包
npm i xxx1 xxx2
```
#### 2.5 一次性安装所有的包
1. 当我们拿到一个剔除了 node_modules 的项目之后,需要先把所有的包下载到项目中,才能将项目运行起来。否则会报类似于下面的错误:
2. 可以运行 `npm install` 命令(或 `npm i`)一次性安装所有的依赖包
#### 2.6 卸载包
1. 可以运行 `npm uninstall` 命令,来卸载指定的包:
2. 注意:`npm uninstall` 命令执行成功后,会把卸载的包,自动从 `package.json` 的 `dependencies` 中移除掉
#### 2.7 了解 `devDependencies` 节点的作用
1. 如果某些包只在项目开发阶段会用到,在项目上线之后不会用到,则建议把这些包记录到 `devDependencies` 节点中
2. 与之对应的,如果某些包在开发和项目上线之后都需要用到,则建议把这些包记录到 `dependencies` 节点中
3. 您可以使用如下的命令,将包记录到 `devDependencies` 节点中
### 3. 解决包下载慢的问题
#### 3.1 分析包下载慢的原因
在使用 `npm` 下包的时候,默认从国外的 [npm](https://registry.npmjs.org/) 服务器进行下载,此时,网络数据的传输需要经过漫长的海底光缆,因此下包速度会很慢
#### 3.2 了解淘宝 `npm` 镜像服务器的作用
1. 淘宝在国内搭建了一个服务器,专门把国外官方服务器上的包同步到国内的服务器,然后在国内提供下包的服务。从而极大的提高了下包的速度
2. 镜像是一种文件存储形式,一个磁盘上的数据在另一个磁盘上存在一个完全相同的副本即为镜像
#### 3.3 切换 `npm` 的下包镜像源
下包的镜像源,指的就是下包的服务器地址
#### 3.4 使用 `nrm` 切换下载包的服务器
为了更方便的切换下包的镜像源,可以安装 `nrm` 这个小工具,利用 `nrm` 提供的终端命令,可以快速查看和切换下包的镜像源
### 4. 包的分类
#### 4.1 项目包
1. 那些被安装到项目的 `node_modules` 目录中的包,都是项目包
2. 项目包又分为两类,分别是:
- 开发依赖包,被记录到 `devDependencies` 节点中的包,只在开发期间会用到
- 核心依赖包,被记录到 `dependencies` 节点中的包,在开发期间和项目上线之后都会用到
#### 4.2 全局包
1. 在执行 `npm install` 命令时,如果提供了 `-g` 参数,则会把包安装为全局包
2. 全局包会被安装到 `C:\Users\用户目录\AppData\Roaming\npm\node_modules` 目录下
3. 注意:
- 只有工具性质的包,才有全局安装的必要性。因为它们提供了好用的终端命令
- 判断某个包是否需要全局安装后才能使用,可以参考官方提供的使用说明即可
#### 4.3 `i5ting_toc` 的安装和使用
1. `i5ting_toc` 是一个可以把 `md` 文档转为 `html` 页面的小工具
### 5. 开发属于自己的包
#### 5.1 规范的包结构
1. 一个规范的包,它的组成结构,必须符合以下 3 点要求:
- 包必须以单独的目录而存在
- 包的顶级目录下要必须包含 `package.json` 这个包管理配置文件
- `package.json` 中必须包含 `name`,`version`,`main` 这三个属性,分别代表包的名字、版本号、包的入口
2. 注意:以上 3 点要求是一个规范的包结构必须遵守的格式,关于更多的约束,可以参考[这个网址](https://yarnpkg.com/zh-Hans/docs/package-json)
#### 5.2 了解需要实现的功能
1. 需要实现的功能
- 格式化日期
- 转移 `HTML` 中的特殊字符
- 还原 `HTML` 中的特殊字符
#### 5.3 初始化包的基础结构
1. 新建 `itheima-tools` 文件夹,作为包的根目录
2. 在 `itheima-tools` 文件夹中,新建如下三个文件:
- `package.json` (包管理配置文件)
- `index.js` (包的入口文件)
- `README.md` (包的说明文档)
#### 5.4 初始化 `package.json` 配置文件
```json
{
"name": "flightloong-tools",
"version": "1.0.0",
"description": "提供格式化时间、HTMLEscape相关功能",
"main": "index.js",
"keywords": [
"itcast",
"itheima",
"dateFormat",
"escape"
],
"license": "ISC"
}
```
#### 5.5 在 `index.js` 中定义格式化时间的方法
```js
// 包的入口文件 index.js
// 定义格式化时间的函数
function dateFormat (dateStr) {
const dt = new Date(dateStr)
const y = padZero(dt.getFullYear())
const m = padZero(dt.getMonth() + 1)
const d = padZero(dt.getDate())
const hh = padZero(dt.getHours())
const mm = padZero(dt.getMinutes())
const ss = padZero(dt.getSeconds())
return `${y}-${m}-${d} ${hh}:${mm}:${ss}`
}
// 定义一个补零的函数
function padZero (n) {
return n > 9 ? n : '0' + n
}
// 向外暴露需要的成员
module.exports = {
dateFormat
}
```
```js
// 测试代码
const itheima = require('./flightloong-tools/index')
// 格式化时间的代码
const dtStr = itheima.dateFormat(new Date())
console.log(dtStr) // 2020-06-23 01:16:57
```
#### 5.6 `package.json` 文件中 `main` 的作用
在导入一个文件的时候,如果没有指定一个特定的文件,但是却能够得到某个包的返回内容,这是因为 `Node` 在使用 `require` 导入某个路径的时候,发现没有具体的文件,就会看这个路径下查看是否有 `package.json` 这个文件,如果有,则查看是否有 `main` 这个属性,如果有,则指定 `main` 属性对应的文件作为要执行的文件
#### 5.7 在 `index.js` 中定义转义 HTML 的方法
```js
// index.js
// 定义转义 HTML 字符的函数
function htmlEscape(htmlstr) {
return htmlstr.replace(/<|>|"|&/g, match => {
switch (match) {
case '<':
return '&glt;'
case '>':
return '>'
case '"':
return '"'
case '&':
return '&'
}
})
}
```
```js
// test.js
const itheima = require('./flightloong-tools/index')
// 转义 Html 字符串
const htmlStr = '这是h4标签123
'
const str = itheima.htmlEscape(htmlStr)
console.log(str)
```
#### 5.8 在 `index.js` 中定义还原 HTML 的方法
```js
// 定义还原 HTML 字符的函数
function htmlUnEscape(str) {
return str.replace(/&glt;|>|"|&/g, (match) => {
switch (match) {
case '&glt;':
return '<'
case '>':
return '>'
case '"':
return '"'
case '&':
return '&'
}
})
}
```
```js
// 还原 Html 字符串
const resetHtml = itheima.htmlUnEscape(str)
console.log(resetHtml)
```
#### 5.9 划分不同的模块
1. 将格式化时间的功能,拆分到 `src` -> `dateFormat.js` 中
2. 将处理 `HTML` 字符串的功能,拆分到 `src` -> `htmlEscape.js` 中
3. 在 `index.js` 中,导入两个模块,得到需要向外共享的方法
4. 在 `index.js` 中,使用 `module.exports` 把对应的方法共享出去
```js
// dateFormat.js
// 定义格式化时间的函数
function dateFormat(dateStr) {
const dt = new Date(dateStr)
const y = padZero(dt.getFullYear())
const m = padZero(dt.getMonth() + 1)
const d = padZero(dt.getDate())
const hh = padZero(dt.getHours())
const mm = padZero(dt.getMinutes())
const ss = padZero(dt.getSeconds())
return `${y}-${m}-${d} ${hh}:${mm}:${ss}`
}
// 定义一个补零的函数
function padZero(n) {
return n > 9 ? n : '0' + n
}
module.exports = {
dateFormat
}
```
```js
// htmlEscape.js
// 定义转义 HTML 字符的函数
function htmlEscape(htmlstr) {
return htmlstr.replace(/<|>|"|&/g, match => {
switch (match) {
case '<':
return '&glt;'
case '>':
return '>'
case '"':
return '"'
case '&':
return '&'
}
})
}
// 定义还原 HTML 字符的函数
function htmlUnEscape(str) {
return str.replace(/&glt;|>|"|&/g, (match) => {
switch (match) {
case '&glt;':
return '<'
case '>':
return '>'
case '"':
return '"'
case '&':
return '&'
}
})
}
module.exports = {
htmlEscape,
htmlUnEscape
}
```
```js
// test.js
const itheima = require('./flightloong-tools/index')
// 格式化时间的代码
const dtStr = itheima.dateFormat(new Date())
console.log(dtStr)
// 转义 Html 字符串
const htmlStr = '这是h4标签123
'
const str = itheima.htmlEscape(htmlStr)
console.log(str)
// 还原 Html 字符串
const resetHtml = itheima.htmlUnEscape(str)
console.log(resetHtml)
```
#### 5.10 编写包的说明文档
1. 包根目录中的 `README.md` 文件,是包的使用说明文档。通过它,我们可以事先把包的使用说明,以 `markdown` 的格式写出来,方便用户参考
2. `README` 文件中具体写什么内容,没有强制性的要求;只要能够清晰地把包的作用、用法、注意事项等描述清楚即可
3. 我们所创建的这个包的 `README.md `文档中,会包含以下 6 项内容
- 安装方式
- 导入方式
- 格式化时间
- 转义 HTML 中的特殊字符
- 还原 HTML 中的特殊字符
- 开源协议
```markdown
### 安装
```
npm i flightloong-tools
```
### 导入
```js
const itheima = require('./flightloong-tools')
```
### 格式化时间
```js
// 调用 dateFormat 对时间进行格式化
const dtStr = itheima.dateFormat(new Date())
// 结果 2020-04-03 17:20:58
console.log(dtStr)
```
### 转义 HTML 中的特殊字符
```js
// 带转换的 HTML 字符串
const htmlStr = '这是h1标签123
'
// 调用 htmlEscape 方法进行转换
const str = itheima.htmlEscape(htmlStr)
// 转换的结果 <h1 title="abc">这是h1标签<span>123 </span></h1>
console.log(str)
```
### 还原 HTML 中的特殊字符
```js
// 待还原的 HTML 字符串
const str2 = itheima.htmlUnEscape(str)
// 输出的结果 这是h1标签123
console.log(str2)
```
### 开源协议
ISC
```
#### 5.11 注册 `npm` 账号
1. 访问 [npm](https://www.npmjs.com/ ) 网站,点击 `sign up` 按钮,进入注册用户界面
2. 填写账号相关的信息:`Full Name`、`Public Email`、`Username`、`Password`
3. 点击 `Create an Account` 按钮,注册账号
4. 登录邮箱,点击验证链接,进行账号的验证
#### 5.12 登录 `npm` 账号
1. `npm` 账号注册完成后,可以在终端中执行 `npm login` 命令,依次输入用户名、密码、邮箱后,即可登录成功
2. **注意:在运行 `npm login` 命令之前,必须先把下包的服务器地址切换为 `npm` 的官方服务器。否则会导致发布包失败!**
#### 5.13 把包发布到 `npm`上
将终端切换到包的根目录之后,运行 `npm publish` 命令,即可将包发布到 `npm` 上(注意:包名不能雷同)
#### 5.14 - 删除已发布的包
1. 运行 `npm unpublish 包名 --force` 命令,即可从 `npm` 删除已发布的包
2. 注意事项
- `npm unpublish` 命令**只能删除 72 小时以内发布的包**
- `npm unpublish` 删除的包,**在 24 小时内不允许重复发布**
- 发布包的时候要慎重,尽量**不要往 `npm` 上发布没有意义的包!**
### 6. 模块的加载机制
#### 6.1 优先从缓存中加载
模块在第一次加载后会被缓存,这意味着多次调用 `require()` 方法不会导致模块的代码被多次执行
注意:不论内置模块、用户自定义模块、还是第三方模块,他们都会优先从缓存中加载,从而提高模块的加载效率
```js
// 自定义模块.js
console.log('ok')
```
```js
require('./自定义模块.js')
require('./自定义模块.js')
require('./自定义模块.js')
```
#### 6.2 内置模块的加载优先级
内置模块是由 `Node.js` 官方提供的模块,**内置模块的加载优先级最高**
例如: `require('fs')` 始终返回内置的 `fs` 模块,即使在 `node_modules` 目录下有名字相同的包也叫做 `fs`
```js
const fs = require('fs') // 始终返回的是内置的 fs 模块
```
#### 6.3 自定义模块的加载机制
1. 使用 require() 加载自定义模块时,必须指定以 `./` 或者 `../` 开头的路径标识符。在加载自定义模块时,如果没有指定 `./` 或 `../` 这样的路径标识符,则 `node` 会把它当作 `内置模块` 或 `第三方模块` 进行加载
2. 在使用 `require()` 导入自定义模块时,如果省略了文件的拓展名,则 `Node` 会按照顺序分别尝试加载以下文件
- 按照 **确切的文件名** 进行加载
- 补全 **`.js` **扩展名进行加载
- 补全 **`.json` ** 扩展名进行加载
- 补全 **`.node`** 扩展名进行加载
- 加载失败,终端报错
#### 6.4 第三方模块的加载机制
1. 如果传递给 `require()` 的模块标识符不是一个内置模块,也没有以 `'./'` 或 `'../'` 开头,则 `Node.js` 会从当前模块的父目录开始,尝试从 `/node_modules` 文件夹中加载第三方模块
2. **如果没有找到对应的第三方模块,则移动到再上一层父目录中,进行加载,直到文件系统的根目录**
3. 假设在 `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`
#### 6.5 目录作为模块
当把目录作为模块标识符,传递给 `require()` 进行加载的时候,有三种加载方式:
1. 在被加载的目录下查找一个叫做 `package.json` 的文件,并寻找 `main` 属性,作为 `require()` 加载的入口
2. 如果目录里没有 `package.json` 文件,或者 `main` 入口不存在或无法解析,则 `Node.js` 将会试图加载目录下的 `index.js` 文件
3. 如果以上两步都失败了,则 `Node.js` 会在终端打印错误消息,报告模块的缺失:`Error: Cannot find module xxx`
### 7. 初始 express
#### 7.1 express 简介
##### 7.1.1 什么是 express
1. 官方给出的概念:`Express` 是基于 `Node.js` 平台,快速、开放、极简的 `Web` 开发框架,[官方]( http://www.expressjs.com.cn/)
2. 通俗的理解:`Express` 的作用和 `Node.js` 内置的 `http` 模块类似,是专门用来创建 Web 服务器的
3. `Express` 的本质:就是一个 `npm` 上的第三方包,提供了快速创建 Web 服务器的便捷方法
##### 7.1.2 进一步理解 Express
1. 思考:不使用 Express 能否创建 Web 服务器?
- 答案:能,使用 `Node.js` 提供的原生 `http` 模块即可
2. 思考:既生瑜何生亮(有了 `http` 内置模块,为什么还有用 `Express`)?
- 答案:`http` 内置模块用起来很复杂,开发效率低;`Express` 是基于内置的 `http` 模块进一步封装出来的,能够- 极大的提高开发效率
3. 思考:`http` 内置模块与 `Express` 是什么关系?
- 答案:类似于浏览器中 `Web API` 和 `jQuery` 的关系。后者是基于前者进一步封装出来的
##### 7.1.3 Express 能做什么
1. 对于前端程序员来说,最常见的两种服务器,分别是:
- **`Web` 网站服务器**:专门对外提供 `Web` 网页资源的服务器。
- **`API` 接口服务器**:专门对外提供 `API ` 接口的服务器。
2. 使用 `Express`,我们可以方便、快速的创建 `Web` 网站的服务器或 `API` 接口的服务器。
#### 7.2 Express 的基本使用
1. 安装
在项目所处的目录中,运行如下的终端命令,即可将 express 安装到项目中使用
```js
npm i express
```
2. 创建基本的 Web 服务器
```js
// 1.导入 express
const express = require('express')
// 2. 创建 web 服务器
const app = express()
// 3. 调用 app.listen(端口号, 启动后的回调函数), 启动服务器
app.listen(3000, () => {
console.log('running……')
})
```
#### 7.3 监听 GET 和 POST 请求,并影响客户端
1. 监听 `GET` 请求
- 通过 `app.get()` 方法,可以监听客户端的 GET 请求,具体的语法格式如下
2. 监听 `POST` 请求
- 通过 `app.post()` 方法,可以监听客户端的 POST 请求,具体的语法格式如下
3. 把内容响应给客户端
- 通过 `res.send()` 方法,可以把处理好的内容,发送给客户端
4. 完整代码
```js
// 1.导入 express
const express = require('express')
// 2. 创建 web 服务器
const app = express()
// 4. 监听客户端的 GET 和 Post 请求,并向客户端响应具体的内容
app.get('/user', (req, res) => {
// 调用 express 提供的 res.send() 方法,向客户端响应一个 JSON 对象
res.send({ name: 'zs', age: 20, gender: '男' })
})
app.post('/user', (req, res) => {
// 调用 express 提供的 res.send() 方法,向客户端响应一个文本字符串
res.send('请求成功')
})
// 3. 调用 app.listen(端口号, 启动后的回调函数), 启动服务器
app.listen(3000, () => {
console.log('running……')
})
```
#### 7.4 获取 URL 中携带的查询参数
1. 通过 `req.query` 对象,可以访问到客户端通过查询字符串的形式,发送到服务器的参数
2. 完整代码
```js
const express = require('express')
const app = express()
app.get('/', (req, res) => {
// 通过 req.query 可以获取到客户端发送过来的,查询参数
// 注意:默认情况下, req.query 是一个空对象
console.log(req.query)
res.send(req.query)
})
app.listen(3000, () => {
console.log('running……')
})
```
#### 7.5 获取 URL 中的动态参数
1. 通过 `req.params` 对象,可以访问到 `URL` 中,通过 : 匹配到的动态参数
2. 补充知识点
- `/:id` -- id 值不是固定的,可以自己定义,例如: `/:ids`
- 展示到页面中的 `id` 键,是自定义的变量值
- 参数可以有多个,例如: `/:ids/:name`
3. 完整代码
```js
const express = require('express')
const app = express()
// 注意:这里的 :id 是一个动态的参数
app.get('/user/:id', (req, res) => {
// req.params 是动态匹配到的 URL 参数,默认也会是一个空对象
console.log(req.params)
res.send(req.params)
})
app.listen(3000, () => {
console.log('running……')
})
```
#### 7.6 托管静态资源
##### 7.6.1 `express.static()`
1. `express` 提供了一个非常好用的函数,叫做 `express.static()`,通过它,我们可以非常方便地创建一个静态资源服务器,
例如,通过如下代码就可以将 `public` 目录下的图片、`CSS` 文件、`JavaScript` 文件对外开放访问了
现在,你就可以访问 public 目录中的所有文件了:
访问图片资源:http://localhost:3000/images/bg.jpg
访问 `css` 资源:http://localhost:3000/css/style.css
访问 `js` 资源:http://localhost:3000/js/login.js
2. 注意:`Express` 在指定的静态目录中查找文件,并对外提供资源的访问路径。因此,存放静态文件的目录名不会出现在 `URL` 中
3. 完整代码
```js
const express = require('express')
const app = express()
// 在这里,调用 express.static() 方法,快速的对外提供静态资源
app.use(express.static('public'))
app.listen(3000, () => {
console.log('running……')
})
```
##### 7.6.2 托管多个静态资源目录
1. 如果要托管多个静态资源目录,请多次调用 `express.static()` 函数,
访问静态资源文件时,`express.static()` 函数会根据目录的添加顺序查找所需的文件
2. 完整代码
```js
const express = require('express')
const app = express()
// 在这里,调用 express.static() 方法,快速的对外提供静态资源
app.use(express.static('public'))
app.use(express.static('static'))
app.listen(3000, () => {
console.log('running……')
})
```
##### 7.6.3 挂载路径前缀
1. 如果希望在托管的静态资源访问路径之前,挂载路径前缀,则可以使用如下的方式
可以通过带有 `/public` 前缀地址来访问 public 目录中的文件了:
http://localhost:3000/public/images/kitten.jpg
http://localhost:3000/public/css/style.css
http://localhost:3000/public/js/app.js
2. 完整代码
```js
const express = require('express')
const app = express()
// 在这里,调用 express.static() 方法,快速的对外提供静态资源
app.use('/static', express.static('public'))
app.listen(3000, () => {
console.log('running……')
})
```
#### 8. 安装 `nodemon`
#### 8.1 安装 `nodemon`
1. 为什么要使用 `nodemon`
在编写调试 `Node.js` 项目的时候,如果修改了项目的代码,则需要频繁的手动 `close` 掉,然后再重新启动,非常繁琐。现在,我们可以使用 [nodemon](https://www.npmjs.com/package/nodemon) 这个工具,它能够监听项目文件的变动,当代码被修改后,`nodemon` 会自动帮我们重启项目,极大方便了开发和调试
2. 安装 `nodemon`
```js
npm i nodemon -g
```
#### 8.2 使用 `nodemon` 实现后台项目的重启
1. 当基于 `Node.js` 编写了一个网站应用的时候,传统的方式,是运行 `node app.js` 命令,来启动项目
这样做的坏处是:代码被修改之后,需要手动重启项目
2. 将 `node` 命令替换为 `nodemon` 命令,使用 `nodemon app.js` 来启动项目
这样做的好处是:代码被修改之后,会被 `nodemon` 监听到,从而实现自动重启项目的效果
```js
// 使用 node 运行项目
node app.js
// 使用 nodemon 运行项目
nodemon index.js
```
## Node 第 4 天
### 1. 学习目标
◆ Express 路由
◆ Express 中间件
◆ 使用 Express 写接口
### 2. Express 路由
#### 2.1 路由的概念
1. 路由就是**映射关系**
2. 根据不同的用户 URL 请求,返回不同的内容
3. 本质:URL 请求地址与服务器资源之间的对应关系
#### 2.2 Express 中的路由
1. 在 `Express` 中,路由指的是**客户端的请求**与**服务器处理函数**之间的**映射关系**
2. Express 中的路由分 3 部分组成,分别是**请求的类型**、**请求的 URL 地址**、**处理函数**
3. Express 中的路由的例子
#### 2.3 路由的匹配过程
1. 每当一个请求到达服务器之后,**需要先经过路由的匹配**,只有匹配成功之后,才会调用对应的处理函数
2. 在匹配时,会按照路由的顺序进行匹配,如果**请求类型**和**请求的 URL **同时匹配成功,则 `Express` 会将这次请求,转交给对应的 function 函数进行处理
3. 路由匹配的注意点
- 按照定义的**先后顺序**进行匹配
- **请求类型**和**请求的URL**同时匹配成功,才会调用对应的处理函数
#### 2.4 Express 路由最简单的用法
1. 在 `Express` 中使用路由最简单的方式,就是把路由挂载到 `app` 上
2. 案例代码
```js
const express = require('express')
// 创建 web 服务器,命名为 app
const app = express()
// 挂载路由
app.get('/', (req, res) => {
res.send('Hello, World')
})
app.post('/', (req, res) => {
res.send('Hello, Tom')
})
app.listen(3000, () => {
console.log('running……')
})
```
#### 2.5 模块化路由
1. 为了方便对路由进行模块化的管理,`Express` 不建议将路由直接挂载到 `app` 上,而是推荐将路由抽离为单独的模块,将路由抽离为单独模块的步骤如下
- 创建路由模块对应的 `.js` 文件
- 调用 `express.Router()`函数创建路由对象
- 向路由对象上挂载具体的路由
- 使用 `module.exports` 向外共享路由对象
- 使用 `app.use()` 函数注册路由模块
2. 案例代码
```js
// 1. 导入 express
const express = require('express')
// 2. 创建路由对象
const router = express.Router()
// 3. 挂载获取用户列表的路由
router.get('/user/list', (req, res) => {
res.send('用户列表')
})
// 4. 挂载添加用户列表的路由
router.post('/user/add', (req, res) => {
res.send('添加用户')
})
// 5. 向外导出路由对象
module.exports = router
```
#### 2.6 注册路由模块
1. 导入路由模块
2. 使用 `app.use()` 注册路由模块
3. 案例代码
```js
const express = require('express')
const app = express()
// 导入路由模块
const userRouter = require('./002-router')
// 使用 app.use() 注册路由模块
app.use(userRouter)
app.listen(3000, () => {
console.log('running……')
})
```
#### 2.7 为路由模块添加前缀
1. 类似于托管静态资源写法,为静态资源统一挂载访问前缀一样
2. 注意,添加了路由前缀后,访问的路由的时候,也应该加上前缀
3. 案例代码
```js
const express = require('express')
const app = express()
// 导入路由模块
const userRouter = require('./002-router')
// 使用 app.use() 注册路由模块
// 给路由模块添加统一得到访问前缀 /api
app.use('/api', userRouter)
app.listen(3000, () => {
console.log('running……')
})
```
### 3. 中间件
#### 3.1 中间件的概念
1. 什么是中间件
所谓的中间件(`Middleware` ),特指业务流程的中间处理环节
2. 现实生活中的例子
在处理污水的时候,一般都要经过三个处理环节,从而保证处理过后的废水,达到排放标准
处理污水的这三个中间处理环节,就可以叫做中间件
#### 3.2 Express 中间件的调用流程
当一个请求到达 Express 的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理
#### 3.3 Express 中间件的格式
1. Express 的中间件,**本质上就是一个 `function` 处理函数**,`Express` 中间件的格式如下
2. 注意:中间件函数的形参列表中,**必须包含 next 参数**。而路由处理函数中只包含 `req` 和 `res`
#### 3.4 next 函数的作用
**next 函数**是实现**多个中间件连续调用**的关键,它表示把流转关系**转交**给下一个**中间件**或**路由**
#### 3.5 定义中间件函数
- 定义一个最简单的中间件函数
```js
const express = require('express')
const app = express()
// 定义一个最简单的中间件函数
const kw = () => {
console.log('这是最简单的中间件函数')
// 把流转关系,转交给下一个中间件或者路由
next()
}
app.listen(80, () => {
console.log('running……')
})
```
#### 3.6 全局生效的中间件
1. 客户端发起的**任何请求**,到达服务器之后,都会触发的中间件,叫做全局生效的中间件
2. 通过调用 `app.use(中间件函数)`,即可顶一个全局生效的中间件
```js
const express = require('express')
const app = express()
// 定义一个最简单的中间件函数
const kw = (req, res, next) => {
console.log('这是最简单的中间件函数')
// 把流转关系,转交给下一个中间件或者路由
next()
}
// 全局生效的中间件
app.use(kw)
app.get('/', (req, res) => {
console.log('调用了 / 这个路由')
res.send('Home page')
})
app.get('/user', (req, res) => {
console.log('调用了 /user 这个路由')
res.send('User page')
})
app.listen(3000, () => {
console.log('running……')
})
```
#### 3.7 定义全局中间件的简化形式
1. 定义全局中间件也可以将中间件函数直接挂载到 `app.use()` 上面
```js
const express = require('express')
const app = express()
// 定义全局中间件的简化形式
app.use((req, res, next) => {
console.log('定义全局中间件的简化形式')
next()
})
app.get('/', (req, res) => {
console.log('调用了 / 这个路由')
res.send('Home page')
})
app.get('/user', (req, res) => {
console.log('调用了 /user 这个路由')
res.send('User page')
})
app.listen(3000, () => {
console.log('running……')
})
```
#### 3.8 中间件的作用
1. 多个中间件之间,共享同一份 `req` 和 `res`,基于这样的特性,我们可以在**上游** 的中间件中,统一为 `req` 或 `res` 对象添加自定义的属性和方法,供下游的中间件或路由进行使用
2. 案例代码
```js
const express = require('express')
const app = express()
// 定义全局中间件的简化形式
app.use((req, res, next) => {
// 获取到请求达到服务器的时间
const time = Date.now()
// 为 req 对象,挂载自定义属性,从而把时间共享给后面的所有路由
req.startTime = time
next()
})
app.get('/', (req, res) => {
res.send('Home page' + req.startTime)
})
app.get('/user', (req, res) => {
res.send('User page' + req.startTime)
})
app.listen(3000, () => {
console.log('running……')
})
```
#### 3. 9 定义多个全局中间件
1. 可以使用 `app.use()` 连续定义多个全局中间件,客户端请求到达服务器之后,会按照中间件定义的先后顺序依次执行
2. 案例代码
```js
const express = require('express')
const app = express()
// 第一个全局中间件
app.use((req, res, next) => {
console.log('调用了第一个全局的中间件')
next()
})
// 第二个全局中间件
app.use((req, res, next) => {
console.log('调用了第二个全局的中间件')
next()
})
// 定义路由
// 请求这两个路由,会依次触发上述两个全局中间件
app.get('/user', (req, res) => {
res.send('User Page')
})
app.listen(3000, () => {
console.log('running……')
})
```
#### 3.10 局部生效的中间件
1. 不使用 `app.use()` 定义的中间件,叫做局部生效的中间件
2. 案例代码
```js
const express = require('express')
const app = express()
// 定义中间件函数 mv1
const mv1 = (req, res, next) => {
console.log('这是中间件函数')
next()
}
// mv1 这个中间件只在 "当前路由中生效",这种用法属于 "局部生效的中间件"
app.get('/', mv1, (req, res) => {
res.send('Home Page')
})
app.get('/user', (req, res) => {
res.send('User Page')
})
app.listen(3000, () => {
console.log('running……')
})
```
#### 3.11 定义多个局部中间件
1. 可以在路由中,通过如下两种等价的方式,使用多个局部中间件
2. 案例代码
```js
const express = require('express')
const app = express()
// 定义中间件函数 mv1
const mv1 = (req, res, next) => {
console.log('这是第一个中间件函数')
next()
}
// 定义中间件函数 mv2
const mv2 = (req, res, next) => {
console.log('这是第二个中间件函数')
next()
}
// mv1、mv2 这个中间件只在 "当前路由中生效",这种用法属于 "局部生效的中间件"
app.get('/', mv1, mv2, (req, res) => {
res.send('Home Page')
})
// 也可以使用数组的形式绑定两个中间件
app.get('/user', [mv1, mv2], (req, res) => {
res.send('Home Page')
})
app.listen(3000, () => {
console.log('running……')
})
```
#### 3.12 中间件的5个使用注意事项
1. 一定要在路由之前注册中间件
2. 客户端发送过来的请求,可以连续调用多个中间件进行处理
3. 执行完中间件的业务代码之后,不要忘记调用 `next()` 函数
4. 为了防止代码逻辑混乱,调用 `next()` 函数后不要再写额外的代码
5. 连续调用多个中间件时,多个中间件之间,共享 `req` 和 `res` 对象
### 4. 中间件的分类
#### 4.1 中间件的分类
##### 4.1.1 中间件的分类
1. 为了方便大家理解和记忆中间件的使用,Express 官方把常见的中间件用法,分成了 5 大类,分别是
- 应用级别的中间件
- 路由级别的中间件
- 错误级别的中间件
- Express 内置的中间件
- 第三方的中间件
##### 4.1.2 什么是应用级别的中间件
通过 `app.use()` 或 `app.get()` 或 `app.post()` ,**绑定到 `app` 实例上的中间件**,叫做应用级别的中间件
##### 4.1.3 什么是路由级别的中间件
1. 绑定到 `express.Router()` 实例上的中间件,叫做路由级别的中间件
2. 用法上和应用级别中间件没有任何区别,只不过,应用级别中间件是绑定到 `app` 实例上,路由级别中间件绑定到 `router` 实例上
#### 4.2 错误级别中间件
1. 错误级别中间件的作用: 专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题
2. 格式:错误级别中间件的 function 处理函数中,必须有 4 个形参,形参顺序从前到后,分别是`(err, req, res, next)`
3. **注意: 错误级别的中间件,必须注册在所有路由之后**
4. 案例代码:
```js
const express = require('express')
const app = express()
// 1. 路由
app.get('/', (req, res) => {
// 1.1 抛出一个自定义的错误
throw new Error('服务器内部发生了错误')
res.send('Home Page.')
})
// 2. 错误级别的中间件
// 注意:错误级别的中间件,必须注册在所有路由之后
app.use((err, req, res, next) => {
// 2.1 在服务器打印错误消息
console.log('发生了错误:' + err.message)
// 2.2 向客户端响应错误相关的内容
res.send(err.message)
})
app.listen(3000, () => {
console.log('running……')
})
```
#### 4.3 Express内置的中间件
自 `Express 4.16.0` 版本开始,`Express` 内置了 3 个常用的中间件,极大的提高了 `Express` 项目的开发效率和体验
1. `express.static` 快速托管静态资源的内置中间件,例如: HTML 文件、图片、`CSS` 样式等(无兼容性)
2. `express.json` 解析 `JSON` 格式的请求体数据(**有兼容性**,仅在 `4.16.0+` 版本中可用)
3. `express.urlencoded` 解析 `URL-encoded` 格式的请求体数据(**有兼容性**,仅在 `4.16.0+` 版本中可用)
#### 4.4 `express.json` 中间件的使用
1. `express.json()` 中间件,解析表单中的 `JSON` 格式的数据
2. 案例代码
```js
const express = require('express')
const app = express()
// 注意:除了错误级别的中间件,其他的中间件,必须在路由之前进行配置
// 通过 express.json() 这个中间件,解析表单中的 JSON 格式的数据
app.use(express.json())
app.post('/user', (req, res) => {
// 在服务器,可以使用 req.body 这个属性,来接收客户端发送过来的请求体数据
// 默认情况下,如果不配置解析表单数据中间件,则 req.body 默认等于 undefined
console.log(req.body)
res.send('ok')
})
app.listen(3000, () => {
console.log('running……')
})
```
#### 4.5 `express.urlencoded` 中间件的使用
1. `express.urlencoded` 解析 `URL-encoded` 格式的请求体数据
2. 案例代码
```js
const express = require('express')
const app = express()
// 通过 express.urlencoded() 这个中间件,来解析表单中的 url-encoded 格式的数据
app.use(express.urlencoded({ extended: false }))
app.post('/book', (req, res) => {
console.log(req.body)
res.send(req.body)
})
app.listen(3000, () => {
console.log('running……')
})
```
#### 4.6 第三方的中间件
##### 4.6.1 什么是第三方中间件
1. 非 `Express` 官方内置,而是由第三方开发出来的中间件,叫做第三方中间件。在项目中,大家可以按需下载并配置第三方中间件,从而提高项目的开发效率
2. 例如:在 `express@4.16.0` 之前的版本中,经常使用 `body-parser` 这个第三方中间件,来解析请求体数据。使用步骤如下
- 运行 `npm install body-parser` 安装中间件
- 使用 `require` 导入中间件
- 调用 `app.use()` 注册并使用中间件
3. **注意:`Express` 内置的 `express.urlencoded` 中间件,就是基于 `body-parser` 这个第三方中间件进一步封装出来的**
4. 案例代码
```js
const express = require('express')
const app = express()
// 1. 导入解析表单数据的中间件 body-parser
const bodyParser = require('body-parser')
// 通过 express.urlencoded() 这个中间件,来解析表单中的 url-encoded 格式的数据
// app.use(express.urlencoded({ extended: false }))
// 2. 使用 app.use() 注册中间件
app.use(bodyParser.urlencoded({ extended: false }))
app.post('/book', (req, res) => {
console.log(req.body)
res.send(req.body)
})
app.listen(3000, () => {
console.log('running……')
})
```
### 5. 自定义中间件
#### 5.1 需求描述与实现步骤
##### 5.1.1 需求以及实现步骤
1. 需求描述: 自己手动模拟一个类似于 `express.urlencoded` 这样的中间件,来解析 **`POST 提交到服务器的表单数据`**
2. 实现步骤:
- 定义中间件
- 监听 `req` 的 `data` 事件
- 监听 `req` 的 `end` 事件
- 使用 `querystring` 模块解析请求体数据
- 将解析出来的数据对象挂载为 `req.body`
- 将自定义中间件封装为模块
##### 5.1.2 定义中间件
1. 使用 `app.use()` 来定义全局生效的中间件
2. 代码如下:
3. 案例代码
```js
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// 解析表单数据的中间件
app.use((req, res, next) => {
// 定义中间价具体的业务逻辑
})
// 调用 app.listen方法,指定端口号并启动 web 服务器
app.listen(3000, () => {
console.log('running……')
})
```
#### 5.2 监听 `req` 的 `data` 事件
1. 在中间件中,需要监听 `req` 对象的 `data` 事件,来获取客户端发送到服务器的数据
2. 如果数据量比较大,无法一次性发送完毕,则客户端会把数据切割后,分批发送到服务器。所以 `data` 事件可能会触发多次,每一次触发 `data` 事件时,获取到数据只是完整数据的一部分,需要手动对接收到的数据进行拼接
3. 代码如下:
4. 案例代码
```js
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// 解析表单数据的中间件
app.use((req, res, next) => {
// 定义中间价具体的业务逻辑
// 1. 定义一个 str 字符串,专门用来存储客户端发送过来的请求体数据
let str = ''
// 2. 监听 req 的 data 事件
req.on('data', (chunk) => {
str += chunk
})
})
// 调用 app.listen方法,指定端口号并启动 web 服务器
app.listen(3000, () => {
console.log('running……')
})
```
#### 5.3 监听 `req` 的 `end` 事件
1. 当请求体数据接收完毕之后,会自动触发 `req` 的 `end` 事件
2. 我们可以在 `req` 的 `end` 事件中,拿到并处理完整的请求体数据
3. 代码如下
4. 案例代码
```js
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// 解析表单数据的中间件
app.use((req, res, next) => {
// 定义中间价具体的业务逻辑
// 1. 定义一个 str 字符串,专门用来存储客户端发送过来的请求体数据
let str = ''
// 2. 监听 req 的 data 事件
req.on('data', (chunk) => {
str += chunk
})
// 3. 监听 req 的 end 事件
req.on('end', () => {
// 在 str 中存放的是完整的请求体数据
console.log(str)
// 将字符串格式的请求体数据,解析成对象
})
})
app.post('/user', (req, res) => {
res.send('ok')
})
// 调用 app.listen方法,指定端口号并启动 web 服务器
app.listen(3000, () => {
console.log('running……')
})
```
#### 5.4 用 `querystring` 模块解析请求体数据
1. `Node.js` 内置了一个 `querystring` 模块,专门用来处理查询字符串。通过这个模块提供的 `parse()` 函数,可以轻松把查询字符串,解析成对象的格式
2. 代码如下
3. 案例代码
```js
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// 4. 导入 Node 内置模块 querystring
const qs = require('querystring')
// 解析表单数据的中间件
app.use((req, res, next) => {
// 定义中间价具体的业务逻辑
// 1. 定义一个 str 字符串,专门用来存储客户端发送过来的请求体数据
let str = ''
// 2. 监听 req 的 data 事件
req.on('data', (chunk) => {
str += chunk
})
// 3. 监听 req 的 end 事件
req.on('end', () => {
// 在 str 中存放的是完整的请求体数据
console.log(str)
// 将字符串格式的请求体数据,解析成对象
// 5. 调用 qs.parse() 方法,将查询字符串解析成对象
const body = qs.parse(str)
console.log(body)
})
})
app.post('/user', (req, res) => {
res.send('ok')
})
// 调用 app.listen方法,指定端口号并启动 web 服务器
app.listen(3000, () => {
console.log('running……')
})
```
#### 5.5 将解析出来的数据对象挂载为 `req.body`
1. **上游的中间件和下游的中间件及路由之间,共享同一份 `req` 和 `res`**,因此,我们可以将解析出来的数据,挂载为 `req` 的自定义属性,命名为 `req.body`,供下游使用
2. 代码如下
3. 案例代码
```js
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// 4. 导入 Node 内置模块 querystring
const qs = require('querystring')
// 解析表单数据的中间件
app.use((req, res, next) => {
// 定义中间价具体的业务逻辑
// 1. 定义一个 str 字符串,专门用来存储客户端发送过来的请求体数据
let str = ''
// 2. 监听 req 的 data 事件
req.on('data', (chunk) => {
str += chunk
})
// 3. 监听 req 的 end 事件
req.on('end', () => {
// 在 str 中存放的是完整的请求体数据
console.log(str)
// 将字符串格式的请求体数据,解析成对象
// 5. 调用 qs.parse() 方法,将查询字符串解析成对象
const body = qs.parse(str)
// 6. 将解析出来的数据对象挂载为 req.body 属性
req.body = body
next()
})
})
app.post('/user', (req, res) => {
res.send(req.body)
})
// 调用 app.listen方法,指定端口号并启动 web 服务器
app.listen(3000, () => {
console.log('running……')
})
```
#### 5.6 将自定义中间件封装为模块
1. 为了优化代码的结构,我们可以把自定义的中间件函数,封装为独立的模块
2. 代码如下:
3. 案例代码
```js
// custom-body-parser.js
const qs = require('querystring')
const bodyParser = (req, res, next) => {
// 定义中间价具体的业务逻辑
// 1. 定义一个 str 字符串,专门用来存储客户端发送过来的请求体数据
let str = ''
// 2. 监听 req 的 data 事件
req.on('data', (chunk) => {
str += chunk
})
// 3. 监听 req 的 end 事件
req.on('end', () => {
// 在 str 中存放的是完整的请求体数据
console.log(str)
// 将字符串格式的请求体数据,解析成对象
// 5. 调用 qs.parse() 方法,将查询字符串解析成对象
const body = qs.parse(str)
// 6. 将解析出来的数据对象挂载为 req.body 属性
req.body = body
next()
})
}
module.exports = bodyParser
```
```js
// 对自定义的中间件进行模块化拆分
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// 1. 导入自己封装的中间件模块
const customBodyParser = require('./017-custom-body-parser')
// 2. 将自定义的中间件函数,注册为全局可用的中间件
app.use(customBodyParser)
app.post('/user', (req, res) => {
res.send(req.body)
})
// 调用 app.listen方法,指定端口号并启动 web 服务器
app.listen(3000, () => {
console.log('running……')
})
```
### 6. 基于 Express 写接口
#### 6.1 创建基本的服务器
```js
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// 调用 app.listen 方法,指定端口号并启动 web 服务器
app.listen(3000, () => {
console.log('running……')
})
```
#### 6.2 创建 API 路由模块
```js
// router.js
const express = require('express')
const router = express.Router()
// 在这里挂载对应的路由
module.exports = router
```
```js
// index.js
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// 导入路由模块
const router = require('./router.js')
// 把路由模块,注册到 app 上
app.use('/api', router)
// 调用 app.listen 方法,指定端口号并启动 web 服务器
app.listen(3000, () => {
console.log('running……')
})
```
#### 6.3 编写 get 请求
```js
const express = require('express')
const router = express.Router()
// 在这里挂载对应的路由
router.get('/book', (req, res) => {
// 通过 req.query 获取客户端通过查询字符串发送到服务器的数据
const query = req.query
// 调用 res.send() 方法,想客户端响应处理的结果
res.send({
status: 0, // 0 表示处理成功,1 表示处理失败
msg: 'GET 请求成功', // 状态描述
data: query // 需要响应给客户端的数据
})
})
module.exports = router
```
#### 6.4 编写 post 请求
**注意:如果要获取 URL-encoded 格式的请求体数据,必须配置中间件 `app.use(express.urlencoded({ extended: false }))`**
```js
const express = require('express')
const router = express.Router()
// 在这里挂载对应的路由
// 定义 POST 接口
router.post('/book', (req, res) => {
// 通过 req.body 获取请求题中包含的 url-encoded 格式的数据
const body = req.body
// 调用 res.send() 方法,向客户端响应结果
res.send({
status: 0,
msg: 'Post 请求成功',
data: body
})
})
module.exports = router
```
```js
// index.js
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// 配置解析表单数据的中间件
//注意:如果要获取 URL-encoded 格式的请求体数据,必须配置中间件 app.use(express.urlencoded({ extended: false }))
app.use(express.urlencoded({ extended: false }))
// 导入路由模块
const router = require('./020-apiRouter')
// 把路由模块,注册到 app 上
app.use('/api', router)
// 调用 app.listen 方法,指定端口号并启动 web 服务器
app.listen(3000, () => {
console.log('running……')
})
```
### 7. `cors`
#### 7.1 接口的跨域问题
1. 到目前为止,我们编写的 `GET` 和 `POST` 接口,存在一个很严重的问题:**不支持跨域请求**
2. 解决接口跨域问题的方案主要有两种
- **CORS** (主流的解决方案,推荐使用)
- **JSONP** (有缺陷的解决方案:只支持 GET 请求)
3. 代码演示
```html
Document
```
4. 报错提示
#### 7.2 使用 cors 中间件解决跨域问题
1. cors 是 Express 的一个第三方中间件。通过安装和配置 cors 中间件,可以很方便地解决跨域问题
2. 使用步骤
- 安装中间件: `npm install cors`
- 导入中间件: ` const cors = require('cors')`
- 配置中间件: 在路由之前调用` app.use(cors())`
3. 案例代码
```js
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// 导入中间件
const cors = require('cors')
// 配置中间件
app.use(cors())
// 配置解析表单数据的中间件
app.use(express.urlencoded({ extended: false }))
// 导入路由模块
const router = require('./020-apiRouter')
// 把路由模块,注册到 app 上
app.use('/api', router)
// 调用 app.listen 方法,指定端口号并启动 web 服务器
app.listen(3000, () => {
console.log('running……')
})
```
4. 配置 `cors ` 插件后
#### 7.3 什么是 CORS 以及注意事项
##### 7.3.1 什么是 CORS
1. `CORS` (跨域资源共享) 由一系列 `HTTP` 响应头组成,这些 `HTTP` 响应头决定浏览器 **是否阻止前端 JS 代码跨域获取资源**
2. 浏览器的**同源安全策略**默认会阻止网页“跨域”获取资源。但如果接口服务器**配置了 CORS 相关的 HTTP 响应头**,就可以**解除浏览器端的跨域访问限制**
##### 7.3.2 CORS 的注意事项
1. `CORS` 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了 `CORS` 的接口
2. `CORS` 在浏览器中有兼容性。只有支持 `XMLHttpRequest Level2` 的浏览器,才能正常访问开启了 `CORS` 的服务端接口(例如:`IE10+`、`Chrome4+`、`FireFox3.5+`)
#### 7.4 了解 Access-Control-Allow-Origin
1. 响应头部中可以携带一个 `Access-Control-Allow-Origin` 字段
2. `origin` 参数的值指定了允许访问该资源的外域 `URL`
3. 例如,下面的字段值将只允许来自 http://itcast.cn 的请求
4. 如果指定了 `Access-Control-Allow-Origin` 字段的值为通配符 *,表示允许来自任何域的请求
#### 7.5 了解 Access-Control-Allow-Headers
1. 默认情况下,CORS 仅支持客户端向服务器发送如下的 9 个请求头
- `Accept`
- `Accept-Language`
- `Content-Language`
- `DPR`
- `Downlink`
- `Save-Data`
- `Viewport-Width`
- `Width`
- `Content-Type` (值仅限于 `text/plain`、`multipart/form-data`、`application/x-www-form-urlencoded` 三者之一)
2. 如果客户端向服务器发送了额外的请求头信息,则需要在服务器端,通过 `Access-Control-Allow-Headers` 对额外的请求头进行声明,否则这次请求会失败!
#### 7.6 了解 Access-Control-Allow-Methods
1. 默认情况下,`CORS` 仅支持客户端发起 `GET`、`POST`、`HEAD` 请求
2. 如果客户端希望通过 `PUT`、`DELETE` 等方式请求服务器的资源,则需要在服务器端,通过 `Access-Control-Alow-Methods` 来指明实际请求所允许使用的 `HTTP` 方法
#### 7.7 CORS 请求的分类
##### 7.7.1 CORS请求的分类
1. 客户端在请求 CORS 接口时,根据请求方式和请求头的不同,可以将 CORS 的请求分为两大类,分别是:
- 简单请求
- 预检请求
##### 7.2.2 简单请求
1. 同时满足以下两大条件的请求,就属于简单请求
- **请求方式**:`GET`、`POST`、`HEAD` 三者之一
- HTTP 头部信息不超过以下几种字段:
- 无自定义头部字段
- `Accept`
- `Accept-Language`
- `Content-Language`
- `DPR`
- `Downlink`
- `Save-Data`
- `Viewport-Width`
- `Width `
- `Content-Type`(只有三个值 `application/x-www-form-urlencoded`、`multipart/form-data`、`text/plain`)
##### 7.3.3 预检请求
1. 只要符合以下任何一个条件的请求,都需要进行预检请求
- 请求方式为 `GET`、`POST`、`HEAD` 之外的请求 `Method` 类型
- 请求头中包含自定义头部字段
- 向服务器发送了 `application/json` 格式的数据
2. 在浏览器与服务器正式通信之前,浏览器会**先发送 OPTION 请求进行预检,以获知服务器是否允许该实际请求**,所以这一次的 OPTION 请求称为“预检请求”。**服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据**
#### 7.4 简单请求和预检请求的区别
1. 简单请求的特点:客户端与服务器之间**只会发生一次请求**
2. 预检请求的特点:客户端与服务器之间**会发生两次请求,OPTION 预检请求成功之后,才会发起真正的请求**
### 8. `jsonp`
#### 8.1 回顾 `JSONP` 的概念与特点
1. 概念:浏览器端通过 `