Node 第 4 天笔记
Node 第 4 天
1. 学习目标
◆ 能够熟练 express 路由的使用
◆ 掌握中间件的使用方式
◆ 能够说出中间件分为哪几类
◆ 了解如何自定义中间件
◆ 能够基于 exprss 写接口
◆ 能够说出解决跨域问题的方法 cors
◆ 掌握如何实现 JSONP 接口
2. Express 路由
2.1 路由的概念
路由就是映射关系
根据不同的用户 URL 请求,返回不同的内容
本质:URL 请求地址与服务器资源之间的对应关系
<img src="https://note-1259153703.cos.ap-nanjing.myqcloud.com/images/20211119195825.png" style="zoom:67%;" />
2.2 Express 中的路由
在
Express
中,路由指的是客户端的请求与服务器处理函数之间的映射关系Express 中的路由分 3 部分组成,分别是请求的类型、请求的 URL 地址、处理函数
Express 中的路由的例子
2.3 路由的匹配过程
每当一个请求到达服务器之后,需要先经过路由的匹配,只有匹配成功之后,才会调用对应的处理函数。
在匹配时,会按照路由的顺序进行匹配,如果请求类型和**请求的 URL **同时匹配成功,则
Express
会将这次请求,转交给对应的 function 函数进行处理。
- 路由匹配的注意点
- 按照定义的先后顺序进行匹配。
- 请求类型和请求的URL同时匹配成功,才会调用对应的处理函数。
2.4 Express 路由最简单的用法
在
Express
中使用路由最简单的方式,就是把路由挂载到app
上案例代码
const express = require('express') |
2.5 模块化路由
- 为了方便对路由进行模块化的管理,
Express
不建议将路由直接挂载到app
上,而是推荐将路由抽离为单独的模块,将路由抽离为单独模块的步骤如下
创建路由模块对应的
.js
文件调用
express.Router()
函数创建路由对象向路由对象上挂载具体的路由
使用
module.exports
向外共享路由对象使用
app.use()
函数注册路由模块
- 案例代码
// 1. 导入 express |
2.6 注册路由模块
导入路由模块
使用
app.use()
注册路由模块案例代码
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 为路由模块添加前缀
类似于托管静态资源写法,为静态资源统一挂载访问前缀一样
注意,添加了路由前缀后,访问的路由的时候,也应该加上前缀
案例代码
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 中间件的概念
- 什么是中间件
所谓的中间件(Middleware
),特指业务流程的中间处理环节
- 现实生活中的例子
在处理污水的时候,一般都要经过三个处理环节,从而保证处理过后的废水,达到排放标准
处理污水的这三个中间处理环节,就可以叫做中间件
3.2 Express 中间件的调用流程
当一个请求到达 Express 的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理
3.3 Express 中间件的格式
- Express 的中间件,本质上就是一个
function
处理函数,Express
中间件的格式如下
- 注意:中间件函数的形参列表中,必须包含 next 参数。而路由处理函数中只包含
req
和res
3.4 next 函数的作用
next 函数是实现多个中间件连续调用的关键,它表示把流转关系转交给下一个中间件或路由
3.5 定义中间件函数
定义一个最简单的中间件函数
const express = require('express')
const app = express()
// 定义一个最简单的中间件函数
const kw = (req,res,next) => {
console.log('这是最简单的中间件函数')
// 把流转关系,转交给下一个中间件或者路由
next()
}
app.listen(80, () => {
console.log('running……')
})
3.6 全局生效的中间件
客户端发起的任何请求,到达服务器之后,都会触发的中间件,叫做全局生效的中间件
通过调用
app.use(中间件函数)
,即可顶一个全局生效的中间件
const express = require('express') |
3.7 定义全局中间件的简化形式
- 定义全局中间件也可以将中间件函数直接挂载到
app.use()
上面
const express = require('express') |
3.8 中间件的作用
- 多个中间件之间,共享同一份
req
和res
,基于这样的特性,我们可以在上游 的中间件中,统一为req
或res
对象添加自定义的属性和方法,供下游的中间件或路由进行使用
- 案例代码
const express = require('express') |
3. 9 定义多个全局中间件
可以使用
app.use()
连续定义多个全局中间件,客户端请求到达服务器之后,会按照中间件定义的先后顺序依次执行案例代码
const express = require('express') |
3.10 局部生效的中间件
不使用
app.use()
定义的中间件,叫做局部生效的中间件案例代码
const express = require('express') |
3.11 定义多个局部中间件
可以在路由中,通过如下两种等价的方式,使用多个局部中间件
案例代码
const express = require('express') |
3.12 中间件的5个使用注意事项
- 一定要在路由之前注册中间件
- 客户端发送过来的请求,可以连续调用多个中间件进行处理
- 执行完中间件的业务代码之后,不要忘记调用
next()
函数 - 为了防止代码逻辑混乱,调用
next()
函数后不要再写额外的代码 - 连续调用多个中间件时,多个中间件之间,共享
req
和res
对象
4. 中间件的分类
4.1 中间件的分类
4.1.1 中间件的分类
- 为了方便大家理解和记忆中间件的使用,Express 官方把常见的中间件用法,分成了 5 大类,分别是
- 应用级别的中间件
- 路由级别的中间件
- 错误级别的中间件
- Express 内置的中间件
- 第三方的中间件
4.1.2 什么是应用级别的中间件
通过 app.use()
或 app.get()
或 app.post()
,绑定到 app
实例上的中间件,叫做应用级别的中间件
4.1.3 什么是路由级别的中间件
绑定到
express.Router()
实例上的中间件,叫做路由级别的中间件用法上和应用级别中间件没有任何区别,只不过,应用级别中间件是绑定到
app
实例上,路由级别中间件绑定到router
实例上
4.2 错误级别中间件
错误级别中间件的作用: 专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题
格式:错误级别中间件的 function 处理函数中,必须有 4 个形参,形参顺序从前到后,分别是
(err, req, res, next)
注意: 错误级别的中间件,必须注册在所有路由之后
案例代码:
const express = require('express') |
4.3 Express内置的中间件
自 Express 4.16.0
版本开始,Express
内置了 3 个常用的中间件,极大的提高了 Express
项目的开发效率和体验
express.static
快速托管静态资源的内置中间件,例如: HTML 文件、图片、CSS
样式等(无兼容性)express.json
解析JSON
格式的请求体数据(有兼容性,仅在4.16.0+
版本中可用)express.urlencoded
解析URL-encoded
格式的请求体数据(有兼容性,仅在4.16.0+
版本中可用)
4.4 express.json
中间件的使用
express.json()
中间件,解析表单中的JSON
格式的数据案例代码
const express = require('express') |
4.5 express.urlencoded
中间件的使用
express.urlencoded
解析URL-encoded
格式的请求体数据案例代码
const express = require('express') |
4.6 第三方的中间件
4.6.1 什么是第三方中间件
非
Express
官方内置,而是由第三方开发出来的中间件,叫做第三方中间件。在项目中,大家可以按需下载并配置第三方中间件,从而提高项目的开发效率例如:在
express@4.16.0
之前的版本中,经常使用body-parser
这个第三方中间件,来解析请求体数据。使用步骤如下- 运行
npm install body-parser
安装中间件 - 使用
require
导入中间件 - 调用
app.use()
注册并使用中间件
- 运行
注意:
Express
内置的express.urlencoded
中间件,就是基于body-parser
这个第三方中间件进一步封装出来的案例代码
const express = require('express') |
5. 自定义中间件
5.1 需求描述与实现步骤
5.1.1 需求以及实现步骤
- 需求描述: 自己手动模拟一个类似于
express.urlencoded
这样的中间件,来解析POST 提交到服务器的表单数据
- 实现步骤:
- 定义中间件
- 监听
req
的data
事件 - 监听
req
的end
事件 - 使用
querystring
模块解析请求体数据 - 将解析出来的数据对象挂载为
req.body
- 将自定义中间件封装为模块
5.1.2 定义中间件
使用
app.use()
来定义全局生效的中间件代码如下:
- 案例代码
// 导入 express 模块 |
5.2 监听 req
的 data
事件
在中间件中,需要监听
req
对象的data
事件,来获取客户端发送到服务器的数据如果数据量比较大,无法一次性发送完毕,则客户端会把数据切割后,分批发送到服务器。所以
data
事件可能会触发多次,每一次触发data
事件时,获取到数据只是完整数据的一部分,需要手动对接收到的数据进行拼接代码如下:
案例代码
// 导入 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
事件
当请求体数据接收完毕之后,会自动触发
req
的end
事件我们可以在
req
的end
事件中,拿到并处理完整的请求体数据代码如下
- 案例代码
// 导入 express 模块 |
5.4 用 querystring
模块解析请求体数据
Node.js
内置了一个querystring
模块,专门用来处理查询字符串。通过这个模块提供的parse()
函数,可以轻松把查询字符串,解析成对象的格式代码如下
- 案例代码
// 导入 express 模块 |
5.5 将解析出来的数据对象挂载为 req.body
**上游的中间件和下游的中间件及路由之间,共享同一份
req
和res
**,因此,我们可以将解析出来的数据,挂载为req
的自定义属性,命名为req.body
,供下游使用代码如下
- 案例代码
// 导入 express 模块 |
5.6 将自定义中间件封装为模块
为了优化代码的结构,我们可以把自定义的中间件函数,封装为独立的模块
代码如下:
- 案例代码
// custom-body-parser.js |
// 对自定义的中间件进行模块化拆分 |
6. 基于 Express 写接口
6.1 创建基本的服务器
// 导入 express 模块 |
6.2 创建 API 路由模块
// router.js |
// index.js |
6.3 编写 get 请求
const express = require('express') |
6.4 编写 post 请求
注意:如果要获取 URL-encoded 格式的请求体数据,必须配置中间件 app.use(express.urlencoded({ extended: false }))
const express = require('express') |
// index.js |
7. cors
7.1 接口的跨域问题
到目前为止,我们编写的
GET
和POST
接口,存在一个很严重的问题:不支持跨域请求。解决接口跨域问题的方案主要有两种
- CORS (主流的解决方案,推荐使用)
- JSONP (有缺陷的解决方案:只支持 GET 请求)
- 代码演示
|
- 报错提示
7.2 使用 cors 中间件解决跨域问题
cors 是 Express 的一个第三方中间件。通过安装和配置 cors 中间件,可以很方便地解决跨域问题
使用步骤
- 安装中间件:
npm install cors
- 导入中间件:
const cors = require('cors')
- 配置中间件: 在路由之前调用
app.use(cors())
- 安装中间件:
案例代码
// 导入 express 模块 |
- 配置
cors
插件后
7.3 什么是 CORS 以及注意事项
7.3.1 什么是 CORS
CORS
(跨域资源共享) 由一系列HTTP
响应头组成,这些HTTP
响应头决定浏览器 是否阻止前端 JS 代码跨域获取资源浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了 CORS 相关的 HTTP 响应头,就可以解除浏览器端的跨域访问限制
7.3.2 CORS 的注意事项
-
CORS
主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了CORS
的接口。 -
CORS
在浏览器中有兼容性。只有支持XMLHttpRequest Level2
的浏览器,才能正常访问开启了CORS
的服务端接口(例如:IE10+
、Chrome4+
、FireFox3.5+
)。
7.4 了解 Access-Control-Allow-Origin
- 响应头部中可以携带一个
Access-Control-Allow-Origin
字段
origin
参数的值指定了允许访问该资源的外域URL
例如,下面的字段值将只允许来自 http://itcast.cn 的请求
如果指定了
Access-Control-Allow-Origin
字段的值为通配符 *,表示允许来自任何域的请求
7.5 了解 Access-Control-Allow-Headers
默认情况下,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
三者之一)
如果客户端向服务器发送了额外的请求头信息,则需要在服务器端,通过
Access-Control-Allow-Headers
对额外的请求头进行声明,否则这次请求会失败!
7.6 了解 Access-Control-Allow-Methods
默认情况下,
CORS
仅支持客户端发起GET
、POST
、HEAD
请求如果客户端希望通过
PUT
、DELETE
等方式请求服务器的资源,则需要在服务器端,通过Access-Control-Alow-Methods
来指明实际请求所允许使用的HTTP
方法
7.7 CORS 请求的分类
7.7.1 CORS请求的分类
- 客户端在请求 CORS 接口时,根据请求方式和请求头的不同,可以将 CORS 的请求分为两大类,分别是:
- 简单请求
- 预检请求
7.2.2 简单请求
- 同时满足以下两大条件的请求,就属于简单请求
- 请求方式:
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 预检请求
- 只要符合以下任何一个条件的请求,都需要进行预检请求
- 请求方式为
GET
、POST
、HEAD
之外的请求Method
类型 - 请求头中包含自定义头部字段
- 向服务器发送了
application/json
格式的数据
- 在浏览器与服务器正式通信之前,浏览器会先发送 OPTION 请求进行预检,以获知服务器是否允许该实际请求,所以这一次的 OPTION 请求称为“预检请求”。服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据
7.4 简单请求和预检请求的区别
- 简单请求的特点:客户端与服务器之间只会发生一次请求
- 预检请求的特点:客户端与服务器之间会发生两次请求,OPTION 预检请求成功之后,才会发起真正的请求
8. jsonp
8.1 回顾 JSONP
的概念与特点
- 概念:浏览器端通过
<script>
标签的src
属性,请求服务器上的数据,同时,服务器返回一个函数的调用。这种请求数据的方式叫做JSONP
- 特点
-
JSONP
不属于真正的Ajax
请求,因为它没有使用XMLHttpRequest
这个对象 -
JSONP
仅支持GET
请求,不支持POST
、PUT
、DELETE
等请求
8.2 创建 JSONP
接口的注意事项
如果项目中已经配置了
CORS
跨域资源共享,为了防止冲突,必须在配置CORS
中间件之前声明JSONP
的接口否则
JSONP
接口会被处理成开启了CORS
的接口案例代码
// 导入 express 模块 |
8.3 实现 JSONP
接口的步骤
8.3.1 实现步骤分析
- 获取客户端发送过来的回调函数的名字
- 得到要通过
JSONP
形式发送给客户端的数据 - 根据前两步得到的数据,拼接出一个函数调用的字符串
- 把上一步拼接得到的字符串,响应给客户端的
<script>
标签进行解析执行
8.3.2 案例代码
- 实现步骤
- 案例代码
// 导入 express 模块 |
8.4 在网页中使用 jQuery 发起 JSONP 请求
- 调用 $.ajax() 函数,提供 JSONP 的配置选项,从而发起 JSONP 请求
|